The Wayback Machine - https://web.archive.org/web/20220120230816/https://api.cloudflare.com/
Last modified: January 18th, 2022
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.
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.
Cloudflare offers public APIs with three audiences in mind.
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.
Anything that's useful and follows the guidelines presented here.
Do not do any of the following:
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.
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/
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 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.
| Name | Format | Description |
|---|---|---|
| API Token | Authorization: Bearer <token> | API Token generated from the User Profile 'API Tokens' page |
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
-H "Content-Type:application/json" \
-H "Authorization: Bearer YQSn-xWAQiiEh9qM58wZNnyQS7FUdoqGIUAbrh7T"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.
| Name | Format | Description |
|---|---|---|
| API Key | X-Auth-Key | API key generated on the "My Account" page |
| X-Auth-Email | Email address associated with your account | |
| User Service Key | X-Auth-User-Service-Key | A special Cloudflare API key good for a restricted set of endpoints. Always begins with "v1.0-", may vary in length. |
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
-H "Content-Type:application/json" \
-H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
-H "X-Auth-Email:example@example.com"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"`| Name | Type | Description |
|---|---|---|
| page | integer | Which page of results to return |
| per_page | integer | How many results to return per page |
| order | string | Attribute name to order the responses by |
| direction | string | Either asc or desc |
GET zones/:zone_identifier/dns_records
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/dns_records?page=3&per_page=20&order=type&direction=asc" \
-H "Content-Type:application/json" \
-H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
-H "X-Auth-Email:example@example.com"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.
{
"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
}
}{
"result": null,
"success": false,
"errors": [{"code":1003,"message":"Invalid or missing zone id."}],
"messages": []
}| Content-Type | Description |
|---|---|
| application/json | response is a JSON object |
| text/plain | response is a textual item |
| application/x-yaml | response is a YAML object |
| application/octet-stream | response is a raw data (reserved for later use) |
| Code | Status | Description |
|---|---|---|
| 200 | OK | request successful |
| 304 | Not Modified | |
| 400 | Bad Request | request was invalid |
| 401 | Unauthorized | user does not have permission |
| 403 | Forbidden | request not authenticated |
| 429 | Too many requests | client is rate limited |
| 405 | Method Not Allowed | incorrect HTTP method provided |
| 415 | Unsupported Media Type | response is not valid JSON |
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.
curl -X GET "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"curl -X GET "https://api.cloudflare.com/client/v4/user" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"first_name": "John",
"last_name": "Appleseed",
"username": "cfuser12345",
"telephone": "+1 123-123-1234",
"country": "US",
"zipcode": "12345",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"two_factor_authentication_enabled": false,
"suspended": false
}
}| Name /type | Description /example | Constraints |
| first_name stringnull | User's first name
|
|
| last_name stringnull | User's last name
|
|
| telephone stringnull | User's telephone number
|
|
| country stringnull | The country in which the user lives.
|
|
| zipcode stringnull | The zipcode or postal code where the user lives.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"first_name":"John","last_name":"Appleseed","telephone":"+1 123-123-1234","country":"US","zipcode":"12345"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"first_name": "John",
"last_name": "Appleseed",
"username": "cfuser12345",
"telephone": "+1 123-123-1234",
"country": "US",
"zipcode": "12345",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"two_factor_authentication_enabled": false,
"suspended": false
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/tokens?page=1&per_page=20&direction=desc" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
]
}| Name /type | Description /example | Constraints |
| name string | Token name
|
|
| policies array | List of access policies assigned to the token
|
| Name /type | Description /example | Constraints |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing
| |
| expires_on string (date-time) | The expiration time on or after which the JWT MUST NOT be accepted for processing
| |
| condition object | Defines the extra limitation on how and/or where the token can be used
|
curl -X POST "https://api.cloudflare.com/client/v4/user/tokens" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{"name":"readonly token","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
},
"value": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
}| Name /type | Description /example | Constraints |
| expires_on string (date-time) | The expiration time on or after which the JWT MUST NOT be accepted for processing
| |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing
| |
| name string | Token name
|
|
| policies array | List of access policies assigned to the token
| |
| status string | Status of the token
|
|
| issued_on string (date-time) | The time on which the token was created
|
|
| modified_on string (date-time) | Last time the token was modified
|
|
| id string | Token identifier tag
|
|
| condition object | Defines the extra limitation on how and/or where the token can be used
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{"id":"ed17574386854bf78a67040be0a770b0","name":"readonly token","status":"active","issued_on":"2018-07-01T05:20:00Z","modified_on":"2018-07-02T05:20:00Z","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0/value" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{}'{
"success": true,
"errors": [],
"messages": [],
"result": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"status": "active",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/permission_groups" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "7cf72faf220841aabcfdfab81c43c4f6",
"name": "Billing Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "9d24387c6e8544e2bc4024a03991339f",
"name": "Load Balancing: Monitors and Pools Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "d2a1802cc9a34e30852f8b33869b2f3c",
"name": "Load Balancing: Monitors and Pools Write",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "8b47d2786a534c08a1f94ee8f9f599ef",
"name": "Workers KV Storage Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "f7f0eda5697f475c90846e879bab8666",
"name": "Workers KV Storage Write",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "1a71c399035b4950a1bd1466bbe4f420",
"name": "Workers Scripts Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "e086da7e2179491d91ee5f35b3ca210a",
"name": "Workers Scripts Write",
"scopes": [
"com.cloudflare.api.account"
]
}
]
}| Name /type | Description /example | Constraints |
| status string | Status of this membership
|
|
| account.name string | Account name
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of memberships per page
|
|
| order string | Field to order memberships by
|
|
| direction string | Direction to order memberships
|
|
curl -X GET "https://api.cloudflare.com/client/v4/memberships?status=accepted&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
}| Name /type | Description /example | Constraints |
| status string | Whether to accept or reject this account invitation
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"status":"accepted"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa"
}
}| Code | Description |
| 1000 | An unknown error(<CODE>) has occurred |
| 1001 | Invalid request |
| 1002 | Forbidden |
| 1003 | Membership not found |
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
| name string | Name of the account
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts?page=1&per_page=20&direction=desc&name=example.com" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
}| Name /type | Description /example | Constraints |
| id string | Account identifier tag
|
|
| name string | Account name
|
|
| settings object | Account settings
| |
| created_on string (date-time) | describes when account was created
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"01a7362d577a6c3019a474fd6f485823","name":"Demo Account","settings":{"enforce_twofactor":false,"use_account_custom_ns_by_default":false},"created_on":"2014-03-01T12:21:02.0000Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
}| Code | Description |
| 1000 | An unknown error(<CODE>) has occurred |
| 1001 | Invalid request |
| 1002 | Forbidden |
| 1003 | Account not found |
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
]
}| Name /type | Description /example | Constraints |
| email string | Your contact email address
|
|
| roles array | Array of roles associated with this member
|
| Name /type | Description /example | Constraints |
| status string | A member's status in the account
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"email":"user@example.com","status":"accepted","roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}| Name /type | Description /example | Constraints |
| id string | Membership identifier tag
|
|
| code string | The unique activation code for the account membership
|
|
| user object |
|
|
| status string | A member's status in the account
|
|
| roles array | Roles assigned to this member
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"4536bcfad5faccb111b47003c79917fa","code":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","user":{"id":"7c5dae5552338874e5053f2534d2767a","first_name":"John","last_name":"Appleseed","email":"user@example.com","two_factor_authentication_enabled":false},"status":"accepted","roles":[{"id":"3536bcfad5faccb999b47003c79917fb","name":"Account Administrator","description":"Administrative access to the entire Account","permissions":{"analytics":{"read":true,"write":true},"billing":{"read":true,"write":true},"cache_purge":{"read":true,"write":true},"dns":{"read":true,"write":true},"dns_records":{"read":true,"write":true},"lb":{"read":true,"write":true},"logs":{"read":true,"write":true},"organization":{"read":true,"write":true},"ssl":{"read":true,"write":true},"waf":{"read":true,"write":true},"zones":{"read":true,"write":true},"zone_settings":{"read":true,"write":true}}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
]
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"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"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"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"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"members": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
],
"invites": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
],
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}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.
| Name /type | Description /example | Constraints |
| name string | Organization Name
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Cloudflare, Inc."}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"members": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
],
"invites": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
],
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
]
}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.
| Name /type | Description /example | Constraints |
| invited_member_email string | Email address of the user to be added to the Organization
|
|
| roles array | Array of Roles associated with the invited user
|
| Name /type | Description /example | Constraints |
| 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.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"invited_member_email":"user@example.com","roles":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"auto_accept":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}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.
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with the invited user
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}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.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "4f5f0c14a2a41d5063dd301b2f829f04"
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
]
}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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}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.
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with this Member
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}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.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "7c5dae5552338874e5053f2534d2767a"
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}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.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
}| Name /type | Description /example | Constraints |
| status | Status of your response to the invitation (rejected or accepted)
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"status":"accepted"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
| Name /type | Description /example | Constraints |
| status string | Whether or not the user is a member of the organization or has an inivitation pending
|
|
| name string | Organization Name
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of organizations per page
|
|
| order string | Field to order organizations by
|
|
| direction string | Direction to order organizations
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/organizations?status=member&name=Cloudflare, Inc.&page=1&per_page=20&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"status": "member",
"permissions": [
"#zones:read"
],
"roles": [
"All Privileges - Super Administrator"
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"status": "member",
"permissions": [
"#zones:read"
],
"roles": [
"All Privileges - Super Administrator"
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "01a7362d577a6c3019a474fd6f485823"
}curl -X GET "https://api.cloudflare.com/client/v4/user/billing/profile" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| order string | Field to order billing history by
|
|
| type string | The billing item type
|
|
| occured_at string (date-time) | When the billing item was created
|
|
| action string | The billing item action
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/billing/history?page=1&per_page=20&order=occured_at&type=charge&occured_at=2014-03-01T12:21:59.3456Z&action=subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
]
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"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"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/billing/profile" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_rate_plans" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"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"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"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"
}
}| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| 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.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/user/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| 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.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}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.
| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| 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.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "smart_routing",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}| Name /type | Description /example | Constraints |
| value string | Enablement of Argo smart routing
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "smart_routing",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}| Name /type | Description /example | Constraints |
| bins integer | Number of buckets latency is split into
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency?bins=3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency/colos" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
]
}
}
]
}
}| Name /type | Description /example | Constraints |
| match string | Whether to match all search requirements or at least one (any)
|
|
| name string (hostname) | A domain name
|
|
| account.name string | Account name
|
|
| order string | Field to order zones by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of zones per page
|
|
| status string | Status of the zone
|
|
| account.id string | Account identifier tag
|
|
| direction string | Direction to order zones
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones?name=example.com&status=active&account.id=01a7362d577a6c3019a474fd6f485823&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
]
}
]
}| Name /type | Description /example | Constraints |
| name string | The domain name
|
|
| account object | Account of which the zone is created in
|
| Name /type | Description /example | Constraints |
| jump_start boolean | Automatically attempt to fetch existing DNS records
|
|
| 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.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"example.com","account":{"id":"01a7362d577a6c3019a474fd6f485823"},"jump_start":true,"type":"full"}'{
"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"
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
]
}
}| Name /type | Description /example | Constraints |
| 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.
|
|
| vanity_name_servers array | An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
| |
| 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
| |
| type string | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"paused":false,"vanity_name_servers":["ns1.example.com","ns2.example.com"],"plan":{"id":"e592fd9519420ba7405e1307bff33214"},"type":"full"}'{
"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"
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/activation_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| 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.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"purge_everything":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| files array | An array of URLs that should be removed from cache
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"files":["http://www.example.com/css/styles.css",{"url":"http://www.example.com/cat_picture.jpg","headers":{"Origin":"https://www.cloudflare.com","CF-IPCountry":"US","CF-Device-Type":"desktop"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| tags array | Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache
|
|
| hosts array | Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache
|
|
| prefixes array | Any assets at URLs that match the prefix will be purged from the Cloudflare cache. For instance, a.com/b will purge a.com/b/c/d.png but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"tags":["some-tag","another-tag"],"hosts":["www.example.com","images.example.com"],"prefixes":["www.example.com/foo","images.example.com/bar/baz"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Code | Description |
| 1000 | Invalid or missing user |
| 1001 | Invalid zone identifier |
| 1002 | Invalid domain |
| 1003 | 'jump_start' must be boolean |
| 1006 | Invalid or missing zone |
| 1008 | Invalid or missing Zone id |
| 1010 | Bulk deal limit reached |
| 1012 | Request must contain one of 'purge_everything', 'files', 'tags', 'hosts' or 'prefixes' |
| 1013 | 'purge_everything' must be true |
| 1014 | 'files', 'tags', 'hosts' or 'prefixes' must be an array |
| 1015 | Unable to purge <url> |
| 1016 | Unable to purge any urls |
| 1017 | Unable to purge all |
| 1018 | Invalid zone status |
| 1019 | Zone is already paused |
| 1020 | Invalid or missing zone |
| 1021 | Invalid zone status |
| 1022 | Zone is already unpaused |
| 1023 | Invalid or missing zone |
| 1049 | <domain> is not a registered domain |
| 1050 | <domain> is currently being tasted. It is not currently a registered domain |
| 1051 | Cloudflare is already hosting <domain> |
| 1052 | An error has occurred and it has been logged. We will fix this problem promptly. We apologize for the inconvenience |
| 1055 | Failed to disable <domain> |
| 1056 | preserve_ini must be a boolean |
| 1057 | Zone must be in 'initializing' status |
| 1059 | Unable to delete zone |
| 1061 | <domain> already exists |
| 1064 | Not allowed to update zone step. Bad zone status |
| 1065 | Not allowed to update zone step. Zone has already been set up |
| 1066 | Could not promote zone to step 3 |
| 1067 | Invalid organization identifier passed in your organization variable |
| 1068 | Permission denied |
| 1069 | organization variable should be an organization object |
| 1070 | This operation requires a Business or Enterprise account. |
| 1071 | Vanity name server array expected. |
| 1073 | A name server provided is in the wrong format. |
| 1074 | Could not find a valid zone. |
| 1075 | Vanity name server array count is invalid |
| 1076 | Name servers have invalid IP addresses |
| 1077 | Could not find a valid zone. |
| 1078 | This zone has no valid vanity IPs. |
| 1079 | This zone has no valid vanity name servers. |
| 1080 | There is a conflict with one of the name servers. |
| 1081 | There are no valid vanity name servers to disable. |
| 1082 | Unable to purge '<url>'. You can only purge files for this zone |
| 1083 | Unable to purge '<url>'. Rate limit reached. Please wait if you need to perform more operations |
| 1084 | Unable to purge '<url>'. |
| 1085 | Only one property can be updated at a time |
| 1086 | Invalid property |
| 1088 | Invalid/Missing Zone plan ID |
| 1089 | Invalid/Missing Zone plan ID |
| 1092 | Request cannot contain 'purge_everything' and any of 'files', 'tags', 'hosts' or 'prefixes' |
| 1094 | Exceeded maximum amount of files that can be purged on a single request for your plan type. |
| 1095 | Sorry, you do not have access to purge cache for that zone id or that zone id is invalid |
| 1096 | This action is not available as your zone has been deactivated for a possible Terms of Service violation |
| 1097 | This web property cannot be added to Cloudflare at this time. If you are an Enterprise customer, please contact your Customer Success Manager. Otherwise, please email abusereply@cloudflare.com with the name of the web property and a detailed explanation of your association with this web property. |
| 1098 | This web property is temporarily restricted from being added to Cloudflare at this time. Please try again later, or contact Cloudflare Support with any questions. |
| 1099 | We 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) |
| 1100 | Tag exceeds maximum length of 1024 characters |
| 1101 | Exceeded maximum amount of 30 tags that can be purged on a single request |
| 1102 | Unable to purge by tag, rate limit reached. Please wait if you need to perform more |
| 1104 | Partial zone signup not allowed |
| 1105 | This web property is temporarily restricted from being added to Cloudflare at this time. Please try again later, or contact Cloudflare Support with any questions. |
| 1106 | Sorry, you are not allowed to create new zones. Please contact support. |
| 1107 | Only enterprise zones can purge by tag. |
| 1108 | Unable to update domain subscription. Please contact support for assistance. |
| 1109 | Unable to update domain subscription. Please contact support for assistance. |
| 1110 | Failed to lookup registrar and hosting information of <domain> at this time. Please contact Cloudflare Support or try again later. |
| 1111 | Exceeded maximum amount of 30 hosts that can be purged on a single request |
| 1112 | Only enterprise zones can purge by host |
| 1113 | Unable to purge by host, rate limit reached. Please wait if you need to perform more operations. |
| 1114 | Host exceeds maximum length of 200 characters |
| 1115 | Invalid host |
| 1116 | No prefixes were provided in the request. Must provide at least 1 prefixes. |
| 1117 | Exceeded maximum amount of 30 prefixes that can be purged on a single request. |
| 1118 | Empty prefix provided. Prefixes must not be empty. |
| 1119 | URI scheme provided in prefix '<prefix>'. URI schemes must not be provided. |
| 1120 | URI host was not provided in prefix '<prefix>'. Host must be provided in each prefix. |
| 1121 | URI host in prefix '<prefix>' exceeds maximum length of 200 characters. |
| 1122 | URI host in prefix '<prefix>' has a segment exceeding maximum length of 63 characters. |
| 1123 | URI Query string was provided in prefix '<prefix>'. Query strings must not be provided. |
| 1124 | URI fragment was provided in prefix '<prefix>'. Fragments must not be provided. |
| 1125 | URI host in prefix '<prefix>' is not a domain. Host must be a valid domain or IPV4 address. |
| 1126 | URI host in prefix '<prefix>' contains an invalid top level domain. |
| 1127 | Invalid prefix '<prefix>'. Invalid Url. |
| 1128 | Prefix '<prefix>' overlaps with another prefix. Prefixes must not be redundant. |
| 1129 | Could not purge prefix '<prefix>'. Internal error. |
| 1130 | Only enterprise zones can purge by prefix. |
| 1131 | Unable to purge by prefix, rate limit reached. Please wait if you need to perform more operations |
| 1132 | Unable to purge '<url>'. Resized images cannot be purged. Purge the original image instead. |
| 1133 | Path too deep in '<prefix>', maximum path depth is 31. |
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/advanced_ddos" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "advanced_ddos",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "always_online",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/orange_to_orange" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "orange_to_orange",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_cache_ttl",
"value": 14400,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_check",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "cache_level",
"value": "aggressive",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "challenge_ttl",
"value": 1800,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "development_mode",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z",
"time_remaining": 3600
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/early_hints" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "early_hints",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "email_obfuscation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "hotlink_protection",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ip_geolocation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ipv6",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "minify",
"value": {
"css": "off",
"html": "off",
"js": "off"
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mirage",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "opportunistic_encryption",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "polish",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "webp",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "brotli",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "privacy_pass",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "rocket_loader",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_level",
"value": "medium",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "server_side_exclude",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl_recommender" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl_recommender",
"enabled": false,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "1.0"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": []
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tls_client_auth",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/proxy_read_timeout" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "proxy_read_timeout",
"value": 100,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "waf",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http2",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http3",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0rtt",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "pseudo_ipv4",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "websockets",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "image_resizing",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "h2_prioritization",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_platform_optimization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "automatic_platform_optimization",
"value": {
"enabled": true,
"cf": true,
"wordpress": true,
"wp_plugin": true,
"hostnames": [
"www.example.com",
"example.com",
"shop.example.com"
],
"cache_by_device_type": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| items array | One or more zone setting objects. Must contain an ID and a value.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"items":[{"id":"always_online","value":"on"},{"id":"browser_cache_ttl","value":18000},{"id":"ip_geolocation","value":"off"}]}'{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "always_online",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/orange_to_orange" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "orange_to_orange",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value number | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":14400}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_cache_ttl",
"value": 14400,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_check",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"aggressive"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "cache_level",
"value": "aggressive",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value number | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":1800}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "challenge_ttl",
"value": 1800,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "development_mode",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z",
"time_remaining": 3600
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/early_hints" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "early_hints",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "email_obfuscation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "hotlink_protection",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ip_geolocation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ipv6",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object | Value of the zone setting
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"css":"off","html":"off","js":"off"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "minify",
"value": {
"css": "off",
"html": "off",
"js": "off"
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object | Value of the zone setting
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"status":"off","mobile_subdomain":"m","strip_uri":false}}'{
"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"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mirage",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "opportunistic_encryption",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "polish",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "webp",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "brotli",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "privacy_pass",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "rocket_loader",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object |
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"strict_transport_security":{"enabled":true,"max_age":86400,"include_subdomains":true,"nosniff":true}}}'{
"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"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"medium"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_level",
"value": "medium",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "server_side_exclude",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| enabled boolean | ssl-recommender enrollment setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl_recommender" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl_recommender",
"enabled": false,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tls_client_auth",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value number | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/proxy_read_timeout" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":100}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "proxy_read_timeout",
"value": 100,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"1.0"}'{
"success": true,
"errors": [],
"messages": [],
"result": "1.0"
}| Name /type | Description /example | Constraints |
| value array | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]}'{
"success": true,
"errors": [],
"messages": [],
"result": []
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "waf",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the HTTP2 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http2",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the HTTP3 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http3",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the 0-RTT setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0rtt",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the Pseudo IPv4 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "pseudo_ipv4",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "websockets",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Whether the feature is enabled, disabled, or enabled in 'open proxy' mode
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "image_resizing",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "h2_prioritization",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object | Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third party fonts.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_platform_optimization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"enabled":true,"cf":true,"wordpress":true,"wp_plugin":true,"hostnames":["www.example.com","example.com","shop.example.com"],"cache_by_device_type":false}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "automatic_platform_optimization",
"value": {
"enabled": true,
"cf": true,
"wordpress": true,
"wp_plugin": true,
"hostnames": [
"www.example.com",
"example.com",
"shop.example.com"
],
"cache_by_device_type": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "variants",
"modified_on": "2014-01-01T05:20:00.12345Z",
"value": {
"avif": [
"image/webp",
"image/jpeg"
],
"bmp": [
"image/webp",
"image/jpeg"
],
"gif": [
"image/webp",
"image/jpeg"
],
"jpeg": [
"image/webp",
"image/avif"
],
"jpg": [
"image/webp",
"image/avif"
],
"jpg2": [
"image/webp",
"image/avif"
],
"jp2": [
"image/webp",
"image/avif"
],
"png": [
"image/webp",
"image/avif"
],
"tiff": [
"image/webp",
"image/avif"
],
"tif": [
"image/webp",
"image/avif"
],
"webp": [
"image/jpeg",
"image/avif"
]
}
}
}| Name /type | Description /example | Constraints |
| value object | Value of the zone setting
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"avif":["image/webp","image/jpeg"],"bmp":["image/webp","image/jpeg"],"gif":["image/webp","image/jpeg"],"jpeg":["image/webp","image/avif"],"jpg":["image/webp","image/avif"],"jpg2":["image/webp","image/avif"],"jp2":["image/webp","image/avif"],"png":["image/webp","image/avif"],"tiff":["image/webp","image/avif"],"tif":["image/webp","image/avif"],"webp":["image/jpeg","image/avif"]}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "variants",
"modified_on": "2014-01-01T05:20:00.12345Z",
"value": {
"avif": [
"image/webp",
"image/jpeg"
],
"bmp": [
"image/webp",
"image/jpeg"
],
"gif": [
"image/webp",
"image/jpeg"
],
"jpeg": [
"image/webp",
"image/avif"
],
"jpg": [
"image/webp",
"image/avif"
],
"jpg2": [
"image/webp",
"image/avif"
],
"jp2": [
"image/webp",
"image/avif"
],
"png": [
"image/webp",
"image/avif"
],
"tiff": [
"image/webp",
"image/avif"
],
"tif": [
"image/webp",
"image/avif"
],
"webp": [
"image/jpeg",
"image/avif"
]
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "variants",
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Code | Description |
| 1134 | Unable to parse zone setting value. |
| 1135 | Sorry, this zone setting is not available for your plan type. |
| 1136 | Sorry, you do not have access to this zone setting for that zone id or that zone id is invalid. |
| 1137 | Unable to process request. Internal error. |
| 1138 | Unable to retrieve <zone_cache_setting_id> setting value. Internal error. |
| 1140 | Unable to update <zone_cache_setting_id> setting value. Internal error. |
| 1141 | Unable to delete <zone_cache_setting_id> setting. Internal error. |
| 1142 | Unable to retrieve <zone_cache_setting_id> setting value. The zone setting does not exist. |
| 1144 | Unable to delete <zone_cache_setting_id> setting. The zone setting does not exist. |
| 1146 | The value provided for <zone_cache_setting_id> setting is not valid. |
End of life Date: March 1, 2021
Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.
| Name /type | Description /example | Constraints |
| 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:
|
|
| 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.
|
|
| 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.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/dashboard?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}End of life Date: March 1, 2021
Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.
| Name /type | Description /example | Constraints |
| 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:
|
|
| 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.
|
|
| 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.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/colos?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"flag": true
}
}| Name /type | Description /example | Constraints |
| flag boolean | The log retention flag for Logpull API.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"flag":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"flag": true
}
}| Name /type | Description /example | Constraints |
| start <em |