Last modified: March 7th, 2023
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 |
Requests are generally formatted as follows:
GET object/:object_id
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. |
Requests are generally formatted as follows:
GET object/:object_id
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"`The Cloudflare API sets a maximum of 1,200 requests in a five minute period.
Depending on your request, the results returned may be limited. You can page through the returned results with the following query parameters.
| 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": []
}The response format can be determined from the HTTP Content-Type header. Most API responses are JSON (Content-Type: application/json).
| 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) |
The status of a response can be determined from the HTTP status code.
| 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 string of 32 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"View properties and constraints defined on the object
GET user
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
}
}Edit part of your user details.
PATCH user
| Name /type | Description /example | Constraints |
| first_name stringnull | User's first name. "John" |
|
| last_name stringnull | User's last name. "Appleseed" |
|
| telephone stringnull | User's telephone number. "+1 123-123-1234" |
|
| country stringnull | The country in which the user lives. "US" |
|
| zipcode stringnull | The zipcode or postal code where the user lives. "12345" |
|
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
}
}View properties and constraints defined on the object
List all access tokens you created.
GET user/tokens
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. 1 |
|
| per_page number | Maximum number of results per page. 20 |
|
| direction string | Direction to order results. "desc" |
|
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"
]
}
}
}
]
}Create a new access token.
POST user/tokens
| Name /type | Description /example | Constraints |
| name string | Token name. "readonly token" |
|
| policies array | List of access policies assigned to the token. [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
]An array with items in the following form: |
| Name /type | Description /example | Constraints |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing. "2018-07-01T05:20:00Z" | |
| expires_on string (date-time) | The expiration time on or after which the JWT MUST NOT be accepted for processing. "2020-01-01T00:00:00Z" | |
| condition object | Defines the extra limitation on how and/or where the token can be used. {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}An object with the following properties: |
curl -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"
}
}Get information about a specific token.
GET user/tokens/:identifier
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"
]
}
}
}
}Update an existing token.
PUT user/tokens/:identifier
| 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. "2020-01-01T00:00:00Z" | |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing. "2018-07-01T05:20:00Z" | |
| name string | Token name. "readonly token" |
|
| policies array | List of access policies assigned to the token. [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
]An array with items in the following form: | |
| status string | Status of the token. "active" |
|
| issued_on string (date-time) | The time on which the token was created. "2018-07-01T05:20:00Z" |
|
| modified_on string (date-time) | Last time the token was modified. "2018-07-02T05:20:00Z" |
|
| id string | Token identifier tag. "ed17574386854bf78a67040be0a770b0" |
|
| condition object | Defines the extra limitation on how and/or where the token can be used. {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}An object with the following properties: |
curl -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"
]
}
}
}
}Destroy a token.
DELETE user/tokens/:identifier
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"
}
}Roll the token secret.
PUT user/tokens/:identifier/value
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"
}Test whether a token works.
GET user/tokens/verify
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"
}
}View properties and constraints defined on the object
Find all available permission groups.
GET user/tokens/permission_groups
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"
]
}
]
}View properties and constraints defined on the object
List memberships of accounts the user can access.
GET memberships
| Name /type | Description /example | Constraints |
| status string | Status of this membership. "accepted" |
|
| account.name string | Account name. "Demo Account" |
|
| page number | Page number of paginated results. 1 |
|
| per_page number | Number of memberships per page. 20 |
|
| order string | Field to order memberships by. "status" |
|
| direction string | Direction to order memberships. "desc" |
|
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",
"api_access_enabled": true,
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"api_access_enabled": null,
"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
}
}
}
]
}Get a specific membership.
GET memberships/:identifier
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",
"api_access_enabled": true,
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"api_access_enabled": null,
"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
}
}
}
}Accept or reject this account invitation.
PUT memberships/:identifier
| Name /type | Description /example | Constraints |
| status string | Whether to accept or reject this account invitation. "accepted" |
|
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",
"api_access_enabled": true,
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false,
"api_access_enabled": null,
"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
}
}
}
}Remove the associated member from an account.
DELETE memberships/:identifier
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 |
View properties and constraints defined on the object
List all accounts you have ownership or verified access to.
GET accounts
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. 1 |
|
| per_page number | Maximum number of results per page. 20 |
|
| direction string | Direction to order results. "desc" |
|
| name string | Name of the account. "example.com" |
|
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,
"api_access_enabled": null,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
]
}Get information about a specific account that you are a member of.
GET accounts/:identifier
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,
"api_access_enabled": null,
"use_account_custom_ns_by_default": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
}Update an existing account.
PUT accounts/:identifier
| Name /type | Description /example | Constraints |
| id string | Account identifier tag. "01a7362d577a6c3019a474fd6f485823" |
|
| name string | Account name. "Demo Account" |
|
| settings object | Account settings. {
"enforce_twofactor": false,
"api_access_enabled": null,
"use_account_custom_ns_by_default": false
}An object with the following properties: | |
| created_on string (date-time) | describes when account was created. "2014-03-01T12:21:02.0000Z" |
|
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,"api_access_enabled":null,"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,
"api_access_enabled": null,
"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 |
View properties and constraints defined on the object
List all members of an account.
GET accounts/:account_identifier/members
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. 1 |
|
| per_page number | Maximum number of results per page. 20 |
|
| direction string | Direction to order results. "desc" |
|
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
}
}
}
]
}
]
}Add a user to the list of members for this account.
POST accounts/:account_identifier/members
| Name /type | Description /example | Constraints |
| email string | The contact email address of the user. "user@example.com" |
|
| roles array | Array of roles associated with this member. [
"3536bcfad5faccb999b47003c79917fb"
]An array with items in the following form: |
| Name /type | Description /example | Constraints |
| status string | A member's status in the account. "accepted" |
|
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
}
}
}
]
}
}Get information about a specific member of an account.
GET accounts/:account_identifier/members/:identifier
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
}
}
}
]
}
}Modify an account member.
PUT accounts/:account_identifier/members/:identifier
| Name /type | Description /example | Constraints |
| id string | Membership identifier tag. "4536bcfad5faccb111b47003c79917fa" |
|
| code string | The unique activation code for the account membership. "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0" |
|
| user object | {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
}An object with the following properties: |
|
| status string | A member's status in the account. "accepted" |
|
| roles array | Roles assigned to this member. [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]An array with items in the following form: |
curl -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
}
}
}
]
}
}Remove a member from an account.
DELETE accounts/:account_identifier/members/:identifier
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"
}
}View properties and constraints defined on the object
Get all available roles for an account.
GET accounts/:account_identifier/roles
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
}
}
}
]
}Get information about a specific role for an account.
GET accounts/:account_identifier/roles/:identifier
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
}
}
}
}View properties and constraints defined on the object
Lists all of an account's subscriptions.
GET accounts/:account_identifier/subscriptions
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"
}
]
}Creates an account subscription.
POST accounts/:account_identifier/subscriptions
| Name /type | Description /example | Constraints |
| app | {
"install_id": null
}An object with the following properties: | |
| current_period_end string (date-time) | The end of the current period and also when the next billing is due. "2014-03-31T12:20:00Z" |
|
| component_values array | The list of add-ons subscribed to. [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
]An array with items in the following form: | |
| rate_plan object | The rate plan applied to the subscription. {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
}An object with the following properties: | |
| price number | The price of the subscription that will be billed, in US dollars. 20 |
|
| current_period_start string (date-time) | When the current billing period started. May match initial_period_start if this is the first period. "2014-05-11T12:20:00Z" |
|
| zone object | A simple zone object. May have null properties if not a zone subscription. {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
}An object with the following properties: | |
| currency string | The monetary unit in which pricing information is displayed. "USD" |
|
| state string | The state that the subscription is in. "Paid" |
|
| id string | Subscription identifier tag. "506e3185e9c882d175a2d0cb0093d9f2" |
|
| frequency string | How often the subscription is renewed automatically. "monthly" |
|
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"
}
}Updates an account subscription.
PUT accounts/:account_identifier/subscriptions/:subscription_identifier
| Name /type | Description /example | Constraints |
| app | {
"install_id": null
}An object with the following properties: | |
| current_period_end string (date-time) | The end of the current period and also when the next billing is due. "2014-03-31T12:20:00Z" |
|
| component_values array | The list of add-ons subscribed to. [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
]An array with items in the following form: | |
| rate_plan object | The rate plan applied to the subscription. {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
}An object with the following properties: | |
| price number | The price of the subscription that will be billed, in US dollars. 20 |
|
| current_period_start string (date-time) | When the current billing period started. May match initial_period_start if this is the first period. "2014-05-11T12:20:00Z" |
|
| zone object | A simple zone object. May have null properties if not a zone subscription. {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
}An object with the following properties: | |
| currency string | The monetary unit in which pricing information is displayed. "USD" |
|
| state string | The state that the subscription is in. "Paid" |
|
| id string | Subscription identifier tag. "506e3185e9c882d175a2d0cb0093d9f2" |
|
| frequency string | How often the subscription is renewed automatically. "monthly" |
|
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"
}
}Deletes an account's subscription.
DELETE accounts/:account_identifier/subscriptions/:subscription_identifier
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.
View properties and constraints defined on the object
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.
Get information about a specific organization that you are a member of.
GET organizations/:identifier
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.
Update an existing Organization.
PATCH organizations/:identifier
| Name /type | Description /example | Constraints |
| name string | Organization name. "Cloudflare, Inc." |
|
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.
View properties and constraints defined on the object
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.
List all invitations associated with an organization.
GET organizations/:organization_identifier/invites
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.
Invite a User to become a Member of an Organization.
POST organizations/:organization_identifier/invites
| Name /type | Description /example | Constraints |
| invited_member_email string | Email address of the user to add to the organization. "user@example.com" |
|
| roles array | Array of Roles associated with the invited user. [
{
"id": "5a7805061c76ada191ed06f989cc3dac"
},
{
"id": "9a7806061c88ada191ed06f989cc3dac"
}
]An array with items in the following form: |
| 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. true |
|
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.
Get the details of an invitation.
GET organizations/:organization_identifier/invites/:identifier
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.
Change the Roles of a Pending Invite.
PATCH organizations/:organization_identifier/invites/:identifier
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with the invited user. [
"3536bcfad5faccb999b47003c79917fb"
]An array with items in the following form: |
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.
Cancel an existing invitation.
DELETE organizations/:organization_identifier/invites/:identifier
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.
View properties and constraints defined on the object
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.
List all members of a organization.
GET organizations/:organization_identifier/members
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.
Get information about a specific member of an organization.
GET organizations/:organization_identifier/members/:identifier
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.
Change the Roles of an Organization's Member.
PATCH organizations/:organization_identifier/members/:identifier
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with this Member. [
"3536bcfad5faccb999b47003c79917fb"
]An array with items in the following form: |
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.
Remove a member from an organization.
DELETE organizations/:organization_identifier/members/:identifier
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.
View properties and constraints defined on the object
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.
Get all available roles for an organization.
GET organizations/:organization_identifier/roles
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.
Get information about a specific role for an organization.
GET organizations/:organization_identifier/roles/:identifier
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"
]
}
}View properties and constraints defined on the object
Lists all invitations associated with my user.
GET user/invites
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"
}
]
}Gets the details of an invitation.
GET user/invites/:identifier
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"
}
}Responds to an invitation.
PATCH user/invites/:identifier
| Name /type | Description /example | Constraints |
| status | Status of your response to the invitation (rejected or accepted). "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.
View properties and constraints defined on the object
Lists organizations the user is associated with.
GET user/organizations
| Name /type | Description /example | Constraints |
| status string | Whether the user is a member of the organization or has an inivitation pending. "member" |
|
| name string | Organization name. "Cloudflare, Inc." |
|
| page number | Page number of paginated results. 1 |
|
| per_page number | Number of organizations per page. 20 |
|
| order string | Field to order organizations by. "status" |
|
| direction string | Direction to order organizations. "desc" |
|
| match string | Whether to match all search requirements or at least one (any). "all" |
|
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"
]
}
]
}Gets a specific organization the user is associated with.
GET user/organizations/:identifier
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"
]
}
}Removes association to an organization.
DELETE user/organizations/:identifier
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"
}View properties and constraints defined on the object
Accesses your billing profile object.
GET user/billing/profile
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"
}
}View properties and constraints defined on the object
Accesses your billing history object.
GET user/billing/history
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. 1 |
|
| per_page number | Number of items per page. 20 |
|
| order string | Field to order billing history by. "occured_at" |
|
| type string | The billing item type. "charge" |
|
| occured_at string (date-time) | When the billing item was created. "2014-03-01T12:21:59.3456Z" |
|
| action string | The billing item action. "subscription" |
|
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"
}
}
]
}View properties and constraints defined on the object
Lists all of a user's subscriptions.
GET user/subscriptions
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"
}
]
}Updates a user's subscriptions.
PUT user/subscriptions/:identifier
| Name /type | Description /example | Constraints |
| app | {
"install_id": null
}An object with the following properties: | |
| current_period_end string (date-time) | The end of the current period and also when the next billing is due. "2014-03-31T12:20:00Z" |
|
| component_values array | The list of add-ons subscribed to. [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
]An array with items in the following form: | |
| rate_plan object | The rate plan applied to the subscription. {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
}An object with the following properties: | |
| price number | The price of the subscription that will be billed, in US dollars. 20 |
|
| current_period_start string (date-time) | When the current billing period started. May match initial_period_start if this is the first period. "2014-05-11T12:20:00Z" |
|
| zone object | A simple zone object. May have null properties if not a zone subscription. {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
}An object with the following properties: | |
| currency string | The monetary unit in which pricing information is displayed. "USD" |
|
| state string | The state that the subscription is in. "Paid" |
|
| id string | Subscription identifier tag. "506e3185e9c882d175a2d0cb0093d9f2" |
|
| frequency string | How often the subscription is renewed automatically. "monthly" |
|
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"
}
}Deletes a user's subscription.
DELETE user/subscriptions/:identifier
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"
}View properties and constraints defined on the object
Gets the current billing profile for the account.
GET accounts/:account_identifier/billing/profile
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"
}
}View properties and constraints defined on the object
Lists all rate plans the zone can subscribe to.
GET zones/:zone_identifier/available_rate_plans
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
}
]
}
]
}Lists available plans the zone can subscribe to.
GET zones/:zone_identifier/available_plans
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
}
]
}Details of the available plan that the zone can subscribe to.
GET zones/:zone_identifier/available_plans/:plan_identifier
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
}
}View properties and constraints defined on the object
Lists zone subscription details.
GET zones/:identifier/subscription
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"
}
}Updates zone subscriptions, either plan or add-ons.
PUT zones/:identifier/subscription
| Name /type | Description /example | Constraints |
| app | {
"install_id": null
}An object with the following properties: | |
| current_period_end string (date-time) | The end of the current period and also when the next billing is due. "2014-03-31T12:20:00Z" |
|
| component_values array | The list of add-ons subscribed to. [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
]An array with items in the following form: | |
| rate_plan object | The rate plan applied to the subscription. {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
}An object with the following properties: | |
| price number | The price of the subscription that will be billed, in US dollars. 20 |
|
| current_period_start string (date-time) | When the current billing period started. May match initial_period_start if this is the first period. "2014-05-11T12:20:00Z" |
|
| zone object | A simple zone object. May have null properties if not a zone subscription. {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
}An object with the following properties: | |
| currency string | The monetary unit in which pricing information is displayed. "USD" |
|
| state string | The state that the subscription is in. "Paid" |
|
| id string | Subscription identifier tag. "506e3185e9c882d175a2d0cb0093d9f2" |
|
| frequency string | How often the subscription is renewed automatically. "monthly" |
|
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"
}
}Create a zone subscription, either plan or add-ons.
POST zones/:identifier/subscription
| Name /type | Description /example | Constraints |
| app | {
"install_id": null
}An object with the following properties: | |
| current_period_end string (date-time) | The end of the current period and also when the next billing is due. "2014-03-31T12:20:00Z" |
|
| component_values array | The list of add-ons subscribed to. [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
]An array with items in the following form: | |
| rate_plan object | The rate plan applied to the subscription. {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
}An object with the following properties: | |
| price number | The price of the subscription that will be billed, in US dollars. 20 |
|
| current_period_start string (date-time) | When the current billing period started. May match initial_period_start if this is the first period. "2014-05-11T12:20:00Z" |
|
| zone object | A simple zone object. May have null properties if not a zone subscription. {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
}An object with the following properties: | |
| currency string | The monetary unit in which pricing information is displayed. "USD" |
|
| state string | The state that the subscription is in. "Paid" |
|
| id string | Subscription identifier tag. "506e3185e9c882d175a2d0cb0093d9f2" |
|
| frequency string | How often the subscription is renewed automatically. "monthly" |
|
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"
}
}View properties and constraints defined on the object
Gets a list of audit logs for a user account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.
GET user/audit_logs
| Name /type | Description /example | Constraints |
| actor.ip string | Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range. "17.168.228.63" | |
| actor.email string (email) | Filters by the email address of the actor that made the change. "alice@example.com" | |
| hide_user_logs boolean | Indicates whether or not to hide user level audit logs. false |
|
| zone.name string | Filters by the name of the zone associated to the change. "example.com" | |
| page number | Defines which page of results to return. 50 |
|
| per_page number | Sets the number of results to return per page. 25 |
|
| action.type string | Filters by the action type. "add" | |
| export boolean | Indicates that this request is an export of logs in CSV format. "true" |
|
| since string (date-time) | Limits the returned results to logs newer than the specified date. This can be a date string "2019-04-30T01:12:20Z" | |
| id string | Finds a specific log by its ID. "f174be97-19b1-40d6-954d-70cd5fbd52db" | |
| direction string | Changes the direction of the chronological sorting. "desc" |
|
| before string (date-time) | Limits the returned results to logs older than the specified date. This can be a date string "2019-04-30T01:12:20Z" |
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&hide_user_logs=false" \
-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"
}
]
}Gets a list of audit logs for an account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.
GET accounts/:account_identifier/audit_logs
| Name /type | Description /example | Constraints |
| actor.ip string | Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range. "17.168.228.63" | |
| actor.email string (email) | Filters by the email address of the actor that made the change. "alice@example.com" | |
| hide_user_logs boolean | Indicates whether or not to hide user level audit logs. false |
|
| zone.name string | Filters by the name of the zone associated to the change. "example.com" | |
| page number | Defines which page of results to return. 50 |
|
| per_page number | Sets the number of results to return per page. 25 |
|
| action.type string | Filters by the action type. "add" | |
| export boolean | Indicates that this request is an export of logs in CSV format. "true" |
|
| since string (date-time) | Limits the returned results to logs newer than the specified date. This can be a date string "2019-04-30T01:12:20Z" | |
| id string | Finds a specific log by its ID. "f174be97-19b1-40d6-954d-70cd5fbd52db" | |
| direction string | Changes the direction of the chronological sorting. "desc" |
|
| before string (date-time) | Limits the returned results to logs older than the specified date. This can be a date string "2019-04-30T01:12:20Z" |
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&hide_user_logs=false" \
-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.
Gets a list of audit logs for an organization. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.
GET organizations/:organization_identifier/audit_logs
| Name /type | Description /example | Constraints |
| actor.ip string | Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range. "17.168.228.63" | |
| actor.email string (email) | Filters by the email address of the actor that made the change. "alice@example.com" | |
| hide_user_logs boolean | Indicates whether or not to hide user level audit logs. false |
|
| zone.name string | Filters by the name of the zone associated to the change. "example.com" | |
| page number | Defines which page of results to return. 50 |
|
| per_page number | Sets the number of results to return per page. 25 |
|
| action.type string | Filters by the action type. "add" | |
| export boolean | Indicates that this request is an export of logs in CSV format. "true" |
|
| since string (date-time) | Limits the returned results to logs newer than the specified date. This can be a date string "2019-04-30T01:12:20Z" | |
| id string | Finds a specific log by its ID. "f174be97-19b1-40d6-954d-70cd5fbd52db" | |
| direction string | Changes the direction of the chronological sorting. "desc" |
|
| before string (date-time) | Limits the returned results to logs older than the specified date. This can be a date string "2019-04-30T01:12:20Z" |
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&hide_user_logs=false" \
-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"
}
]
}View properties and constraints defined on the object
GET zones/:zone_identifier/argo/smart_routing
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"
}
}Updates enablement of Argo Smart Routing.
PATCH zones/:zone_identifier/argo/smart_routing
| Name /type | Description /example | Constraints |
| value string | Enables Argo Smart Routing. "on" |
|
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"
}
}View properties and constraints defined on the object
GET zones/:zone_identifier/analytics/latency
| Name /type | Description /example | Constraints |
| bins integer | Number of buckets that latency is split into. 3 |
|
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
}
}
}View properties and constraints defined on the object
GET zones/:zone_identifier/analytics/latency/colos
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
]
}
}
]
}
}View properties and constraints defined on the object
GET zones/:zone_identifier/argo/tiered_caching
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/tiered_caching" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tiered_caching",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}Updates enablement of Tiered Caching
PATCH zones/:zone_identifier/argo/tiered_caching
| Name /type | Description /example | Constraints |
| value string | Enables Tiered Caching. "on" |
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/tiered_caching" \
-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": "tiered_caching",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}View properties and constraints defined on the object
GET zones/:zone_identifier/cache/tiered_cache_smart_topology_enable
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/tiered_cache_smart_topology_enable" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tiered_cache_smart_topology_enable",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}Updates enablement of Tiered Cache
PATCH zones/:zone_identifier/cache/tiered_cache_smart_topology_enable
| Name /type | Description /example | Constraints |
| value string | Enables Tiered Cache. "on" |
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/tiered_cache_smart_topology_enable" \
-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": "tiered_cache_smart_topology_enable",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}Remvoves enablement of Smart Tiered Cache
DELETE zones/:zone_identifier/cache/tiered_cache_smart_topology_enable
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/tiered_cache_smart_topology_enable" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tiered_cache_smart_topology_enable",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}View properties and constraints defined on the object
GET zones/:zone_id/api_gateway/configuration
| Name /type | Description /example | Constraints |
| properties array | Requests information about certain properties. [
"auth_id_characteristics"
]An array with items in the following form: |
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/configuration?properties=auth_id_characteristics" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"auth_id_characteristics": [
{
"type": "header",
"name": "authorization"
}
]
}
}PUT zones/:zone_id/api_gateway/configuration
| Name /type | Description /example | Constraints |
| auth_id_characteristics array | Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner. [
{
"type": "header",
"name": "authorization"
}
]An array with items in the following form: |
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/configuration" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"auth_id_characteristics":[{"type":"header","name":"authorization"}]}'{
"success": true,
"errors": [],
"messages": []
}View properties and constraints defined on the object
GET zones/:zone_id/api_gateway/operations/:operation_id
| Name /type | Description /example | Constraints |
| feature array | Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. [
"thresholds"
]An array with items in the following form: |
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/operations/f174e90a-fafe-4643-bbbc-4a0ed4fc8415?feature=thresholds" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"method": "GET",
"host": "www.example.com",
"endpoint": "/api/v1/users/{var1}",
"last_updated": "2014-01-01T05:20:00.12345Z",
"features": {
"thresholds": {
"period_seconds": 600,
"suggested_threshold": 18,
"p50": 3,
"p90": 7,
"p99": 11,
"requests": 65890,
"auth_id_tokens": 7236,
"data_points": 10100,
"last_updated": "2014-01-01T05:20:00.12345Z"
}
}
}
}GET zones/:zone_id/api_gateway/operations
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. 1 |
|
| per_page number | Maximum number of results per page. 20 |
|
| feature array | Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. [
"thresholds"
]An array with items in the following form: |
|
| order string | Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. "method" |
|
| direction string | Direction to order results. "desc" |
|
| host array | Filter results to only include the specified hosts. [
"api.cloudflare.com"
]An array with items in the following form: |
|
| method array | Filter results to only include the specified HTTP methods. [
"GET"
]An array with items in the following form: |
|
| endpoint string | Filter results to only include endpoints containing this pattern. "/api/v1" |
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/operations?page=1&per_page=20&feature=thresholds&order=method&direction=desc&host=api.cloudflare.com&method=GET&endpoint=/api/v1" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"method": "GET",
"host": "www.example.com",
"endpoint": "/api/v1/users/{var1}",
"last_updated": "2014-01-01T05:20:00.12345Z",
"features": {
"thresholds": {
"period_seconds": 600,
"suggested_threshold": 18,
"p50": 3,
"p90": 7,
"p99": 11,
"requests": 65890,
"auth_id_tokens": 7236,
"data_points": 10100,
"last_updated": "2014-01-01T05:20:00.12345Z"
}
}
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 500
}
}DELETE zones/:zone_id/api_gateway/operations/:operation_id
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/operations/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.
POST zones/:zone_id/api_gateway/operations
| Name /type | Description /example | Constraints |
| host string (hostname) | RFC3986-compliant host. "www.example.com" |
|
| method string | The HTTP method used to access the endpoint. "GET" |
|
| endpoint string (uri-template) | The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/. "/api/v1/users/{var1}" |
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/operations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"host":"www.example.com","method":"GET","endpoint":"/api/v1/users/{var1}"}]'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"method": "GET",
"host": "www.example.com",
"endpoint": "/api/v1/users/{var1}",
"last_updated": "2014-01-01T05:20:00.12345Z"
}
]
}GET zones/:zone_id/api_gateway/schemas
| Name /type | Description /example | Constraints |
| feature array | Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. [
"thresholds"
]An array with items in the following form: |
|
| host array | Receive schema only for the given host(s). [
"www.example.com"
]An array with items in the following form: |
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/schemas?feature=thresholds&host=www.example.com" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"timestamp": "2014-01-01T05:20:00.12345Z",
"schemas": [
{
"openapi": "3.0.0",
"servers": [
{
"url": "www.example.com"
}
],
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"paths": {
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"in": "path",
"name": "var1",
"required": true,
"schema": {
"type": "string"
}
}
],
"x-cf-threshold": {
"period_seconds": 600,
"suggested_threshold": 18,
"p50": 3,
"p90": 7,
"p99": 11,
"requests": 66886,
"auth_id_tokens": 7262,
"data_points": 10189,
"last_udated": "2014-01-01T05:20:00.12345Z"
}
}
},
"... Further paths ...": {}
}
}
]
}
}Retrieve the most up to date view of API Discovery on a zone.
GET zones/:zone_id/api_gateway/discovery
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/api_gateway/discovery" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"timestamp": "2014-01-01T05:20:00.12345Z",
"schemas": [
{
"openapi": "3.0.0",
"servers": [
{
"url": "www.example.com"
}
],
"info": {
"title": "OpenAPI JSON schema for www.example.com",
"version": "1.0"
},
"paths": {
"/api/v1/users/{var1}": {
"get": {
"parameters": [
{
"in": "path",
"name": "var1",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"... Further paths ...": {}
}
}
]
}
}View properties and constraints defined on the object
Lists, searches, sorts, and filters your zones.
GET zones
| Name /type | Description /example | Constraints |
| match string | Whether to match all search requirements or at least one (any). "all" |
|
| name string (hostname) | A domain name. "example.com" |
|
| account.name string | Account name. "Demo Account" |
|
| order string | Field to order zones by. "status" |
|
| page number | Page number of paginated results. 1 |
|
| per_page number | Number of zones per page. 20 |
|
| status string | Status of the zone. "active" |
|
| account.id string | Account identifier tag. "01a7362d577a6c3019a474fd6f485823" |
|
| direction string | Direction to order zones. "desc" |
|
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"
]
}
]
}POST zones
| Name /type | Description /example | Constraints |
| name string | The domain name. "example.com" |
|
| account object | Account in which the zone was created. {
"id": "01a7362d577a6c3019a474fd6f485823"
}An object with the following properties: |
| Name /type | Description /example | Constraints |
| type string | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. "full" |
|
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"},"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"
]
}
}GET zones/:identifier
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"
]
}
}Editz a zone. Only one zone property can be changed at a time.
PATCH zones/:identifier
| Name /type | Description /example | Constraints |
| paused boolean | Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. false |
|
| vanity_name_servers array | An array of domains used for custom name servers. This is only available for Business and Enterprise plans. [
"ns1.example.com",
"ns2.example.com"
]An array with items in the following form: | |
| plan object | (Deprecated) Please use the /zones/:identifier/subscription API to update a zone's plan. The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. {
"id": "e592fd9519420ba7405e1307bff33214"
}An object with the following properties: | |
| type string | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. "full" |
|
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"
]
}
}Deletes an existing zone.
DELETE zones/:identifier
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"
}
}Initiates another zone activation check.
PUT zones/:identifier/activation_check
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"
}
}| 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 tested. 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>', which is an invalid 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. |
| 1134 | Unable to purge '<url>'. URL headers must not contain reserved cf header: '<header name>'. |
| 1135 | Unable to purge: '<url>'. URL contains a newline. |
| 1136 | Unable to purge: '<url>'. URL has invalid scheme "<scheme>". |
| 1137 | Unable to purge: '<url>'. URL host is too long. |
| 1138 | Unable to purge: '<url>'. URL host has a zero-length label. |
| 1139 | Unable to purge: '<url>'. Host has a label exceeding '<max host label length>' characters. |
| 1140 | Unable to purge: '<url>'. Host contains invalid top level domain: '<top level domain>'. |
| 1141 | Unable to purge: '<url>'. Host is an invalid domain. |
| 1142 | Unable to purge '<url>', cdn-cgi endpoints cannot be purged. |
View properties and constraints defined on the object
Available settings for your user in relation to a zone.
GET zones/:zone_identifier/settings
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": []
}Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.
GET zones/:zone_identifier/settings/advanced_ddos
curl -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"
}
}When enabled, Cloudflare serves limited copies of web pages available from the Internet Archive's Wayback Machine if your server is offline. Refer to Always Online for more information.
GET zones/:zone_identifier/settings/always_online
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"
}
}Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.
GET zones/:zone_identifier/settings/always_use_https
curl -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"
}Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
GET zones/:zone_identifier/settings/opportunistic_onion
curl -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"
}Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
GET zones/:zone_identifier/settings/orange_to_orange
curl -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"
}
}Enable the Automatic HTTPS Rewrites feature for this zone.
GET zones/:zone_identifier/settings/automatic_https_rewrites
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"
}Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).
GET zones/:zone_identifier/settings/browser_cache_ttl
curl -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"
}
}Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).
GET zones/:zone_identifier/settings/browser_check
curl -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"
}
}Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
GET zones/:zone_identifier/settings/cache_level
curl -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"
}
}Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).
GET zones/:zone_identifier/settings/challenge_ttl
curl -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"
}
}Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.
GET zones/:zone_identifier/settings/development_mode
curl -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
}
}When enabled, Cloudflare will attempt to speed up overall page loads by serving 103 responses with Link headers from the final response. Refer to Early Hints for more information.
GET zones/:zone_identifier/settings/early_hints
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"
}
}Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
GET zones/:zone_identifier/settings/email_obfuscation
curl -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"
}
}When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).
GET zones/:zone_identifier/settings/hotlink_protection
curl -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"
}
}Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).
GET zones/:zone_identifier/settings/ip_geolocation
curl -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"
}
}Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).
GET zones/:zone_identifier/settings/ipv6
curl -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"
}
}Automatically minify certain assets for your website. Refer to Using Cloudflare Auto Minify for more information.
GET zones/:zone_identifier/settings/minify
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"
}
}Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to Understanding Cloudflare Mobile Redirect for more information.
GET zones/:zone_identifier/settings/mobile_redirect
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"
}
}Automatically optimize image loading for website visitors on mobile devices. Refer to our blog post for more information.
GET zones/:zone_identifier/settings/mirage
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"
}
}Enable Network Error Logging reporting on your zone. (Beta)
GET zones/:zone_identifier/settings/nel
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/nel" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "nel",
"value": {
"enabled": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.
GET zones/:zone_identifier/settings/origin_error_page_pass_thru
curl -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"
}Gets Opportunistic Encryption setting.
GET zones/:zone_identifier/settings/opportunistic_encryption
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"
}
}Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.
GET zones/:zone_identifier/settings/polish
curl -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"
}
}When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.
GET zones/:zone_identifier/settings/webp
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"
}
}When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
GET zones/:zone_identifier/settings/brotli
curl -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"
}
}Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
GET zones/:zone_identifier/settings/prefetch_preload
curl -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"
}Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).
GET zones/:zone_identifier/settings/privacy_pass
curl -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"
}
}Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.
GET zones/:zone_identifier/settings/response_buffering
curl -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"
}Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the window.onload time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to Understanding Rocket Loader for more information.
GET zones/:zone_identifier/settings/rocket_loader
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"
}
}Cloudflare security header for a zone.
GET zones/:zone_identifier/settings/security_header
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"
}
}Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).
GET zones/:zone_identifier/settings/security_level
curl -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"
}
}If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).
GET zones/:zone_identifier/settings/server_side_exclude
curl -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"
}
}Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.
GET zones/:zone_identifier/settings/sort_query_string_for_cache
curl -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"
}SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).
GET zones/:zone_identifier/settings/ssl
curl -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"
}
}Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.
GET zones/:zone_identifier/settings/ssl_recommender
curl -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"
}
}Gets Minimum TLS Version setting.
GET zones/:zone_identifier/settings/min_tls_version
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"
}Gets ciphers setting.
GET zones/:zone_identifier/settings/ciphers
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": []
}Gets TLS 1.3 setting enabled for a zone.
GET zones/:zone_identifier/settings/tls_1_3
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"
}TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
GET zones/:zone_identifier/settings/tls_client_auth
curl -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"
}
}Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.
GET zones/:zone_identifier/settings/true_client_ip_header
curl -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"
}Maximum time between two read operations from origin.
GET zones/:zone_identifier/settings/proxy_read_timeout
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"
}
}The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
GET zones/:zone_identifier/settings/waf
curl -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"
}
}Value of the HTTP2 setting.
GET zones/:zone_identifier/settings/http2
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"
}
}Value of the HTTP3 setting.
GET zones/:zone_identifier/settings/http3
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"
}
}Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is "1").
GET zones/:zone_identifier/settings/origin_max_http_version
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_max_http_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "origin_max_http_version",
"modified_on": "2014-01-01T05:20:00.12345Z",
"value": "2"
}
}Gets 0-RTT session resumption setting.
GET zones/:zone_identifier/settings/0rtt
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"
}
}Value of the Pseudo IPv4 setting.
GET zones/:zone_identifier/settings/pseudo_ipv4
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"
}
}Gets Websockets setting. For more information about Websockets, please refer to Using Cloudflare with WebSockets.
GET zones/:zone_identifier/settings/websockets
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"
}
}Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the Image Resizing documentation for more information.
GET zones/:zone_identifier/settings/image_resizing
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"
}
}Gets HTTP/2 Edge Prioritization setting.
GET zones/:zone_identifier/settings/h2_prioritization
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"
}
}Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third-party fonts.
GET zones/:zone_identifier/settings/automatic_platform_optimization
curl -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"
}
}Edit settings for a zone.
PATCH zones/:zone_identifier/settings
| Name /type | Description /example | Constraints |
| items array | One or more zone setting objects. Must contain an ID and a value. [
{
"id": "always_online",
"value": "on"
},
{
"id": "browser_cache_ttl",
"value": 18000
},
{
"id": "ip_geolocation",
"value": "off"
}
]An array with items in the following form: |
|
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": []
}When enabled, Cloudflare serves limited copies of web pages available from the Internet Archive's Wayback Machine if your server is offline. Refer to Always Online for more information.
PATCH zones/:zone_identifier/settings/always_online
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.
PATCH zones/:zone_identifier/settings/always_use_https
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
PATCH zones/:zone_identifier/settings/opportunistic_onion
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
PATCH zones/:zone_identifier/settings/orange_to_orange
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Enable the Automatic HTTPS Rewrites feature for this zone.
PATCH zones/:zone_identifier/settings/automatic_https_rewrites
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).
PATCH zones/:zone_identifier/settings/browser_cache_ttl
| Name /type | Description /example | Constraints |
| value number | Value of the zone setting. 14400 |
|
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"
}
}Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).
PATCH zones/:zone_identifier/settings/browser_check
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
PATCH zones/:zone_identifier/settings/cache_level
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "aggressive" |
|
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"
}
}Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).
PATCH zones/:zone_identifier/settings/challenge_ttl
| Name /type | Description /example | Constraints |
| value number | Value of the zone setting. 1800 |
|
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"
}
}Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.
PATCH zones/:zone_identifier/settings/development_mode
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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
}
}When enabled, Cloudflare will attempt to speed up overall page loads by serving 103 responses with Link headers from the final response. Refer to Early Hints for more information.
PATCH zones/:zone_identifier/settings/early_hints
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
PATCH zones/:zone_identifier/settings/email_obfuscation
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.
PATCH zones/:zone_identifier/settings/origin_error_page_pass_thru
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.
PATCH zones/:zone_identifier/settings/sort_query_string_for_cache
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).
PATCH zones/:zone_identifier/settings/hotlink_protection
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).
PATCH zones/:zone_identifier/settings/ip_geolocation
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).
PATCH zones/:zone_identifier/settings/ipv6
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Automatically minify certain assets for your website. Refer to Using Cloudflare Auto Minify for more information.
PATCH zones/:zone_identifier/settings/minify
| Name /type | Description /example | Constraints |
| value object | Value of the zone setting. {
"css": "off",
"html": "off",
"js": "off"
}An object with the following properties: |
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"
}
}Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to Understanding Cloudflare Mobile Redirect for more information.
PATCH zones/:zone_identifier/settings/mobile_redirect
| Name /type | Description /example | Constraints |
| value object | Value of the zone setting. {
"status": "off",
"mobile_subdomain": "m",
"strip_uri": false
}An object with the following properties: |
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"
}
}Automatically optimize image loading for website visitors on mobile devices. Refer to our blog post for more information.
PATCH zones/:zone_identifier/settings/mirage
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Enable Network Error Logging reporting on your zone. (Beta)
PATCH zones/:zone_identifier/settings/nel
| Name /type | Description /example | Constraints |
| value object | Value of the zone setting. {
"enabled": false
}An object with the following properties: |
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/nel" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"enabled":false}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "nel",
"value": {
"enabled": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}Changes Opportunistic Encryption setting.
PATCH zones/:zone_identifier/settings/opportunistic_encryption
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.
PATCH zones/:zone_identifier/settings/polish
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.
PATCH zones/:zone_identifier/settings/webp
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
PATCH zones/:zone_identifier/settings/brotli
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
PATCH zones/:zone_identifier/settings/prefetch_preload
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).
PATCH zones/:zone_identifier/settings/privacy_pass
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.
PATCH zones/:zone_identifier/settings/response_buffering
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the window.onload time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to Understanding Rocket Loader for more information.
PATCH zones/:zone_identifier/settings/rocket_loader
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Cloudflare security header for a zone.
PATCH zones/:zone_identifier/settings/security_header
| Name /type | Description /example | Constraints |
| value object | {
"strict_transport_security": {
"enabled": true,
"max_age": 86400,
"include_subdomains": true,
"nosniff": true
}
}An object with the following properties: |
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"
}
}Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).
PATCH zones/:zone_identifier/settings/security_level
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "medium" |
|
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"
}
}If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).
PATCH zones/:zone_identifier/settings/server_side_exclude
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "on" |
|
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"
}
}SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).
PATCH zones/:zone_identifier/settings/ssl
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.
PATCH zones/:zone_identifier/settings/ssl_recommender
| Name /type | Description /example | Constraints |
| enabled boolean | ssl-recommender enrollment setting. false |
|
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"
}
}TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
PATCH zones/:zone_identifier/settings/tls_client_auth
| Name /type | Description /example | Constraints |
| value string | value of the zone setting. "on" |
|
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"
}
}Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.
PATCH zones/:zone_identifier/settings/true_client_ip_header
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}Maximum time between two read operations from origin.
PATCH zones/:zone_identifier/settings/proxy_read_timeout
| Name /type | Description /example | Constraints |
| value number | Value of the zone setting. 100 |
|
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"
}
}Changes Minimum TLS Version setting.
PATCH zones/:zone_identifier/settings/min_tls_version
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "1.0" |
|
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"
}Changes ciphers setting.
PATCH zones/:zone_identifier/settings/ciphers
| Name /type | Description /example | Constraints |
| value array | Value of the zone setting. [
"ECDHE-RSA-AES128-GCM-SHA256",
"AES128-SHA"
]An array with items in the following form: |
|
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": []
}Changes TLS 1.3 setting.
PATCH zones/:zone_identifier/settings/tls_1_3
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
PATCH zones/:zone_identifier/settings/waf
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Value of the HTTP2 setting.
PATCH zones/:zone_identifier/settings/http2
| Name /type | Description /example | Constraints |
| value string | Value of the HTTP2 setting. "off" |
|
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"
}
}Value of the HTTP3 setting.
PATCH zones/:zone_identifier/settings/http3
| Name /type | Description /example | Constraints |
| value string | Value of the HTTP3 setting. "off" |
|
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"
}
}The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to Enable HTTP/2 to Origin, for more information.).
PATCH zones/:zone_identifier/settings/origin_max_http_version
| Name /type | Description /example | Constraints |
| value string | Value of the Origin Max HTTP version setting (Note that the default value for Enterprise is "1"). "2" |
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_max_http_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"2"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "origin_max_http_version",
"modified_on": "2014-01-01T05:20:00.12345Z",
"value": "2"
}
}Changes the 0-RTT session resumption setting.
PATCH zones/:zone_identifier/settings/0rtt
| Name /type | Description /example | Constraints |
| value string | Value of the 0-RTT setting. "off" |
|
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"
}
}Value of the Pseudo IPv4 setting.
PATCH zones/:zone_identifier/settings/pseudo_ipv4
| Name /type | Description /example | Constraints |
| value string | Value of the Pseudo IPv4 setting. "off" |
|
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"
}
}Changes Websockets setting. For more information about Websockets, please refer to Using Cloudflare with WebSockets.
PATCH zones/:zone_identifier/settings/websockets
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the Image Resizing documentation for more information.
PATCH zones/:zone_identifier/settings/image_resizing
| Name /type | Description /example | Constraints |
| value string | Whether the feature is enabled, disabled, or enabled in "off" |
|
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"
}
}Changes HTTP/2 Edge Prioritization setting.
PATCH zones/:zone_identifier/settings/h2_prioritization
| Name /type | Description /example | Constraints |
| value string | Value of the zone setting. "off" |
|
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"
}
}Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third-party fonts.
PATCH zones/:zone_identifier/settings/automatic_platform_optimization
| 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. {
"enabled": true,
"cf": true,
"wordpress": true,
"wp_plugin": true,
"hostnames": [
"www.example.com",
"example.com",
"shop.example.com"
],
"cache_by_device_type": false
}An object with the following properties: |
curl -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"
}
}