Last modified: February 18th, 2020

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:[email protected]"
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.

Cache-Tag purging has a lower rate limit of up to 2,000 purge API calls in every 24 hour period. You may purge up to 30 tags in one API call.

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:[email protected]"
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: [email protected]" \
    -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
  • free
  • pro
  • business
  • enterprise

GET user
cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/user" \
     -H "X-Auth-Email: [email protected]" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
Response (example)
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7c5dae5552338874e5053f2534d2767a",
    "email": "[email protected]",
    "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
  • 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: [email protected]" \
     -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": "[email protected]",
    "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'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: [email protected]" \
     -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
        },
        "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: [email protected]" \
     -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
      },
      "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: [email protected]" \
     -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
      },
      "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: [email protected]" \
     -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: [email protected]" \
     -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
      },
      "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: [email protected]" \
     -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
    },
    "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 }
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: [email protected]" \
         -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
         -H "Content-Type: application/json" \
         --data '{"id":"01a7362d577a6c3019a474fd6f485823","name":"Demo Account","settings":{"enforce_twofactor":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
        },
        "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: [email protected]" \
         -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": "[email protected]",
            "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

    • 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: [email protected]" \
           -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
           -H "Content-Type: application/json" \
           --data '{"email":"[email protected]","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": "[email protected]",
            "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: [email protected]" \
           -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": "[email protected]",
            "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": "[email protected]", "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: [email protected]" \
             -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":"[email protected]","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": "[email protected]",
              "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: [email protected]" \
             -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: [email protected]" \
             -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: [email protected]" \
             -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: [email protected]" \
             -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: [email protected]" \
                     -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: [email protected]" \
                             -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: [email protected]" \
                             -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: [email protected]" \
                             -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": "[email protected]",
                                "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": "[email protected]",
                                "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": "[email protected]",
                                "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: [email protected]" \
                             -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": "[email protected]",
                                "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": "[email protected]",
                                "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": "[email protected]",
                                "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: [email protected]" \
                             -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": "[email protected]",
                              "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": "[email protected]",
                              "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

                        • 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: [email protected]" \
                               -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                               -H "Content-Type: application/json" \
                               --data '{"invited_member_email":"[email protected]","roles":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"auto_accept":true}'
                          Response (example)
                          {
                            "success": true,
                            "errors": [],
                            "messages": [],
                            "result": {
                              "id": "4f5f0c14a2a41d5063dd301b2f829f04",
                              "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
                              "invited_member_email": "[email protected]",
                              "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": "[email protected]",
                              "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: [email protected]" \
                               -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": "[email protected]",
                              "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": "[email protected]",
                              "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: [email protected]" \
                                 -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": "[email protected]",
                                "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": "[email protected]",
                                "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: [email protected]" \
                                 -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: [email protected]" \
                                 -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                 -H "Content-Type: application/json"
                            Response (example)
                            {
                              "success": true,
                              "errors": [],
                              "messages": [],
                              "result": [
                                {
                                  "id": "7c5dae5552338874e5053f2534d2767a",
                                  "name": "John Smith",
                                  "email": "[email protected]",
                                  "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: [email protected]" \
                                 -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                 -H "Content-Type: application/json"
                            Response (example)
                            {
                              "success": true,
                              "errors": [],
                              "messages": [],
                              "result": {
                                "id": "7c5dae5552338874e5053f2534d2767a",
                                "name": "John Smith",
                                "email": "[email protected]",
                                "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: [email protected]" \
                                   -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": "[email protected]",
                                  "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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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": "[email protected]",
                                    "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": "[email protected]",
                                    "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: [email protected]" \
                                   -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": "[email protected]",
                                  "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": "[email protected]",
                                  "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: [email protected]" \
                                   -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": "[email protected]",
                                  "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": "[email protected]",
                                  "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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                   -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                           -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: [email protected]" \
                                                   -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: [email protected]" \
                                                           -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

                                                          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&[email protected]&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: [email protected]" \
                                                                         -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": "[email protected]",
                                                                            "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

                                                                        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&[email protected]&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: [email protected]" \
                                                                                       -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": "[email protected]",
                                                                                          "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

                                                                                      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&[email protected]&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: [email protected]" \
                                                                                                     -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": "[email protected]",
                                                                                                        "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: [email protected]" \
                                                                                                     -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: [email protected]" \
                                                                                                     -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: [email protected]" \
                                                                                                     -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: [email protected]" \
                                                                                                     -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: [email protected]" \
                                                                                                     -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: [email protected]" \
                                                                                                       -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: [email protected]" \
                                                                                                       -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:
                                                                                                      cURL (example)
                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
                                                                                                           -H "X-Auth-Email: [email protected]" \
                                                                                                           -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"}}'
                                                                                                      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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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.

                                                                                                      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.

                                                                                                      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": "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: [email protected]" \
                                                                                                           -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":"cloudflare.com","CF-IPCountry":"US","CF-Device-Type":"desktop"}}]}'
                                                                                                      Response (example)
                                                                                                      {
                                                                                                        "success": true,
                                                                                                        "errors": [],
                                                                                                        "messages": [],
                                                                                                        "result": {
                                                                                                          "id": "9a7806061c88ada191ed06f989cc3dac"
                                                                                                        }
                                                                                                      }
                                                                                                      zone-purge-files-by-cache-tags-or-host

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

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

                                                                                                      NB: Cache-Tag and host purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags or hosts 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
                                                                                                      cURL (example)
                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
                                                                                                           -H "X-Auth-Email: [email protected]" \
                                                                                                           -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                           -H "Content-Type: application/json" \
                                                                                                           --data '{"tags":["some-tag","another-tag"],"hosts":["www.example.com","images.example.com"]}'
                                                                                                      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', or 'hosts'
                                                                                                      1013'purge_everything' must be true
                                                                                                      1014'files', 'tags', or 'hosts' 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', or 'hosts'
                                                                                                      1094Exceeded maximum amount of 500 files that can be purged on a single request
                                                                                                      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 zone is banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support
                                                                                                      1098This zone is temporarily banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support
                                                                                                      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 zone is temporarily banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support
                                                                                                      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

                                                                                                      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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                           -H "Content-Type: application/json"
                                                                                                      Response (example)
                                                                                                      {
                                                                                                        "success": true,
                                                                                                        "errors": [],
                                                                                                        "messages": [],
                                                                                                        "result": "off"
                                                                                                      }
                                                                                                      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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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-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: [email protected]" \
                                                                                                           -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

                                                                                                      A whitelist 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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                           -H "Content-Type: application/json"
                                                                                                      Response (example)
                                                                                                      {
                                                                                                        "success": true,
                                                                                                        "errors": [],
                                                                                                        "messages": [],
                                                                                                        "result": "off"
                                                                                                      }
                                                                                                      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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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-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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                           -H "Content-Type: application/json" \
                                                                                                           --data '{"value":"off"}'
                                                                                                      Response (example)
                                                                                                      {
                                                                                                        "success": true,
                                                                                                        "errors": [],
                                                                                                        "messages": [],
                                                                                                        "result": "off"
                                                                                                      }
                                                                                                      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: [email protected]" \
                                                                                                           -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, 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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                           -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: [email protected]" \
                                                                                                             -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                               -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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-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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                                 -H "Content-Type: application/json" \
                                                                                                                 --data '{"value":"off"}'
                                                                                                            Response (example)
                                                                                                            {
                                                                                                              "success": true,
                                                                                                              "errors": [],
                                                                                                              "messages": [],
                                                                                                              "result": "off"
                                                                                                            }
                                                                                                            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: [email protected]" \
                                                                                                                 -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

                                                                                                            A whitelist 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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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 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: May 31, 2020

                                                                                                            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: [email protected]" \
                                                                                                                 -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: May 31, 2020

                                                                                                            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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                 -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: [email protected]" \
                                                                                                                       -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: [email protected]" \
                                                                                                                         -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: [email protected]" \
                                                                                                                         -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: [email protected]" \
                                                                                                                         -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
                                                                                                                        }
                                                                                                                      ]
                                                                                                                    }
                                                                                                                    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: [email protected]" \
                                                                                                                         -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
                                                                                                                        }
                                                                                                                      ]
                                                                                                                    }
                                                                                                                    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: [email protected]" \
                                                                                                                         -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: [email protected]" \
                                                                                                                         -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: [email protected]" \
                                                                                                                         -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 for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api 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: [email protected]" \
                                                                                                                         -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
                                                                                                                    ownership_challenge
                                                                                                                    string

                                                                                                                    Ownership challenge token to prove destination ownership.

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

                                                                                                                    Optional parameters

                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                    name
                                                                                                                    stringnull

                                                                                                                    Optional human readable job name. Not unique. Makes it easier for humans to identify a job. Suggest that it include the zone name.

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

                                                                                                                    Dataset to be pulled.

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

                                                                                                                    Configuration string for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api 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/jobs" \
                                                                                                                         -H "X-Auth-Email: [email protected]" \
                                                                                                                         -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"}'
                                                                                                                    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
                                                                                                                      }
                                                                                                                    }
                                                                                                                    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: [email protected]" \
                                                                                                                         -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
                                                                                                                      }
                                                                                                                    }
                                                                                                                    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 for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api 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/\+\.\-_]*$
                                                                                                                    cURL (example)
                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
                                                                                                                         -H "X-Auth-Email: [email protected]" \
                                                                                                                         -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"}'
                                                                                                                    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
                                                                                                                      }
                                                                                                                    }
                                                                                                                    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: [email protected]" \
                                                                                                                         -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: [email protected]" \
                                                                                                                         -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

                                                                                                                    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
                                                                                                                    type
                                                                                                                    string

                                                                                                                    DNS record type

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

                                                                                                                    DNS record name

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

                                                                                                                    DNS record content

                                                                                                                    "127.0.0.1"
                                                                                                                      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
                                                                                                                      order
                                                                                                                      string

                                                                                                                      Field to order records by

                                                                                                                      "type"
                                                                                                                      • valid values: type, name, content, ttl, proxied
                                                                                                                      direction
                                                                                                                      string

                                                                                                                      Direction to order domains

                                                                                                                      "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/dns_records?type=A&name=example.com&content=127.0.0.1&page=1&per_page=20&order=type&direction=desc&match=all" \
                                                                                                                           -H "X-Auth-Email: [email protected]" \
                                                                                                                           -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": 120,
                                                                                                                            "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, TXT, SRV, LOC, MX, NS, SPF, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, 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 for DNS record. Value of 1 is 'automatic'

                                                                                                                        120
                                                                                                                        Any of the following:

                                                                                                                          Optional parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          priority
                                                                                                                          number

                                                                                                                          Used with some records like MX and SRV to determine priority. If you do not supply a priority for an MX record, a default value of 0 will be set

                                                                                                                          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: [email protected]" \
                                                                                                                               -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
                                                                                                                               -H "Content-Type: application/json" \
                                                                                                                               --data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":120,"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": 120,
                                                                                                                              "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: [email protected]" \
                                                                                                                               -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": 120,
                                                                                                                              "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, TXT, SRV, LOC, MX, NS, SPF, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, 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 for DNS record. Value of 1 is 'automatic'

                                                                                                                            120
                                                                                                                            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: [email protected]" \
                                                                                                                                   -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"