The Wayback Machine - https://web.archive.org/web/20200606050808/https://api.cloudflare.com/
Last modified: June 4th, 2020
Cloudflare's API exposes the entire Cloudflare infrastructure via a standardized programmatic interface. Using Cloudflare's API, you can do just about anything you can do on cloudflare.com via the customer dashboard.
The Cloudflare API is a RESTful API based on HTTPS requests and JSON responses. If you are registered with Cloudflare, you can obtain your API key from the bottom of the "API Tokens" page, found here: Go to My account.
Cloudflare makes sites lightning fast, protects them from attacks, ensures they are always online, and makes it simple to add web apps with a single click. Every month, more than 1.8 billion people experience a faster, safer, better Internet thanks to Cloudflare.
Cloudflare offers public APIs with three audiences in mind.
Customers: Individuals and organizations all over the world choose Cloudflare to protect and accelerate their web applications. Most customers manage their settings in the web dashboard, built using these APIs. Virtually anything you can do in the customer dashboard may be done via API. Example: purging the Cloudflare edge cache for a single file when it's updated on the origin server.
Partners: Many organizations make using Cloudflare a seamless option for improving their customers' performance and security. These APIs make that easier to do at scale. Example: a Cloudflare Certified Hosting Partner may use APIs to toggle basic security mode inside a hosting control panel.
Developers: Developers all over the world create useful applications which tie into Cloudflare services. These applications may include plugins and extensions to popular content management systems, apps that are offered in the Cloudflare Apps marketplace, runbooks for specific deployment systems, and many others.
Anything that's useful and follows the guidelines presented here.
Do not do any of the following:
Abuse: Follow all guidelines, including the rate limits defined below. Your ability to use the Cloudflare APIs may be terminated, temporarily or permanently, if our systems are abused. Similarly, anything in an application which goes against the goal of making Cloudflare more useful to Cloudflare customers or attempts to mistreat customers or their data will be grounds for termination.
Trademarks: Cloudflare has several registered trademarks. Details on how and when you may use Cloudflare trademarks are found at https://www.cloudflare.com/trademark, with links to specifics on logo use and spelling. Please review carefully.
Misrepresentation: Draw a clear line between the benefits you provide in your application and those benefits of the Cloudflare service that you enable via API. The APIs are not intended for "white labeling" or reselling Cloudflare services as your own. Nothing in your service or application should create a false sense of endorsement, sponsorship, or association with Cloudflare. You may sell your own application or service which utilizes the Cloudflare APIs, but may not sell Cloudflare services to customers without a commercial agreement with Cloudflare.
The full Cloudflare Terms of Use are found at https://www.cloudflare.com/terms.
The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH, and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.
Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. The latest version is Version 4.
The stable base URL for all Version 4 HTTPS endpoints is:
https://api.cloudflare.com/client/v4/
Requests must be sent over HTTPS with any payload formatted in JSON. Depending on if a request is authenticated with the new API Tokens or the old API Keys, required headers differ and are detailed below.
API Tokens provide a new way to authenticate with the Cloudflare API. They allow for scoped and permissioned access to resources and use the RFC compliant Authorization Bearer Token Header.
| Name | Format | Description |
|---|---|---|
| API Token | Authorization: Bearer <token> | API Token generated from the User Profile 'API Tokens' page |
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
-H "Content-Type:application/json" \
-H "Authorization: Bearer YQSn-xWAQiiEh9qM58wZNnyQS7FUdoqGIUAbrh7T"All requests must include both X-Auth-Key and X-Auth-Email headers to authenticate. Requests that use X-Auth-User-Service-Key can use that instead of the Auth-Key and Auth-Email headers.
| Name | Format | Description |
|---|---|---|
| API Key | X-Auth-Key | API key generated on the "My Account" page |
| X-Auth-Email | Email address associated with your account | |
| User Service Key | X-Auth-User-Service-Key | A special Cloudflare API key good for a restricted set of endpoints. Always begins with "v1.0-", may vary in length. |
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
-H "Content-Type:application/json" \
-H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
-H "X-Auth-Email:example@example.com"curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
-H "Content-Type:application/json" \
-H "X-Auth-User-Service-Key:v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"`| Name | Type | Description |
|---|---|---|
| page | integer | Which page of results to return |
| per_page | integer | How many results to return per page |
| order | string | Attribute name to order the responses by |
| direction | string | Either asc or desc |
GET zones/:zone_identifier/dns_records
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/dns_records?page=3&per_page=20&order=type&direction=asc" \
-H "Content-Type:application/json" \
-H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
-H "X-Auth-Email:example@example.com"Each response is a JSON object. The data requested is wrapped in the result tag. If you have a response, it will always be within the result field. We also include a success flag, an array of potential errors, and messages in the response. Some responses can have additional pagination info wrapped in the result_info
An error object will contain an integer code field and a message
Date fields will always be in UTC ISO-8601 format, including microseconds.
{
"result": {
"id":"2d4d028de3015345da9420df5514dad0",
"type":"A",
"name":"blog.example.com",
"content":"2.6.4.5",
"proxiable":true,
"proxied":false,
"ttl":1,
"priority":0,
"locked":false,
"zone_id":"cd7d068de3012345da9420df9514dad0",
"zone_name":"example.com",
"modified_on":"2014-05-28T18:46:18.764425Z",
"created_on":"2014-05-28T18:46:18.764425Z"
},
"success": true,
"errors": [],
"messages": [],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 200
}
}{
"result": null,
"success": false,
"errors": [{"code":1003,"message":"Invalid or missing zone id."}],
"messages": []
}| Content-Type | Description |
|---|---|
| application/json | response is a JSON object |
| text/plain | response is a textual item |
| application/x-yaml | response is a YAML object |
| application/octet-stream | response is a raw data (reserved for later use) |
| Code | Status | Description |
|---|---|---|
| 200 | OK | request successful |
| 304 | Not Modified | |
| 400 | Bad Request | request was invalid |
| 401 | Unauthorized | user does not have permission |
| 403 | Forbidden | request not authenticated |
| 429 | Too many requests | client is rate limited |
| 405 | Method Not Allowed | incorrect HTTP method provided |
| 415 | Unsupported Media Type | response is not valid JSON |
Nearly every resource in the v4 API (Users, Zones, Settings, Organizations, etc.) may be uniquely identified by a 32-byte string of hex characters ([a-f0-9]). These identifiers may be referred to in the documentation as zone_identifier, user_id, or even just id. Identifier values are usually captured during resource creation (POST requests) or when fetching entire collections (GET requests) of resources. Typically they appear as an id field in the JSON resource.
{
"result": {
"id":"2d4d028de3015345da9420df5514dad0",
"type":"example"
}
}You can always find the IDs for API resources by making a GET request to its corresponding collection endpoint. For example, to list all Zone objects, a GET request may be sent to https://api.cloudflare.com/client/v4/zones. All objects listed in the result array will contain an id field; this is also known as zone_identifier.
curl -X GET "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"curl -X GET "https://api.cloudflare.com/client/v4/user" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"first_name": "John",
"last_name": "Appleseed",
"username": "cfuser12345",
"telephone": "+1 123-123-1234",
"country": "US",
"zipcode": "12345",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"two_factor_authentication_enabled": false,
"suspended": false
}
}| Name /type | Description /example | Constraints |
| first_name stringnull | User's first name
|
|
| last_name stringnull | User's last name
|
|
| telephone stringnull | User's telephone number
|
|
| country stringnull | The country in which the user lives.
|
|
| zipcode stringnull | The zipcode or postal code where the user lives.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"first_name":"John","last_name":"Appleseed","telephone":"+1 123-123-1234","country":"US","zipcode":"12345"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"first_name": "John",
"last_name": "Appleseed",
"username": "cfuser12345",
"telephone": "+1 123-123-1234",
"country": "US",
"zipcode": "12345",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"two_factor_authentication_enabled": false,
"suspended": false
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/tokens?page=1&per_page=20&direction=desc" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
]
}| Name /type | Description /example | Constraints |
| name string | Token name
|
|
| policies array | List of access policies assigned to the token
|
| Name /type | Description /example | Constraints |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing
| |
| expires_on string (date-time) | The expiration time on or after which the JWT MUST NOT be accepted for processing
| |
| condition object | Defines the extra limitation on how and/or where the token can be used
|
curl -X POST "https://api.cloudflare.com/client/v4/user/tokens" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{"name":"readonly token","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
},
"value": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
}| Name /type | Description /example | Constraints |
| expires_on string (date-time) | The expiration time on or after which the JWT MUST NOT be accepted for processing
| |
| not_before string (date-time) | The time before which the token MUST NOT be accepted for processing
| |
| name string | Token name
|
|
| policies array | List of access policies assigned to the token
| |
| status string | Status of the token
|
|
| issued_on string (date-time) | The time on which the token was created
|
|
| modified_on string (date-time) | Last time the token was modified
|
|
| id string | Token identifier tag
|
|
| condition object | Defines the extra limitation on how and/or where the token can be used
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{"id":"ed17574386854bf78a67040be0a770b0","name":"readonly token","status":"active","issued_on":"2018-07-01T05:20:00Z","modified_on":"2018-07-02T05:20:00Z","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"name": "readonly token",
"status": "active",
"issued_on": "2018-07-01T05:20:00Z",
"modified_on": "2018-07-02T05:20:00Z",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"effect": "allow",
"resources": {
"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
},
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"name": "DNS Read"
}
]
}
],
"condition": {
"request.ip": {
"in": [
"199.27.128.0/21",
"2400:cb00::/32"
],
"not_in": [
"199.27.128.0/21",
"2400:cb00::/32"
]
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0/value" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
-H "Content-Type: application/json" \
--data '{}'{
"success": true,
"errors": [],
"messages": [],
"result": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ed17574386854bf78a67040be0a770b0",
"status": "active",
"not_before": "2018-07-01T05:20:00Z",
"expires_on": "2020-01-01T00:00:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/permission_groups" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "7cf72faf220841aabcfdfab81c43c4f6",
"name": "Billing Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "9d24387c6e8544e2bc4024a03991339f",
"name": "Load Balancing: Monitors and Pools Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "d2a1802cc9a34e30852f8b33869b2f3c",
"name": "Load Balancing: Monitors and Pools Write",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "8b47d2786a534c08a1f94ee8f9f599ef",
"name": "Workers KV Storage Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "f7f0eda5697f475c90846e879bab8666",
"name": "Workers KV Storage Write",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "1a71c399035b4950a1bd1466bbe4f420",
"name": "Workers Scripts Read",
"scopes": [
"com.cloudflare.api.account"
]
},
{
"id": "e086da7e2179491d91ee5f35b3ca210a",
"name": "Workers Scripts Write",
"scopes": [
"com.cloudflare.api.account"
]
}
]
}| Name /type | Description /example | Constraints |
| status string | Status of this membership
|
|
| account.name string | Account name
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of memberships per page
|
|
| order string | Field to order memberships by
|
|
| direction string | Direction to order memberships
|
|
curl -X GET "https://api.cloudflare.com/client/v4/memberships?status=accepted&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
}| Name /type | Description /example | Constraints |
| status string | Whether to accept or reject this account invitation
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"status":"accepted"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"status": "accepted",
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
},
"roles": [
"Account Administrator"
],
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa"
}
}| Code | Description |
| 1000 | An unknown error(<CODE>) has occurred |
| 1001 | Invalid request |
| 1002 | Forbidden |
| 1003 | Membership not found |
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
}| Name /type | Description /example | Constraints |
| id string | Account identifier tag
|
|
| name string | Account name
|
|
| settings object | Account settings
| |
| created_on string (date-time) | describes when account was created
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"01a7362d577a6c3019a474fd6f485823","name":"Demo Account","settings":{"enforce_twofactor":false},"created_on":"2014-03-01T12:21:02.0000Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account",
"settings": {
"enforce_twofactor": false
},
"created_on": "2014-03-01T12:21:02.0000Z"
}
}| Code | Description |
| 1000 | An unknown error(<CODE>) has occurred |
| 1001 | Invalid request |
| 1002 | Forbidden |
| 1003 | Account not found |
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
]
}| Name /type | Description /example | Constraints |
| email string | Your contact email address
|
|
| roles array | Array of roles associated with this member
|
| Name /type | Description /example | Constraints |
| status string | A member's status in the account
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"email":"user@example.com","status":"accepted","roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}| Name /type | Description /example | Constraints |
| id string | Membership identifier tag
|
|
| code string | The unique activation code for the account membership
|
|
| user object |
|
|
| status string | A member's status in the account
|
|
| roles array | Roles assigned to this member
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"4536bcfad5faccb111b47003c79917fa","code":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","user":{"id":"7c5dae5552338874e5053f2534d2767a","first_name":"John","last_name":"Appleseed","email":"user@example.com","two_factor_authentication_enabled":false},"status":"accepted","roles":[{"id":"3536bcfad5faccb999b47003c79917fb","name":"Account Administrator","description":"Administrative access to the entire Account","permissions":{"analytics":{"read":true,"write":true},"billing":{"read":true,"write":true},"cache_purge":{"read":true,"write":true},"dns":{"read":true,"write":true},"dns_records":{"read":true,"write":true},"lb":{"read":true,"write":true},"logs":{"read":true,"write":true},"organization":{"read":true,"write":true},"ssl":{"read":true,"write":true},"waf":{"read":true,"write":true},"zones":{"read":true,"write":true},"zone_settings":{"read":true,"write":true}}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4536bcfad5faccb111b47003c79917fa",
"code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"user": {
"id": "7c5dae5552338874e5053f2534d2767a",
"first_name": "John",
"last_name": "Appleseed",
"email": "user@example.com",
"two_factor_authentication_enabled": false
},
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Account Administrator",
"description": "Administrative access to the entire Account",
"permissions": {
"analytics": {
"read": true,
"write": true
},
"billing": {
"read": true,
"write": true
},
"cache_purge": {
"read": true,
"write": true
},
"dns": {
"read": true,
"write": true
},
"dns_records": {
"read": true,
"write": true
},
"lb": {
"read": true,
"write": true
},
"logs": {
"read": true,
"write": true
},
"organization": {
"read": true,
"write": true
},
"ssl": {
"read": true,
"write": true
},
"waf": {
"read": true,
"write": true
},
"zones": {
"read": true,
"write": true
},
"zone_settings": {
"read": true,
"write": true
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
]
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"members": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
],
"invites": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
],
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| name string | Organization Name
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Cloudflare, Inc."}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"members": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
],
"invites": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
],
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| invited_member_email string | Email address of the user to be added to the Organization
|
|
| roles array | Array of Roles associated with the invited user
|
| Name /type | Description /example | Constraints |
| auto_accept boolean | When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"invited_member_email":"user@example.com","roles":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"auto_accept":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with the invited user
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"organization_is_enforcing_twofactor": true,
"status": "accepted"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "4f5f0c14a2a41d5063dd301b2f829f04"
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| roles array | Array of Roles associated with this Member
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "7c5dae5552338874e5053f2534d2767a",
"name": "John Smith",
"email": "user@example.com",
"status": "accepted",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "7c5dae5552338874e5053f2534d2767a"
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/invites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
}| Name /type | Description /example | Constraints |
| status | Status of your response to the invitation (rejected or accepted)
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"status":"accepted"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4f5f0c14a2a41d5063dd301b2f829f04",
"invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
"invited_member_email": "user@example.com",
"organization_id": "5a7805061c76ada191ed06f989cc3dac",
"organization_name": "Cloudflare, Inc.",
"roles": [
{
"id": "3536bcfad5faccb999b47003c79917fb",
"name": "Organization Admin",
"description": "Administrative access to the entire Organization",
"permissions": [
"#zones:read"
]
}
],
"invited_by": "user@example.com",
"invited_on": "2014-01-01T05:20:00Z",
"expires_on": "2014-01-01T05:20:00Z",
"status": "accepted"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
| Name /type | Description /example | Constraints |
| status string | Whether or not the user is a member of the organization or has an inivitation pending
|
|
| name string | Organization Name
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of organizations per page
|
|
| order string | Field to order organizations by
|
|
| direction string | Direction to order organizations
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/organizations?status=member&name=Cloudflare, Inc.&page=1&per_page=20&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"status": "member",
"permissions": [
"#zones:read"
],
"roles": [
"All Privileges - Super Administrator"
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Cloudflare, Inc.",
"status": "member",
"permissions": [
"#zones:read"
],
"roles": [
"All Privileges - Super Administrator"
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "01a7362d577a6c3019a474fd6f485823"
}curl -X GET "https://api.cloudflare.com/client/v4/user/billing/profile" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0020c268dbf54e975e7fe8563df49d52",
"first_name": "Bob",
"last_name": "Smith",
"address": "123 3rd St.",
"address2": "Apt 123",
"company": "Cloudflare",
"city": "San Francisco",
"state": "CA",
"zipcode": "12345",
"country": "US",
"telephone": "+1 111-867-5309",
"card_number": "xxxx-xxxx-xxxx-1234",
"card_expiry_year": 2015,
"card_expiry_month": 4,
"vat": "aaa-123-987",
"edited_on": "2014-03-01T12:21:02.0000Z",
"created_on": "2014-03-01T12:21:02.0000Z"
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| order string | Field to order billing history by
|
|
| type string | The billing item type
|
|
| occured_at string (date-time) | When the billing item was created
|
|
| action string | The billing item action
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/billing/history?page=1&per_page=20&order=occured_at&type=charge&occured_at=2014-03-01T12:21:59.3456Z&action=subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "b69a9f3492637782896352daae219e7d",
"type": "charge",
"action": "subscription",
"description": "The billing item description",
"occurred_at": "2014-03-01T12:21:59.3456Z",
"amount": 20.99,
"currency": "USD",
"zone": {
"name": "example.com"
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/user/subscriptions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
]
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/billing/profile" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0020c268dbf54e975e7fe8563df49d52",
"first_name": "Bob",
"last_name": "Smith",
"address": "123 3rd St.",
"address2": "Apt 123",
"company": "Cloudflare",
"city": "San Francisco",
"state": "CA",
"zipcode": "12345",
"country": "US",
"telephone": "+1 111-867-5309",
"card_number": "xxxx-xxxx-xxxx-1234",
"card_expiry_year": 2015,
"card_expiry_month": 4,
"vat": "aaa-123-987",
"edited_on": "2014-03-01T12:21:02.0000Z",
"created_on": "2014-03-01T12:21:02.0000Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_rate_plans" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "free",
"name": "Free Plan",
"currency": "USD",
"duration": 1,
"frequency": "monthly",
"components": [
{
"name": "page_rules",
"default": 5,
"unit_price": 1
}
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "Free Plan",
"currency": "USD",
"frequency": "monthly",
"price": 0,
"is_subscribed": false,
"can_subscribe": true,
"legacy_id": "free",
"legacy_discount": false,
"externally_managed": false
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "Free Plan",
"currency": "USD",
"frequency": "monthly",
"price": 0,
"is_subscribed": false,
"can_subscribe": true,
"legacy_id": "free",
"legacy_discount": false,
"externally_managed": false
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}| Name /type | Description /example | Constraints |
| app |
| |
| current_period_end string (date-time) | The end of the current period, and also when the next billing is due
|
|
| component_values array | The list of add-ons subscribed to
| |
| rate_plan object | The rate plan applied to the subscription
| |
| price number | The price of the subscription that will be billed, in US dollars
|
|
| current_period_start string (date-time) | When the current billing period started, may be the same as InitialPeriodStart if this is the first period
|
|
| zone object | A simple zone object. May have null properties if not a zone subscription.
| |
| currency string | The monetary unit in which pricing information is displayed
|
|
| state string | The state that the subscription is in
|
|
| id string | Subscription identifier tag
|
|
| frequency string | How often the subscription is renewed automatically
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"app": {
"install_id": null
},
"id": "506e3185e9c882d175a2d0cb0093d9f2",
"state": "Paid",
"price": 20,
"currency": "USD",
"component_values": [
{
"name": "page_rules",
"value": 20,
"default": 5,
"price": 5
}
],
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"frequency": "monthly",
"rate_plan": {
"id": "free",
"public_name": "Business Plan",
"currency": "USD",
"scope": "zone",
"sets": [
{}
],
"is_contract": false,
"externally_managed": false
},
"current_period_end": "2014-03-31T12:20:00Z",
"current_period_start": "2014-05-11T12:20:00Z"
}
}| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| actor.email string (email) | Filter by the email address of the actor that made the change
| |
| zone.name string | Filter by the name of the zone associated to the change.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/user/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| actor.email string (email) | Filter by the email address of the actor that made the change
| |
| zone.name string | Filter by the name of the zone associated to the change.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| actor.ip string | Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range
| |
| actor.email string (email) | Filter by the email address of the actor that made the change
| |
| zone.name string | Filter by the name of the zone associated to the change.
| |
| page number | Which page of results to return.
|
|
| per_page number | How many results to return per page.
|
|
| action.type string | Filter by the action type.
| |
| export boolean | Indicates that this request is an export of logs in CSV format
|
|
| since string (date-time) | Limit the returned results to logs newer than the specified date. This can be a date string
| |
| id string | Find a specific log by its ID.
| |
| direction string | Change the direction of the chronological sorting.
|
|
| before string (date-time) | Limit the returned results to logs older than the specified date. This can be a date string
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": null,
"messages": [],
"result": [
{
"id": "d5b0f326-1232-4452-8858-1089bd7168ef",
"action": {
"type": "change_setting",
"result": true
},
"actor": {
"id": "f6b5de0326bb5182b8a4840ee01ec774",
"email": "michelle@example.com",
"type": "user",
"ip": "198.41.129.166"
},
"newValue": "low",
"oldValue": "high",
"owner": {
"id": "7c5dae5552338874e5053f2534d2767a"
},
"resource": {
"type": "zone",
"id": "023e105f4ecef8ad9ca31a8372d0c353"
},
"interface": "API",
"metadata": {
"zone_name": "example.com",
"type": "firewall",
"name": "security_level",
"value": "high"
},
"when": "2017-04-26T17:31:07Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "smart_routing",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}| Name /type | Description /example | Constraints |
| value string | Enablement of Argo smart routing
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "smart_routing",
"value": "on",
"editable": true,
"modified_on": "2019-02-20T22:37:07.107449Z"
}
}| Name /type | Description /example | Constraints |
| bins integer | Number of buckets latency is split into
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency?bins=3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"bins": 3,
"range": {
"min": 0,
"max": 2500
},
"time_range": {
"since": "2019-03-04T22:05:00Z",
"until": "2019-03-06T22:05:00Z"
},
"data": {
"labels": [
"without_argo",
"with_argo"
],
"counts": [
[
3306,
362,
1267
],
[
30685,
11775,
42169
]
],
"averages": [
192,
120
],
"percent_smart_routed": 42.5
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency/colos" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"type": "FeatureCollection",
"features": [
{
"properties": {
"code": "ATL",
"argo_req_count": 15644,
"pct_avg_change": -0.38009502863254624,
"no_argo_avg": 319.0564263322884,
"argo_avg": 197.78466483011937
},
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-84.44403,
33.640068
]
}
}
]
}
}| Name /type | Description /example | Constraints |
| match string | Whether to match all search requirements or at least one (any)
|
|
| name string (hostname) | A domain name
|
|
| account.name string | Account name
|
|
| order string | Field to order zones by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of zones per page
|
|
| status string | Status of the zone
|
|
| account.id string | Account identifier tag
|
|
| direction string | Direction to order zones
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones?name=example.com&status=active&account.id=01a7362d577a6c3019a474fd6f485823&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com",
"development_mode": 7200,
"original_name_servers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"original_registrar": "GoDaddy",
"original_dnshost": "NameCheap",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"activated_on": "2014-01-02T00:01:00.12345Z",
"owner": {
"id": {},
"email": {},
"type": "user"
},
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account"
},
"permissions": [
"#zone:read",
"#zone:edit"
],
"plan": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"plan_pending": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"status": "active",
"paused": false,
"type": "full",
"name_servers": [
"tony.ns.cloudflare.com",
"woz.ns.cloudflare.com"
]
}
]
}| Name /type | Description /example | Constraints |
| name string | The domain name
|
|
| account object | Account of which the zone is created in
|
| Name /type | Description /example | Constraints |
| jump_start boolean | Automatically attempt to fetch existing DNS records
|
|
| type string | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"example.com","account":{"id":"01a7362d577a6c3019a474fd6f485823"},"jump_start":true,"type":"full"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com",
"development_mode": 7200,
"original_name_servers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"original_registrar": "GoDaddy",
"original_dnshost": "NameCheap",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"activated_on": "2014-01-02T00:01:00.12345Z",
"owner": {
"id": {},
"email": {},
"type": "user"
},
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account"
},
"permissions": [
"#zone:read",
"#zone:edit"
],
"plan": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"plan_pending": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"status": "active",
"paused": false,
"type": "full",
"name_servers": [
"tony.ns.cloudflare.com",
"woz.ns.cloudflare.com"
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com",
"development_mode": 7200,
"original_name_servers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"original_registrar": "GoDaddy",
"original_dnshost": "NameCheap",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"activated_on": "2014-01-02T00:01:00.12345Z",
"owner": {
"id": {},
"email": {},
"type": "user"
},
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account"
},
"permissions": [
"#zone:read",
"#zone:edit"
],
"plan": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"plan_pending": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"status": "active",
"paused": false,
"type": "full",
"name_servers": [
"tony.ns.cloudflare.com",
"woz.ns.cloudflare.com"
]
}
}| Name /type | Description /example | Constraints |
| paused boolean | Indicates if the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits.
|
|
| vanity_name_servers array | An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
| |
| plan object | The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans
|
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"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com",
"development_mode": 7200,
"original_name_servers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"original_registrar": "GoDaddy",
"original_dnshost": "NameCheap",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"activated_on": "2014-01-02T00:01:00.12345Z",
"owner": {
"id": {},
"email": {},
"type": "user"
},
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Demo Account"
},
"permissions": [
"#zone:read",
"#zone:edit"
],
"plan": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"plan_pending": {
"id": "e592fd9519420ba7405e1307bff33214",
"name": "Pro Plan",
"price": 20,
"currency": "USD",
"frequency": "monthly",
"legacy_id": "pro",
"is_subscribed": true,
"can_subscribe": true
},
"status": "active",
"paused": false,
"type": "full",
"name_servers": [
"tony.ns.cloudflare.com",
"woz.ns.cloudflare.com"
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/activation_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| purge_everything | A flag that indicates all resources in Cloudflare's cache should be removed. Note: This may have dramatic affects on your origin server load after performing this action.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"purge_everything":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| files array | An array of URLs that should be removed from cache
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"files":["http://www.example.com/css/styles.css",{"url":"http://www.example.com/cat_picture.jpg","headers":{"Origin":"https://www.cloudflare.com","CF-IPCountry":"US","CF-Device-Type":"desktop"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| tags array | Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache
|
|
| hosts array | Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"tags":["some-tag","another-tag"],"hosts":["www.example.com","images.example.com"]}'{
"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', or 'hosts' |
| 1013 | 'purge_everything' must be true |
| 1014 | 'files', 'tags', or 'hosts' must be an array |
| 1015 | Unable to purge <url> |
| 1016 | Unable to purge any urls |
| 1017 | Unable to purge all |
| 1018 | Invalid zone status |
| 1019 | Zone is already paused |
| 1020 | Invalid or missing zone |
| 1021 | Invalid zone status |
| 1022 | Zone is already unpaused |
| 1023 | Invalid or missing zone |
| 1049 | <domain> is not a registered domain |
| 1050 | <domain> is currently being tasted. It is not currently a registered domain |
| 1051 | Cloudflare is already hosting <domain> |
| 1052 | An error has occurred and it has been logged. We will fix this problem promptly. We apologize for the inconvenience |
| 1055 | Failed to disable <domain> |
| 1056 | preserve_ini must be a boolean |
| 1057 | Zone must be in 'initializing' status |
| 1059 | Unable to delete zone |
| 1061 | <domain> already exists |
| 1064 | Not allowed to update zone step. Bad zone status |
| 1065 | Not allowed to update zone step. Zone has already been set up |
| 1066 | Could not promote zone to step 3 |
| 1067 | Invalid organization identifier passed in your organization variable |
| 1068 | Permission denied |
| 1069 | organization variable should be an organization object |
| 1070 | This operation requires a Business or Enterprise account. |
| 1071 | Vanity name server array expected. |
| 1073 | A name server provided is in the wrong format. |
| 1074 | Could not find a valid zone. |
| 1075 | Vanity name server array count is invalid |
| 1076 | Name servers have invalid IP addresses |
| 1077 | Could not find a valid zone. |
| 1078 | This zone has no valid vanity IPs. |
| 1079 | This zone has no valid vanity name servers. |
| 1080 | There is a conflict with one of the name servers. |
| 1081 | There are no valid vanity name servers to disable. |
| 1082 | Unable to purge '<url>'. You can only purge files for this zone |
| 1083 | Unable to purge '<url>'. Rate limit reached. Please wait if you need to perform more operations |
| 1084 | Unable to purge '<url>'. |
| 1085 | Only one property can be updated at a time |
| 1086 | Invalid property |
| 1088 | Invalid/Missing Zone plan ID |
| 1089 | Invalid/Missing Zone plan ID |
| 1092 | Request cannot contain 'purge_everything' and any of 'files', 'tags', or 'hosts' |
| 1094 | Exceeded maximum amount of 500 files that can be purged on a single request |
| 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 zone is banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support |
| 1098 | This zone is temporarily banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support |
| 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 zone is temporarily banned and cannot be added to Cloudflare at this time, please contact Cloudflare Support |
| 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 |
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/advanced_ddos" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "advanced_ddos",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "always_online",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_cache_ttl",
"value": 14400,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_check",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "cache_level",
"value": "aggressive",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "challenge_ttl",
"value": 1800,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "development_mode",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z",
"time_remaining": 3600
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "email_obfuscation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "hotlink_protection",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ip_geolocation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ipv6",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "minify",
"value": {
"css": "off",
"html": "off",
"js": "off"
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mobile_redirect",
"value": {
"status": "off",
"mobile_subdomain": "m",
"strip_uri": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mirage",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "opportunistic_encryption",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "polish",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "webp",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "brotli",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "privacy_pass",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "rocket_loader",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_header",
"value": {
"strict_transport_security": {
"enabled": true,
"max_age": 86400,
"include_subdomains": true,
"nosniff": true
}
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_level",
"value": "medium",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "server_side_exclude",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "1.0"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": []
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tls_client_auth",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "waf",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http2",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http3",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0rtt",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "pseudo_ipv4",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "websockets",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "image_resizing",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "h2_prioritization",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| items array | One or more zone setting objects. Must contain an ID and a value.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"items":[{"id":"always_online","value":"on"},{"id":"browser_cache_ttl","value":18000},{"id":"ip_geolocation","value":"off"}]}'{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "always_online",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value number | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":14400}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_cache_ttl",
"value": 14400,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "browser_check",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"aggressive"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "cache_level",
"value": "aggressive",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value number | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":1800}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "challenge_ttl",
"value": 1800,
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "development_mode",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z",
"time_remaining": 3600
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "email_obfuscation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "hotlink_protection",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ip_geolocation",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ipv6",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object | Value of the zone setting
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"css":"off","html":"off","js":"off"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "minify",
"value": {
"css": "off",
"html": "off",
"js": "off"
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object | Value of the zone setting
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"status":"off","mobile_subdomain":"m","strip_uri":false}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mobile_redirect",
"value": {
"status": "off",
"mobile_subdomain": "m",
"strip_uri": false
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "mirage",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "opportunistic_encryption",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "polish",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "webp",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "brotli",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "privacy_pass",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "rocket_loader",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value object |
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":{"strict_transport_security":{"enabled":true,"max_age":86400,"include_subdomains":true,"nosniff":true}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_header",
"value": {
"strict_transport_security": {
"enabled": true,
"max_age": 86400,
"include_subdomains": true,
"nosniff": true
}
},
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"medium"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "security_level",
"value": "medium",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "server_side_exclude",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ssl",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "tls_client_auth",
"value": "on",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"1.0"}'{
"success": true,
"errors": [],
"messages": [],
"result": "1.0"
}| Name /type | Description /example | Constraints |
| value array | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]}'{
"success": true,
"errors": [],
"messages": [],
"result": []
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": "off"
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "waf",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the HTTP2 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http2",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the HTTP3 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "http3",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the 0-RTT setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0rtt",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the Pseudo IPv4 setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "pseudo_ipv4",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "websockets",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Whether the feature is enabled, disabled, or enabled in 'open proxy' mode
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "image_resizing",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| value string | Value of the zone setting
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"value":"off"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "h2_prioritization",
"value": "off",
"editable": true,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}End of life Date: November 2, 2020
Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.
| Name /type | Description /example | Constraints |
| since stringinteger | The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. Ranges that the Cloudflare web application provides will provide the following period length for each point:
|
|
| until stringinteger | The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.
|
|
| continuous boolean | When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data. The API response may not represent the requested time window.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/dashboard?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"totals": {
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"requests": {
"all": 1234085328,
"cached": 1234085328,
"uncached": 13876154,
"content_type": {
"css": 15343,
"html": 1234213,
"javascript": 318236,
"gif": 23178,
"jpeg": 1982048
},
"country": {
"US": 4181364,
"AG": 37298,
"GI": 293846
},
"ssl": {
"encrypted": 12978361,
"unencrypted": 781263
},
"ssl_protocols": {
"TLSv1": 398232,
"TLSv1.1": 12532236,
"TLSv1.2": 2447136,
"TLSv1.3": 10483332,
"none": 781263
},
"http_status": {
"200": 13496983,
"301": 283,
"400": 187936,
"402": 1828,
"404": 1293
}
},
"bandwidth": {
"all": 213867451,
"cached": 113205063,
"uncached": 113205063,
"content_type": {
"css": 237421,
"html": 1231290,
"javascript": 123245,
"gif": 1234242,
"jpeg": 784278
},
"country": {
"US": 123145433,
"AG": 2342483,
"GI": 984753
},
"ssl": {
"encrypted": 37592942,
"unencrypted": 237654192
},
"ssl_protocols": {
"TLSv1": 398232,
"TLSv1.1": 12532236,
"TLSv1.2": 2447136,
"TLSv1.3": 10483332,
"none": 781263
}
},
"threats": {
"all": 23423873,
"country": {
"US": 123,
"CN": 523423,
"AU": 91
},
"type": {
"user.ban.ip": 123,
"hot.ban.unknown": 5324,
"macro.chl.captchaErr": 1341,
"macro.chl.jschlErr": 5323
}
},
"pageviews": {
"all": 5724723,
"search_engine": {
"googlebot": 35272,
"pingdom": 13435,
"bingbot": 5372,
"baidubot": 1345
}
},
"uniques": {
"all": 12343
}
},
"timeseries": [
{
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"requests": {
"all": 1234085328,
"cached": 1234085328,
"uncached": 13876154,
"content_type": {
"css": 15343,
"html": 1234213,
"javascript": 318236,
"gif": 23178,
"jpeg": 1982048
},
"country": {
"US": 4181364,
"AG": 37298,
"GI": 293846
},
"ssl": {
"encrypted": 12978361,
"unencrypted": 781263
},
"ssl_protocols": {
"TLSv1": 398232,
"TLSv1.1": 12532236,
"TLSv1.2": 2447136,
"TLSv1.3": 10483332,
"none": 781263
},
"http_status": {
"200": 13496983,
"301": 283,
"400": 187936,
"402": 1828,
"404": 1293
}
},
"bandwidth": {
"all": 213867451,
"cached": 113205063,
"uncached": 113205063,
"content_type": {
"css": 237421,
"html": 1231290,
"javascript": 123245,
"gif": 1234242,
"jpeg": 784278
},
"country": {
"US": 123145433,
"AG": 2342483,
"GI": 984753
},
"ssl": {
"encrypted": 37592942,
"unencrypted": 237654192
},
"ssl_protocols": {
"TLSv1": 398232,
"TLSv1.1": 12532236,
"TLSv1.2": 2447136,
"TLSv1.3": 10483332,
"none": 781263
}
},
"threats": {
"all": 23423873,
"country": {
"US": 123,
"CN": 523423,
"AU": 91
},
"type": {
"user.ban.ip": 123,
"hot.ban.unknown": 5324,
"macro.chl.captchaErr": 1341,
"macro.chl.jschlErr": 5323
}
},
"pageviews": {
"all": 5724723,
"search_engine": {
"googlebot": 35272,
"pingdom": 13435,
"bingbot": 5372,
"baidubot": 1345
}
},
"uniques": {
"all": 12343
}
}
]
},
"query": {
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"time_delta": 60
}
}End of life Date: November 2, 2020
Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.
| Name /type | Description /example | Constraints |
| since stringinteger | The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. Ranges that the Cloudflare web application provides will provide the following period length for each point:
|
|
| until stringinteger | The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.
|
|
| continuous boolean | When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data. The API response may not represent the requested time window.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/colos?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"colo_id": "SFO",
"timeseries": [
{
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"requests": {
"all": 1234085328,
"cached": 1234085328,
"uncached": 13876154,
"country": {
"US": 4181364,
"AG": 37298,
"GI": 293846
},
"http_status": {
"200": 13496983,
"301": 283,
"400": 187936,
"402": 1828,
"404": 1293
}
},
"bandwidth": {
"all": 213867451,
"cached": 113205063,
"uncached": 113205063
},
"threats": {
"all": 23423873,
"country": {
"US": 123,
"CN": 523423,
"AU": 91
},
"type": {
"user.ban.ip": 123,
"hot.ban.unknown": 5324,
"macro.chl.captchaErr": 1341,
"macro.chl.jschlErr": 5323
}
}
}
],
"totals": {
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"requests": {
"all": 1234085328,
"cached": 1234085328,
"uncached": 13876154,
"country": {
"US": 4181364,
"AG": 37298,
"GI": 293846
},
"http_status": {
"200": 13496983,
"301": 283,
"400": 187936,
"402": 1828,
"404": 1293
}
},
"bandwidth": {
"all": 213867451,
"cached": 113205063,
"uncached": 113205063
},
"threats": {
"all": 23423873,
"country": {
"US": 123,
"CN": 523423,
"AU": 91
},
"type": {
"user.ban.ip": 123,
"hot.ban.unknown": 5324,
"macro.chl.captchaErr": 1341,
"macro.chl.jschlErr": 5323
}
}
}
}
],
"query": {
"since": "2015-01-01T12:23:00Z",
"until": "2015-01-02T12:23:00Z",
"time_delta": 60
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"flag": true
}
}| Name /type | Description /example | Constraints |
| flag boolean | The log retention flag for Logpull API.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"flag":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"flag": true
}
}| Name /type | Description /example | Constraints |
| start stringinteger | The (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than 7 days.
| |
| end stringinteger | The (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339.
|
| Name /type | Description /example | Constraints |
| count integer | When
|
|
| sample number | When
|
|
| fields string | The
| |
| timestamps string | By default timestamps in responses are returned as Unix nanosecond integers. The
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/received?start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z&count=7&sample=0.1&fields=ClientIP,RayID,EdgeStartTimestamp×tamps=unixnano" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}| Name /type | Description /example | Constraints |
| fields string | The
| |
| timestamps string | By default timestamps in responses are returned as Unix nanosecond integers. The
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/rayids/41ddf1740f67442d?fields=ClientIP,RayID,EdgeStartTimestamp×tamps=unixnano" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":,1526810289280000000}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/received/fields" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"key": "value"
}If there is an error processing the request before any data has been sent to the client, appropriate status code will be set and error message will be sent in the response body. If there is an error after the response started then an error message will be appended to the response body and the response will be aborted (connection will be closed).
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"enabled": false,
"name": "example.com",
"dataset": "http_requests",
"logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339",
"destination_conf": "s3://mybucket/logs?region=us-west-2",
"last_complete": null,
"last_error": null,
"error_message": null
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/datasets/http_requests/jobs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"enabled": false,
"name": "example.com",
"dataset": "http_requests",
"logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339",
"destination_conf": "s3://mybucket/logs?region=us-west-2",
"last_complete": null,
"last_error": null,
"error_message": null
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/datasets/http_requests/fields" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| destination_conf string (uri) | Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/ownership" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"destination_conf":"s3://mybucket/logs?region=us-west-2"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"filename": "logs/challenge-filename.txt",
"valid": true,
"message": ""
}
}| Name /type | Description /example | Constraints |
| destination_conf string (uri) | Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
| ownership_challenge string | Ownership challenge token to prove destination ownership.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/ownership/validate" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"valid": true
}
}| Name /type | Description /example | Constraints |
| logpull_options stringnull (uri) | Configuration string for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api here, and logpush will keep on making this call for you, setting start and end times appropriately.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/validate/origin" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"valid": true,
"message": ""
}
}| Name /type | Description /example | Constraints |
| destination_conf string (uri) | Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
| ownership_challenge string | Ownership challenge token to prove destination ownership.
|
|
| Name /type | Description /example | Constraints |
| name stringnull | Optional human readable job name. Not unique. Makes it easier for humans to identify a job. Suggest that it include the zone name.
|
|
| enabled boolean |
|
|
| dataset stringnull | Dataset to be pulled.
|
|
| logpull_options stringnull (uri) | Configuration string for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api here, and logpush will keep on making this call for you, setting start and end times appropriately.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"example.com","enabled":false,"dataset":"http_requests","logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339","destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1,
"enabled": false,
"name": "example.com",
"dataset": "http_requests",
"logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339",
"destination_conf": "s3://mybucket/logs?region=us-west-2",
"last_complete": null,
"last_error": null,
"error_message": null
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1,
"enabled": false,
"name": "example.com",
"dataset": "http_requests",
"logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339",
"destination_conf": "s3://mybucket/logs?region=us-west-2",
"last_complete": null,
"last_error": null,
"error_message": null
}
}| Name /type | Description /example | Constraints |
| enabled boolean |
|
|
| logpull_options stringnull (uri) | Configuration string for the logshare api. It specifies things like requested fields and timestamp formats. Copy the url (full url or just the query string) of your call to the logshare api here, and logpush will keep on making this call for you, setting start and end times appropriately.
|
|
| destination_conf string (uri) | Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
| ownership_challenge string | Ownership challenge token to prove destination ownership.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":false,"logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339","destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1,
"enabled": false,
"name": "example.com",
"dataset": "http_requests",
"logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339",
"destination_conf": "s3://mybucket/logs?region=us-west-2",
"last_complete": null,
"last_error": null,
"error_message": null
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {}
}| Name /type | Description /example | Constraints |
| destination_conf string (uri) | Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/validate/destination/exists" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"destination_conf":"s3://mybucket/logs?region=us-west-2"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"exists": false
}
}| Code | Description |
| 1000 | Not Found |
| 1001 | Internal Server Error |
| 1002 | Bad Request |
| 1003 | Request Entity Too Large |
| Name /type | Description /example | Constraints |
| type string | DNS record type
|
|
| name string | DNS record name
|
|
| content string | DNS record content
| |
| page number | Page number of paginated results
|
|
| per_page number | Number of DNS records per page
|
|
| order string | Field to order records by
|
|
| direction string | Direction to order domains
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records?type=A&name=example.com&content=127.0.0.1&page=1&per_page=20&order=type&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "example.com",
"content": "198.51.100.4",
"proxiable": true,
"proxied": false,
"ttl": 120,
"locked": false,
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"zone_name": "example.com",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"data": {},
"meta": {
"auto_added": true,
"source": "primary"
}
}
]
}| Name /type | Description /example | Constraints |
| type string | DNS record type
|
|
| name string | DNS record name
|
|
| content string | DNS record content
| |
| ttl number | Time to live for DNS record. Value of 1 is 'automatic'
|
| Name /type | Description /example | Constraints |
| priority number | Used with some records like MX and SRV to determine priority. If you do not supply a priority for an MX record, a default value of 0 will be set
|
|
| proxied boolean | Whether the record is receiving the performance and security benefits of Cloudflare
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":120,"priority":10,"proxied":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "example.com",
"content": "198.51.100.4",
"proxiable": true,
"proxied": false,
"ttl": 120,
"locked": false,
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"zone_name": "example.com",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"data": {},
"meta": {
"auto_added": true,
"source": "primary"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "example.com",
"content": "198.51.100.4",
"proxiable": true,
"proxied": false,
"ttl": 120,
"locked": false,
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"zone_name": "example.com",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"data": {},
"meta": {
"auto_added": true,
"source": "primary"
}
}
}| Name /type | Description /example | Constraints |
| type string | DNS record type
|
|
| name string | DNS record name
|
|
| content string | DNS record content
| |
| ttl number | Time to live for DNS record. Value of 1 is 'automatic'
|
| Name /type | Description /example | Constraints |
| proxied boolean | Whether the record is receiving the performance and security benefits of Cloudflare
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":120,"proxied":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "example.com",
"content": "198.51.100.4",
"proxiable": true,
"proxied": false,
"ttl": 120,
"locked": false,
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"zone_name": "example.com",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"data": {},
"meta": {
"auto_added": true,
"source": "primary"
}
}
}| Name /type | Description /example | Constraints |
| type string | DNS record type
|
|
| name string | DNS record name
|
|
| content string | DNS record content
| |
| ttl number | Time to live for DNS record. Value of 1 is 'automatic'
| |
| proxied boolean | Whether the record is receiving the performance and security benefits of Cloudflare
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":120,"proxied":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "example.com",
"content": "198.51.100.4",
"proxiable": true,
"proxied": false,
"ttl": 120,
"locked": false,
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"zone_name": "example.com",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"data": {},
"meta": {
"auto_added": true,
"source": "primary"
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59"
}
}| Name /type | Description /example | Constraints |
| file string | BIND config to upload
|
| Name /type | Description /example | Constraints |
| proxied boolean | Whether or not proxiable records should receive the performance and security benefits of Cloudflare
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/import" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
--form 'file=@bind_config.txt' \
--form 'proxied=false'{
"success": true,
"errors": [],
"messages": [],
"result": {
"recs_added": 5,
"total_records_parsed": 5
},
"timing": {
"start_time": "2014-03-01T12:20:00Z",
"end_time": "2014-03-01T12:20:01Z",
"process_time": 1
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/export" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{}| Code | Description |
| 1000 | Invalid user |
| 1002 | Invalid or missing zone_id |
| 1003 | per_page must be a positive integer |
| 1004 | Invalid or missing zone |
| 1005 | Invalid or missing record |
| 1007 | name required |
| 1008 | content required |
| 1009 | Invalid or missing record id |
| 1010 | Invalid or missing record |
| 1011 | Zone file for '<domain name>' could not be found |
| 1012 | Zone file for '<domain name>' is not modifiable |
| 1013 | The record could not be found |
| 1014 | You do not have permission to modify this zone |
| 1015 | Unknown error |
| 1017 | Content for A record is invalid. Must be a valid IPv4 address |
| 1018 | Content for AAAA record is invalid. Must be a valid IPv6 address |
| 1019 | Content for CNAME record is invalid |
| 1024 | Invalid priority, priority must be set and be between 0 and 65535 |
| 1025 | Invalid content for an MX record |
| 1026 | Invalid format for a SPF record. A valid example is 'v=spf1 a mx -all'. You should not include either the word TXT or the domain name here in the content |
| 1027 | Invalid service value |
| 1028 | Invalid service value. Must be less than 100 characters |
| 1029 | Invalid protocol value |
| 1030 | Invalid protocol value. Must be less than 12 characters |
| 1031 | Invalid SRV name |
| 1032 | Invalid SRV name. Must be less than 90 characters |
| 1033 | Invalid weight value. Must be between 0 and 65,535 |
| 1034 | Invalid port value. Must be between 0 and 65,535 |
| 1037 | Invalid domain name for a SRV target host |
| 1038 | Invalid DNS record type |
| 1039 | Invalid TTL. Must be between 120 and 4,294,967,295 seconds, or 1 for automatic |
| 1041 | Priority must be set for SRV record |
| 1042 | Zone file for '<domain name>' could not be found |
| 1043 | Zone file for '<domain name>' is not editable |
| 1044 | A record with these exact values already exists. Please modify or remove this record |
| 1045 | The record could not be found |
| 1046 | A record with these exact values already exists. Please modify or cancel this edit |
| 1047 | You do not have permission to modify this zone |
| 1048 | You have reached the record limit for this zone |
| 1049 | The record content is missing |
| 1050 | Could not find record |
| 1052 | You can not point a CNAME to itself |
| 1053 | Invalid lat_degrees, must be an integer between 0 and 90 inclusive |
| 1054 | Invalid lat_minutes, must be an integer between 0 and 59 inclusive |
| 1055 | Invalid lat_seconds, must be a floating point number between 0 and 60, including 0 but not including 60 |
| 1056 | Invalid or missing lat_direction. Values must be N or S |
| 1057 | Invalid long_degrees, must be an integer between 0 and 180 |
| 1058 | Invalid long_minutes, must be an integer between 0 and 59 |
| 1059 | Invalid long_seconds, must be a floating point number between 0 and 60, including 0 but not including 60 |
| 1060 | Invalid or missing long_direction. Values must be E or S |
| 1061 | Invalid altitude, must be a floating point number between -100000.00 and 42849672.95 |
| 1062 | Invalid size, must be a floating point number between 0 and 90000000.00 |
| 1063 | Invalid precision_horz, must be a floating point number between 0 and 90000000.00 |
| 1064 | Invalid precision_vert, must be a floating point number between 0 and 90000000.00 |
| 1065 | Invalid or missing data for <type> record |
| 1067 | Invalid content for a NS record |
| 1068 | Target cannot be an IP address |
| 1069 | CNAME content cannot reference itself |
| 1070 | CNAME content cannot be an IP |
| 1071 | Invalid proxied mode. Record cannot be proxied |
| 1072 | Invalid record identifier |
| 1073 | Invalid TXT record. Must be less than 255 characters |
| 1074 | Invalid TXT record. Record may only contain printable ASCII! |
| If a zone's cname_setup_status is TRUE, you may only add A/AAAA and CNAME records for that zone |
| When adding a CNAME record, it will not be added if there is an A or AAAA record with the same name |
| When adding a A or AAAA record, it will not be added if there is an CNAME record with the same name |
| A CNAME record's name may not match it's content |
| You cannot add an NS record with the same name as any other record type |
| You cannot add a record with the same name as any NS record |
| Cloudflare will not begin serving DNS for a zone until the zone's nameservers are switched to Cloudflare nameservers at the zone's registrar |
| DNS will continue to be served by Cloudflare for 20 days after a zone's nameservers are switched away from Cloudflare namservers |
| When using unicode characters in domain names, they will be translated to punycode and as such, the length may end up being larger than what is passed into the API |
A metric is a numerical value that is based on an attribute of the data, for example a query count.
In API requests, metrics are set in the metrics parameter. If you need to list multiple metrics, separate them with commas.
| Metric | Name | Example | Unit |
|---|---|---|---|
| queryCount | Query count | 1000 | Count |
| uncachedCount | Uncached query count | 1 | Count |
| staleCount | Stale query count | 1 | Count |
| responseTimeAvg | Average response time | 1.0 | Time in milliseconds. |
| responseTimeMedian | Median response time | 1.0 | Time in milliseconds. |
| responseTime90th | 90th percentile response time | 1.0 | Time in milliseconds. |
| responseTime99th | 99th percentile response time | 1.0 | Time in milliseconds. |
Dimensions can be used to break down the data by given attributes.
In API requests, dimensions are set in the dimensions parameter. If you need to list multiple dimensions, separate them with commas.
| Dimension | Name | Example | Notes |
|---|---|---|---|
| queryName | Query Name | example.com | |
| queryType | Query Type | AAAA | Types defined by IANA, unknown types are empty. |
| responseCode | Response Code | NOERROR | Response codes defined by IANA (always uppercase). |
| responseCached | Response Cached | Cached | Either Cached or Uncached. |
| coloName | Colo Name | SJC | PoP code. |
| origin | Origin | 2001:db8::1 | Origin used to resolve the query (empty if N/A or if the query was answered from cache). |
| dayOfWeek | Day Of Week | 1 | Break down by day of week, (Monday is 1, and Sunday is 7). |
| tcp | TCP | 1 | Either 1 or 0 depending on the protocol used. |
| ipVersion | IP Version | 6 | IP protocol version used (currently 4 or 6). |
| querySizeBucket | Query Size Bucket | 16-31 | Query size bucket by multiples of 16. |
| responseSizeBucket | Response Size Bucket | 16-31 | Response size bucket by multiples of 16. |
A filter uses the form: dimension operator expression
In this syntax:
queryName| Operator | Name | Example | Notes | URL Encoded |
|---|---|---|---|---|
== | Equals | queryName==example.com | Return results where queryName is exactly example.com | %3D%3D |
!= | Does not equal | responseCode!=NOERROR | Return results where response code is different from NOERROR. | !%3D |
> | Greater than | queryCount>1000 | Return results where query count is higher than 1000 | %3E |
< | Less than | queryCount<1000 | Return results where query count is lower than 1000 | %3C |
>= | Greater than or equal to | queryCount>=1000 | Return results where query count is higher than or equal to 1000 | %3E%3D |
<= | Less than or equal to | queryCount<=1000 | Return results where query count is lower than or equal to 1000 | %3C%3D |
Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions.
The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace.
Examples:
NOERROR or NXDOMAIN: responseCode==NOERROR,responseCode==NXDOMAINSJC or LAX: coloName==SJC OR coloName==LAXThe AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace.
Examples:
NOERROR and query type is AAAA: responseCode==NOERROR;queryType==AAAAAAAA queries in SJC: queryType==AAAA AND coloName==SJC| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
|
| Name /type | Description /example | Constraints |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| limit integer | Limit number of returned metrics, default is 100
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
| |
| limit integer | Limit number of returned metrics, default is 100
| |
| time_delta | Unit of time to group data by
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report/bytime?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100&time_delta=hour" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"status": "active",
"flags": 257,
"algorithm": "13",
"key_type": "ECDSAP256SHA256",
"digest_type": "2",
"digest_algorithm": "SHA256",
"digest": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"ds": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"key_tag": 42,
"public_key": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==",
"modified_on": "2014-01-01T05:20:00Z"
}
}| Name /type | Description /example | Constraints |
| status | Status of DNSSEC, based on user-desired state and presence of necessary records
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"status":"active"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"status": "active",
"flags": 257,
"algorithm": "13",
"key_type": "ECDSAP256SHA256",
"digest_type": "2",
"digest_algorithm": "SHA256",
"digest": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"ds": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"key_tag": 42,
"public_key": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==",
"modified_on": "2014-01-01T05:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"status": "active",
"flags": 257,
"algorithm": "13",
"key_type": "ECDSAP256SHA256",
"digest_type": "2",
"digest_algorithm": "SHA256",
"digest": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"ds": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
"key_tag": 42,
"public_key": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==",
"modified_on": "2014-01-01T05:20:00Z"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/virtual_dns" \
-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": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| name string | DNS Firewall Cluster Name
|
|
| origin_ips array |
|
| Name /type | Description /example | Constraints |
| minimum_cache_ttl number | Minimum DNS Cache TTL
|
|
| maximum_cache_ttl number | Maximum DNS Cache TTL
|
|
| deprecate_any_requests boolean | Deprecate the response to ANY requests
|
|
| ecs_fallback boolean | Forward client IP (resolver) subnet if no EDNS Client Subnet is sent
|
|
| ratelimit number | Ratelimit in queries per second.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/virtual_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/virtual_dns/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": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| name string | DNS Firewall Cluster Name
|
|
| origin_ips array |
| |
| minimum_cache_ttl number | Minimum DNS Cache TTL
|
|
| maximum_cache_ttl number | Maximum DNS Cache TTL
|
|
| deprecate_any_requests boolean | Deprecate the response to ANY requests
|
|
| ecs_fallback boolean | Forward client IP (resolver) subnet if no EDNS Client Subnet is sent
|
|
| ratelimit number | Ratelimit in queries per second.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/virtual_dns/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"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| virtual_dns_ips array |
| |
| deprecate_any_requests boolean | Deprecate the response to ANY requests
|
|
| name string | DNS Firewall Cluster Name
|
|
| ecs_fallback boolean | Forward client IP (resolver) subnet if no EDNS Client Subnet is sent
|
|
| maximum_cache_ttl number | Maximum DNS Cache TTL
|
|
| origin_ips array |
| |
| modified_on string (date-time) | Last modification of DNS Firewall cluster
|
|
| id string | API item identifier tag
|
|
| ratelimit number | Ratelimit in queries per second.
|
|
| minimum_cache_ttl number | Minimum DNS Cache TTL
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"9a7806061c88ada191ed06f989cc3dac","name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"virtual_dns_ips":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600,"modified_on":"2014-01-01T05:20:00.12345Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| name string | DNS Firewall Cluster Name
|
|
| origin_ips array |
|
| Name /type | Description /example | Constraints |
| minimum_cache_ttl number | Minimum DNS Cache TTL
|
|
| maximum_cache_ttl number | Maximum DNS Cache TTL
|
|
| deprecate_any_requests boolean | Deprecate the response to ANY requests
|
|
| ecs_fallback boolean | Forward client IP (resolver) subnet if no EDNS Client Subnet is sent
|
|
| ratelimit number | Ratelimit in queries per second.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"name": "My Awesome DNS Firewall cluster",
"origin_ips": [
"192.0.2.1",
"198.51.100.1",
"2001:DB8:100::CF"
],
"virtual_dns_ips": [
"203.0.113.1",
"203.0.113.254",
"2001:DB8:AB::CF",
"2001:DB8:CD::CF"
],
"minimum_cache_ttl": 60,
"maximum_cache_ttl": 900,
"deprecate_any_requests": true,
"ecs_fallback": false,
"ratelimit": 600,
"modified_on": "2014-01-01T05:20:00.12345Z"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
|
| Name /type | Description /example | Constraints |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| limit integer | Limit number of returned metrics, default is 100
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/9a7806061c88ada191ed06f989cc3dac/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
| |
| limit integer | Limit number of returned metrics, default is 100
| |
| time_delta | Unit of time to group data by
|
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/9a7806061c88ada191ed06f989cc3dac/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report/bytime?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100&time_delta=hour" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
|
| Name /type | Description /example | Constraints |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| limit integer | Limit number of returned metrics, default is 100
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}| Name /type | Description /example | Constraints |
| dimensions array | Array of dimensions
| |
| metrics array | Array of metrics
| |
| sort array | Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)
| |
| filters string | Segmentation filter in 'attribute operator value' format
| |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
| |
| limit integer | Limit number of returned metrics, default is 100
| |
| time_delta | Unit of time to group data by
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report/bytime?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100&time_delta=hour" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 100,
"totals": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"min": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"max": {
"queryCount": 1000,
"responseTimeAvg": 1
},
"data_lag": 60
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "269d8f4853475ca241c4e730be286b20",
"name": "www.example.com.",
"masters": [
"23ff594956f20c2a721606e94745a8aa",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"auto_refresh_seconds": 86400,
"soa_serial": 2019102400,
"created_time": "2019-10-24T17:09:42.883908+01:00",
"checked_time": "2019-10-24T17:09:42.883908+01:00",
"modified_time": "2019-10-24T17:09:42.883908+01:00"
}
}| Name /type | Description /example | Constraints |
| id string | API item identifier tag
|
|
| name string | zone name
| |
| masters array | A list of master tags
| |
| auto_refresh_seconds number | How often should it auto refresh regardless of DNS notify
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"269d8f4853475ca241c4e730be286b20","name":"www.example.com.","masters":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"auto_refresh_seconds":86400}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "269d8f4853475ca241c4e730be286b20",
"name": "www.example.com.",
"masters": [
"23ff594956f20c2a721606e94745a8aa",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"auto_refresh_seconds": 86400,
"soa_serial": 2019102400,
"created_time": "2019-10-24T17:09:42.883908+01:00",
"checked_time": "2019-10-24T17:09:42.883908+01:00",
"modified_time": "2019-10-24T17:09:42.883908+01:00"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "269d8f4853475ca241c4e730be286b20"
}
}| Name /type | Description /example | Constraints |
| id string | API item identifier tag
|
|
| name string | zone name
| |
| masters array | A list of master tags
| |
| auto_refresh_seconds number | How often should it auto refresh regardless of DNS notify
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"269d8f4853475ca241c4e730be286b20","name":"www.example.com.","masters":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"auto_refresh_seconds":86400}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "269d8f4853475ca241c4e730be286b20",
"name": "www.example.com.",
"masters": [
"23ff594956f20c2a721606e94745a8aa",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"auto_refresh_seconds": 86400,
"soa_serial": 2019102400,
"created_time": "2019-10-24T17:09:42.883908+01:00",
"checked_time": "2019-10-24T17:09:42.883908+01:00",
"modified_time": "2019-10-24T17:09:42.883908+01:00"
}
}curl -X POST "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns/force_axfr" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": "OK"
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "69cd1e104af3e6ed3cb344f263fd0d5a",
"name": "tsig.customer.cf.",
"secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
"algo": "hmac-sha512."
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "69cd1e104af3e6ed3cb344f263fd0d5a",
"name": "tsig.customer.cf.",
"secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
"algo": "hmac-sha512."
}
}| Name /type | Description /example | Constraints |
| id string | API item identifier tag
|
|
| name string | TSIG key name
| |
| secret string | TSIG secret
| |
| algo string | TSIG algorithm
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"69cd1e104af3e6ed3cb344f263fd0d5a","name":"tsig.customer.cf.","secret":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","algo":"hmac-sha512."}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "69cd1e104af3e6ed3cb344f263fd0d5a",
"name": "tsig.customer.cf.",
"secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
"algo": "hmac-sha512."
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}
}| Name /type | Description /example | Constraints |
| name string | TSIG key name
| |
| secret string | TSIG secret
| |
| algo string | TSIG algorithm
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"tsig.customer.cf.","secret":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","algo":"hmac-sha512."}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "69cd1e104af3e6ed3cb344f263fd0d5a",
"name": "tsig.customer.cf.",
"secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
"algo": "hmac-sha512."
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/masters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "23ff594956f20c2a721606e94745a8aa",
"ip": "192.0.2.53",
"port": 53,
"ixfr_enable": false,
"tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/masters/23ff594956f20c2a721606e94745a8aa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "23ff594956f20c2a721606e94745a8aa",
"ip": "192.0.2.53",
"port": 53,
"ixfr_enable": false,
"tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}
}| Name /type | Description /example | Constraints |
| id string | API item identifier tag
|
|
| ip string | IPv4/IPv6 address of master nameserver
| |
| port number | DNS port of master nameserver
|
| Name /type | Description /example | Constraints |
| ixfr_enable boolean | Enable IXFR transfer protocol, default is AXFR
|
|
| tsig_id string | TSIG authentication will be used for zone transfer if configured
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/masters/23ff594956f20c2a721606e94745a8aa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"23ff594956f20c2a721606e94745a8aa","ip":"192.0.2.53","port":53,"ixfr_enable":false,"tsig_id":"69cd1e104af3e6ed3cb344f263fd0d5a"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "23ff594956f20c2a721606e94745a8aa",
"ip": "192.0.2.53",
"port": 53,
"ixfr_enable": false,
"tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/masters/23ff594956f20c2a721606e94745a8aa" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "23ff594956f20c2a721606e94745a8aa"
}
}| Name /type | Description /example | Constraints |
| ip string | IPv4/IPv6 address of master nameserver
| |
| port number | DNS port of master nameserver
|
| Name /type | Description /example | Constraints |
| ixfr_enable boolean | Enable IXFR transfer protocol, default is AXFR
|
|
| tsig_id string | TSIG authentication will be used for zone transfer if configured
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/masters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"ip":"192.0.2.53","port":53,"ixfr_enable":false,"tsig_id":"69cd1e104af3e6ed3cb344f263fd0d5a"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "23ff594956f20c2a721606e94745a8aa",
"ip": "192.0.2.53",
"port": 53,
"ixfr_enable": false,
"tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}
}curl -X GET "https://api.cloudflare.com/client/v4/ips"
{
"success": true,
"errors": [],
"messages": [],
"result": {
"ipv4_cidrs": [
"199.27.128.0/21"
],
"ipv6_cidrs": [
"2400:cb00::/32"
],
"etag": "a8e453d9d129a3769407127936edfdb0"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages/basic_challenge" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
}| Name /type | Description /example | Constraints |
| url string (url) | A URL that is associated with the Custom Page.
|
|
| state string | The Custom Page state
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages/basic_challenge" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"url":"http://www.example.com","state":"default"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
}| Code | Description |
| 1000 | Invalid user |
| 1001 | Invalid request. Could not connect to database |
| 1002 | Validator dispatcher expects an array |
| 1004 | Cannot find a valid zone |
| 1006 | Cannot find a valid customization page |
| 1007 | Invalid validation method being called |
| 1200 | A URL is required |
| 1201 | The URL provided seems to be irregular |
| 1202 | Unable to grab the content for the URL provided. Please try again. |
| 1203 | Your custom page must be larger than <characters> characters |
| 1204 | Your custom page must be smaller than <characters> characters |
| 1205 | A <token> token was not detected on the error page, and must be added before this page can be integrated into Cloudflare. The default error page will show until this is corrected and rescanned. |
| 1206 | Could not find a valid zone |
| 1207 | That customization page is not modifiable |
| 1208 | An unknown error has occurred and has been logged. We will fix this problem promptly. We apologize for the inconvenience. |
| 1209 | Could not find a valid customization page for this operation |
| 1210 | That operation is no longer allowed for that domain. |
| 1211 | Could not find a valid customization page to disable |
| 1212 | An undocumented error has occurred and has been logged. |
| 1213 | That operation has already been performed for this challenge/error. |
| 1214 | Rate limit reached for this operation. Please try again in a minute |
| 1215 | Rate limit reached for this operation. Please try again in a minute |
| 1217 | Invalid state passed |
| 1218 | Missing Custom Page state |
| 1219 | Please upgrade to access this feature |
| 1220 | We were unable to scan the page provided. Please ensure it is accessible publicly and is larger than 100 characters |
| Name /type | Description /example | Constraints |
| status | Status of the zone's custom SSL
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of zones per page
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates?status=active&page=1&per_page=20&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
]
}| Name /type | Description /example | Constraints |
| certificate string | The zone's SSL certificate or certificate and the intermediate(s)
| |
| private_key string | The zone's private key
|
| Name /type | Description /example | Constraints |
| bundle_method string | A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
|
|
| geo_restrictions object | Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.
| |
| type string | The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","bundle_method":"ubiquitous","geo_restrictions":{"label":"us"},"type":"sni_custom"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
}| Name /type | Description /example | Constraints |
| private_key string | The zone's private key
| |
| certificate string | The zone's SSL certificate or certificate and the intermediate(s)
| |
| bundle_method string | A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
|
|
| geo_restrictions object | Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","bundle_method":"ubiquitous","geo_restrictions":{"label":"us"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60"
}
}| Name /type | Description /example | Constraints |
| certificates array | Array of ordered certificates.
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/prioritize" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"certificates":[{"id":"5a7805061c76ada191ed06f989cc3dac","priority":2},{"id":"9a7806061c88ada191ed06f989cc3dac","priority":1}]}'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
]
}| Name /type | Description /example | Constraints |
| hostname string | Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
|
|
| id string | Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of hostnames per page
|
|
| order | Field to order hostnames by
|
|
| direction | Direction to order hostnames
|
|
| ssl | Whether to filter hostnames based on if they have SSL enabled
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames?hostname=app.example.com&id=0d89c70d-ad9f-4843-b99f-6cc0252067e9&page=1&per_page=20&order=ssl&direction=desc&ssl=0" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"hostname": "app.example.com",
"ssl": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"status": "pending_validation",
"method": "http",
"type": "dv",
"txt_name": "_acme-challenge.app.example.com",
"txt_value": "810b7d5f01154524b961ba0cd578acc2",
"http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
"http_body": "ca3-574923932a82475cb8592200f1a2a23d",
"emails": [
"administrator@example.com",
"webmaster@example.com"
],
"validation_errors": {
"message": "SERVFAIL looking up CAA for app.example.com"
},
"hosts": [
"app.example.com",
"*.app.example.com"
],
"issuer": "DigiCertInc",
"serial_number": "6743787633689793699141714808227354901",
"signature": "SHA256WithRSA",
"uploaded_on": "2020-02-06T18:11:23.531995Z",
"expires_on": "2021-02-06T18:11:23.531995Z",
"custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
"settings": {
"http2": "on",
"http3": "on",
"min_tls_version": "1.2",
"tls_1_3": "on",
"ciphers": [
"ECDHE-RSA-AES128-GCM-SHA256",
"AES128-SHA"
]
},
"bundle_method": "ubiquitous",
"wildcard": false,
"certificate_authority": "digicert",
"custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
"custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
},
"custom_metadata": {
"key": "value"
},
"custom_origin_server": "origin2.example.com",
"status": "pending",
"verification_errors": [
"None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
],
"ownership_verification": {
"type": "txt",
"name": "_cf-custom-hostname.app.example.com",
"value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"ownership_verification_http": {
"http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"created_at": "2020-02-06T18:11:23.531995Z"
}
]
}| Name /type | Description /example | Constraints |
| hostname string | The custom hostname that will point to your hostname via CNAME.
|
|
| ssl object | SSL properties used when creating the custom hostname
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"hostname":"app.example.com","ssl":{"method":"http","type":"dv","settings":{"http2":"on","http3":"on","min_tls_version":"1.2","tls_1_3":"on","ciphers":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]},"bundle_method":"ubiquitous","wildcard":false,"custom_certificate":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","custom_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"hostname": "app.example.com",
"ssl": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"status": "pending_validation",
"method": "http",
"type": "dv",
"txt_name": "_acme-challenge.app.example.com",
"txt_value": "810b7d5f01154524b961ba0cd578acc2",
"http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
"http_body": "ca3-574923932a82475cb8592200f1a2a23d",
"emails": [
"administrator@example.com",
"webmaster@example.com"
],
"validation_errors": {
"message": "SERVFAIL looking up CAA for app.example.com"
},
"hosts": [
"app.example.com",
"*.app.example.com"
],
"issuer": "DigiCertInc",
"serial_number": "6743787633689793699141714808227354901",
"signature": "SHA256WithRSA",
"uploaded_on": "2020-02-06T18:11:23.531995Z",
"expires_on": "2021-02-06T18:11:23.531995Z",
"custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
"settings": {
"http2": "on",
"http3": "on",
"min_tls_version": "1.2",
"tls_1_3": "on",
"ciphers": [
"ECDHE-RSA-AES128-GCM-SHA256",
"AES128-SHA"
]
},
"bundle_method": "ubiquitous",
"wildcard": false,
"certificate_authority": "digicert",
"custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
"custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
},
"custom_metadata": {
"key": "value"
},
"custom_origin_server": "origin2.example.com",
"status": "pending",
"verification_errors": [
"None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
],
"ownership_verification": {
"type": "txt",
"name": "_cf-custom-hostname.app.example.com",
"value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"ownership_verification_http": {
"http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"created_at": "2020-02-06T18:11:23.531995Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"hostname": "app.example.com",
"ssl": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"status": "pending_validation",
"method": "http",
"type": "dv",
"txt_name": "_acme-challenge.app.example.com",
"txt_value": "810b7d5f01154524b961ba0cd578acc2",
"http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
"http_body": "ca3-574923932a82475cb8592200f1a2a23d",
"emails": [
"administrator@example.com",
"webmaster@example.com"
],
"validation_errors": {
"message": "SERVFAIL looking up CAA for app.example.com"
},
"hosts": [
"app.example.com",
"*.app.example.com"
],
"issuer": "DigiCertInc",
"serial_number": "6743787633689793699141714808227354901",
"signature": "SHA256WithRSA",
"uploaded_on": "2020-02-06T18:11:23.531995Z",
"expires_on": "2021-02-06T18:11:23.531995Z",
"custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
"settings": {
"http2": "on",
"http3": "on",
"min_tls_version": "1.2",
"tls_1_3": "on",
"ciphers": [
"ECDHE-RSA-AES128-GCM-SHA256",
"AES128-SHA"
]
},
"bundle_method": "ubiquitous",
"wildcard": false,
"certificate_authority": "digicert",
"custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
"custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
},
"custom_metadata": {
"key": "value"
},
"custom_origin_server": "origin2.example.com",
"status": "pending",
"verification_errors": [
"None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
],
"ownership_verification": {
"type": "txt",
"name": "_cf-custom-hostname.app.example.com",
"value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"ownership_verification_http": {
"http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"created_at": "2020-02-06T18:11:23.531995Z"
}
}| Name /type | Description /example | Constraints |
| ssl object | SSL properties used when creating the custom hostname
| |
| custom_metadata object | These are per-hostname (customer) settings.
| |
| custom_origin_server string | a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"ssl":{"method":"http","type":"dv","settings":{"http2":"on","http3":"on","min_tls_version":"1.2","tls_1_3":"on","ciphers":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]},"bundle_method":"ubiquitous","wildcard":false,"custom_certificate":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","custom_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"custom_metadata":{"key":"value"},"custom_origin_server":"origin2.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"hostname": "app.example.com",
"ssl": {
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"status": "pending_validation",
"method": "http",
"type": "dv",
"txt_name": "_acme-challenge.app.example.com",
"txt_value": "810b7d5f01154524b961ba0cd578acc2",
"http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
"http_body": "ca3-574923932a82475cb8592200f1a2a23d",
"emails": [
"administrator@example.com",
"webmaster@example.com"
],
"validation_errors": {
"message": "SERVFAIL looking up CAA for app.example.com"
},
"hosts": [
"app.example.com",
"*.app.example.com"
],
"issuer": "DigiCertInc",
"serial_number": "6743787633689793699141714808227354901",
"signature": "SHA256WithRSA",
"uploaded_on": "2020-02-06T18:11:23.531995Z",
"expires_on": "2021-02-06T18:11:23.531995Z",
"custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
"settings": {
"http2": "on",
"http3": "on",
"min_tls_version": "1.2",
"tls_1_3": "on",
"ciphers": [
"ECDHE-RSA-AES128-GCM-SHA256",
"AES128-SHA"
]
},
"bundle_method": "ubiquitous",
"wildcard": false,
"certificate_authority": "digicert",
"custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
"custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
},
"custom_metadata": {
"key": "value"
},
"custom_origin_server": "origin2.example.com",
"status": "pending",
"verification_errors": [
"None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
],
"ownership_verification": {
"type": "txt",
"name": "_cf-custom-hostname.app.example.com",
"value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"ownership_verification_http": {
"http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
"http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
},
"created_at": "2020-02-06T18:11:23.531995Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"origin": "fallback.example.com",
"status": "pending_deployment",
"errors": [
"DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
],
"created_at": "2019-10-28T18:11:23.37411Z",
"updated_at": "2020-03-16T18:11:23.531995Z"
}
}| Name /type | Description /example | Constraints |
| origin string | Your origin hostname that requests to your custom hostnames will be sent to.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"origin":"fallback.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"origin": "fallback.example.com",
"status": "pending_deployment",
"errors": [
"DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
],
"created_at": "2019-10-28T18:11:23.37411Z",
"updated_at": "2020-03-16T18:11:23.531995Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"origin": "fallback.example.com",
"status": "pending_deployment",
"errors": [
"DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
],
"created_at": "2019-10-28T18:11:23.37411Z",
"updated_at": "2020-03-16T18:11:23.531995Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "4d2844d2ce78891c34d0b6c0535a291e",
"name": "example.com Keyless SSL",
"host": "example.com",
"port": 24008,
"status": "active",
"enabled": false,
"permissions": [
"#ssl:read",
"#ssl:edit"
],
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
]
}| Name /type | Description /example | Constraints |
| host string | The keyless SSL name
|
|
| port number | The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server
|
|
| certificate string | The zone's SSL certificate or SSL certificate and intermediate(s)
|
| Name /type | Description /example | Constraints |
| name string | The keyless SSL name
|
|
| bundle_method string | A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"host":"example.com","port":24008,"name":"example.com Keyless SSL","certificate":"-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----","bundle_method":"ubiquitous"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4d2844d2ce78891c34d0b6c0535a291e",
"name": "example.com Keyless SSL",
"host": "example.com",
"port": 24008,
"status": "active",
"enabled": false,
"permissions": [
"#ssl:read",
"#ssl:edit"
],
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4d2844d2ce78891c34d0b6c0535a291e",
"name": "example.com Keyless SSL",
"host": "example.com",
"port": 24008,
"status": "active",
"enabled": false,
"permissions": [
"#ssl:read",
"#ssl:edit"
],
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
}| Name /type | Description /example | Constraints |
| host string | The keyless SSL name
|
|
| name string | The keyless SSL name
|
|
| port number | The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server
|
|
| enabled boolean | Whether or not the Keyless SSL is on or off
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"host":"example.com","name":"example.com Keyless SSL","port":24008,"enabled":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4d2844d2ce78891c34d0b6c0535a291e",
"name": "example.com Keyless SSL",
"host": "example.com",
"port": 24008,
"status": "active",
"enabled": false,
"permissions": [
"#ssl:read",
"#ssl:edit"
],
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "4d2844d2ce78891c34d0b6c0535a291e"
}
}| Name /type | Description /example | Constraints |
| certificate string | The zone's SSL certificate or certificate and the intermediate(s)
| |
| bundle_method string | A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/analyze" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","bundle_method":"ubiquitous"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"hosts": [
"example.com"
],
"signature_algorithm": "SHA256WithRSA",
"expires_on": "2016-01-01T05:20:00Z"
}
}| Name /type | Description /example | Constraints |
| status | Include Certificate Packs of all statuses, not just active ones.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs?status=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "3822ff90-ea29-44df-9e55-21300bb9419b",
"type": "custom",
"hosts": [
"example.com",
"*.example.com",
"www.example.com"
],
"certificates": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
],
"primary_certificate": "7e7b8deba8538af625850b7b2530034c"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3822ff90-ea29-44df-9e55-21300bb9419b",
"type": "custom",
"hosts": [
"example.com",
"*.example.com",
"www.example.com"
],
"certificates": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
],
"primary_certificate": "7e7b8deba8538af625850b7b2530034c"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/quota" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"advanced": {
"allocated": 100,
"used": 5
}
}
}| Name /type | Description /example | Constraints |
| hosts array | Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"hosts":["example.com","*.example.com","www.example.com"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3822ff90-ea29-44df-9e55-21300bb9419b",
"type": "custom",
"hosts": [
"example.com",
"*.example.com",
"www.example.com"
],
"certificates": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"hosts": [
"example.com"
],
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"status": "active",
"bundle_method": "ubiquitous",
"geo_restrictions": {
"label": "us"
},
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"uploaded_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"expires_on": "2016-01-01T05:20:00Z",
"priority": 1
}
],
"primary_certificate": "7e7b8deba8538af625850b7b2530034c"
}
}| Name /type | Description /example | Constraints |
| type string | Type of certificate pack
|
|
| hosts array | Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
| |
| validation_method string | Validation Method selected for the order
|
|
| validity_days integer | Validity Days selected for the order
|
|
| certificate_authority string | Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).
|
|
| Name /type | Description /example | Constraints |
| cloudflare_branding boolean | Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/order" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"advanced","hosts":["example.com","*.example.com","www.example.com"],"validation_method":"txt","validity_days":365,"certificate_authority":"digicert","cloudflare_branding":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3822ff90-ea29-44df-9e55-21300bb9419b",
"type": "advanced",
"hosts": [
"example.com",
"*.example.com",
"www.example.com"
],
"status": "initializing",
"validation_method": "txt",
"validity_days": 365,
"certificate_authority": "digicert",
"cloudflare_branding": false
}
}curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3822ff90-ea29-44df-9e55-21300bb9419b",
"type": "advanced",
"hosts": [
"example.com",
"*.example.com",
"www.example.com"
],
"status": "initializing",
"validation_method": "txt",
"validity_days": 365,
"certificate_authority": "digicert",
"cloudflare_branding": false
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "3822ff90-ea29-44df-9e55-21300bb9419b"
}
}| Code | Description |
| 1400 | Missing required property in request |
| 1401 | Error while requesting from certificate service |
| 1402 | Error while requesting from certificate service |
| 1403 | Bad response certificate service |
| 1404 | Bad response certificate service |
| 1405 | Missing required certificate pack id for deletion |
| 1406 | Bad response certificate service |
| 1407 | Bad response certificate service |
| 1408 | ID is not a dedicated or advanced certificate. |
| 1409 | Error while requesting from certificate service |
| 1410 | Bad response certificate service |
| 1411 | ID is not a dedicated or advanced certificate. |
| 1412 | Missing required property in request |
| 1413 | You do not have sufficient entitlements to order the Dedicated Certificate. If you recently deleted a Dedicated Certificate it may still be pending removal. Please try again and contact your Customer Success Manager or Cloudflare Support for assistance if the issue persists. |
| 1414 | You must complete domain control validation (DCV) for all hostnames on the Dedicated Certificate before placing an order. |
| Name /type | Description /example | Constraints |
| retry | Immediately retry SSL Verification
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/verification?retry=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"result": [
{
"certificate_status": "active",
"verification_type": "cname",
"verification_status": true,
"verification_info": {
"record_name": "b3b90cfedd89a3e487d3e383c56c4267.example.com",
"record_target": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com"
},
"brand_check": false,
"validation_method": "txt",
"cert_pack_uuid": "a77f8bd7-3b47-46b4-a6f1-75cf98109948"
}
]
}| Name /type | Description /example | Constraints |
| validation_method string | Desired validation method
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/verification/a77f8bd7-3b47-46b4-a6f1-75cf98109948" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"validation_method":"txt"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"validation_method": "txt",
"status": "pending_validation"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/universal/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"enabled": true
}
}| Name /type | Description /example | Constraints |
| enabled boolean | Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no dedicated certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS. By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased a dedicated certificate.
Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge. If you do not have a valid custom or dedicated certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/universal/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"enabled": true
}
}| Name /type | Description /example | Constraints |
| zone_id string | Zone identifier tag
|
|
curl -X GET "https://api.cloudflare.com/client/v4/certificates?zone_id=023e105f4ecef8ad9ca31a8372d0c353" \
-H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "328578533902268680212849205732770752308931942346",
"certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
"hostnames": [
"example.com",
"*.example.com"
],
"expires_on": "2014-01-01T05:20:00.12345Z",
"request_type": "origin-rsa",
"requested_validity": 5475,
"csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
}
]
}| Name /type | Description /example | Constraints |
| hostnames array | Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate
| |
| requested_validity number | The number of days for which the certificate should be valid
|
|
| request_type string | Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers)
|
|
| csr string | The Certificate Signing Request (CSR). Must be newline-encoded.
|
curl -X POST "https://api.cloudflare.com/client/v4/certificates" \
-H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a" \
--data '{"hostnames":["example.com","*.example.com"],"requested_validity":5475,"request_type":"origin-rsa","csr":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "328578533902268680212849205732770752308931942346",
"certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
"hostnames": [
"example.com",
"*.example.com"
],
"expires_on": "2014-01-01T05:20:00.12345Z",
"request_type": "origin-rsa",
"requested_validity": 5475,
"csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
}
}curl -X GET "https://api.cloudflare.com/client/v4/certificates/328578533902268680212849205732770752308931942346" \
-H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "328578533902268680212849205732770752308931942346",
"certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
"hostnames": [
"example.com",
"*.example.com"
],
"expires_on": "2014-01-01T05:20:00.12345Z",
"request_type": "origin-rsa",
"requested_validity": 5475,
"csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/certificates/328578533902268680212849205732770752308931942346" \
-H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "328578533902268680212849205732770752308931942346"
}
}| Code | Description |
| 1000 | API errors encountered |
| 1001 | Request had no Authorization header |
| 1002 | Unsupported request_type |
| 1003 | Failed to read contents of HTTP request |
| 1004 | Failed to parse request JSON |
| 1005 | Too many hostnames requested - you may only request up to 100 per certificate |
| 1006 | One or more hostnames were duplicated in the request and have been removed prior to certificate generation |
| 1007 | CSR parsed as empty |
| 1008 | Error creating request to CA |
| 1009 | Permitted values for the 'requested_validity' parameter (specified in days) are: 7, 30, 90, 365, 730, 1095, and 5475 (default) |
| 1010 | Failed to validate SAN <hostname>: <reason for failure> |
| 1011 | Failed to parse CSR |
| 1012 | Please provide a zone id when requesting a stored certificate, or fetch by serial number |
| 1013 | Please provide a certificate serial number when operating on a single certificate |
| 1014 | Certificate already revoked |
| 1100 | Failed to write certificate to database |
| 1101 | Failed to read certificate from database |
| 1200 | API Error: Failed to generate CA request |
| 1201 | CA signing failure. Could not parse returned certificate |
| 1300 | Failed to fetch keyless servers from API |
| 1301 | key server didn't activate correctly |
| 1302 | Could not get keyless server port for server <server> |
| 1303 | invalid hostname: <hostname> |
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"enabled": true
}
}| Name /type | Description /example | Constraints |
| enabled boolean | Indicates whether zone-level authenticated origin pulls is enabled
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"enabled": true
}
}| Name /type | Description /example | Constraints |
| certificate string | The zone's leaf certificate
| |
| private_key string | The zone's private key
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}| Name /type | Description /example | Constraints |
| certificate string | The hostname certificate
| |
| private_key string | The hostname certificate's private key
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"serial_number": "6743787633689793699141714808227354901",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"serial_number": "6743787633689793699141714808227354901",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"serial_number": "6743787633689793699141714808227354901",
"expires_on": "2100-01-01T05:20:00Z",
"status": "active",
"uploaded_on": "2019-10-28T18:11:23.37411Z"
}
}| Name /type | Description /example | Constraints |
| config array |
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"config":[{"hostname":"app.example.com","cert_id":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","enabled":true}]}'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"hostname": "app.example.com",
"cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"enabled": true,
"status": "active",
"created_at": "2100-01-01T05:20:00Z",
"updated_at": "2100-01-01T05:20:00Z",
"cert_status": "active",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"serial_number": "6743787633689793699141714808227354901",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"cert_uploaded_on": "2019-10-28T18:11:23.37411Z",
"cert_updated_at": "2100-01-01T05:20:00Z",
"expires_on": "2100-01-01T05:20:00Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/app.example.com" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"hostname": "app.example.com",
"cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
"enabled": true,
"status": "active",
"created_at": "2100-01-01T05:20:00Z",
"updated_at": "2100-01-01T05:20:00Z",
"cert_status": "active",
"issuer": "GlobalSign",
"signature": "SHA256WithRSA",
"serial_number": "6743787633689793699141714808227354901",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
"cert_uploaded_on": "2019-10-28T18:11:23.37411Z",
"cert_updated_at": "2100-01-01T05:20:00Z",
"expires_on": "2100-01-01T05:20:00Z"
}
}| Name /type | Description /example | Constraints |
| url string (uri) | URL to the video. Server must be publicly routable and support HTTP HEAD requests and HTTP GET range requests. Server should respond to HTTP HEAD requests with a content-range header with the size of the file.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/copy" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"url":"https://example.com/myvideo.mp4"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"allowedOrigins": [
"example.com"
],
"created": "2014-01-02T02:20:00Z",
"duration": 300,
"input": {
"height": 1080,
"width": 1920
},
"maxDurationSeconds": 300,
"meta": {},
"modified": "2014-01-02T02:20:00Z",
"uploadExpiry": "2014-01-02T02:20:00Z",
"playback": {
"hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
"dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
},
"preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
"readyToStream": true,
"requireSignedURLs": true,
"size": 4190963,
"status": {
"state": "inprogress",
"pctComplete": 51
},
"thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
"uid": "ea95132c15732412d22c1476fa83f27a",
"uploaded": "2014-01-02T02:20:00Z"
}
}| Name /type | Description /example | Constraints |
| file string | Video file to upload
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
--form 'file=@/Users/kyle/Desktop/skiing.mp4'{
"success": true,
"errors": [],
"messages": [],
"result": {
"allowedOrigins": [
"example.com"
],
"created": "2014-01-02T02:20:00Z",
"duration": 300,
"input": {
"height": 1080,
"width": 1920
},
"maxDurationSeconds": 300,
"meta": {},
"modified": "2014-01-02T02:20:00Z",
"uploadExpiry": "2014-01-02T02:20:00Z",
"playback": {
"hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
"dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
},
"preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
"readyToStream": true,
"requireSignedURLs": true,
"size": 4190963,
"status": {
"state": "inprogress",
"pctComplete": 51
},
"thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
"uid": "ea95132c15732412d22c1476fa83f27a",
"uploaded": "2014-01-02T02:20:00Z"
}
}| Name /type | Description /example | Constraints |
| maxDurationSeconds integer | Direct uploads occupy minutes of videos on your Stream account until they are expired. This value will be used to calculate the duration the video will occupy before the video is uploaded. After upload, the duration of the uploaded will be used instead. If a video longer than this value is uploaded, the video will result in an error.
|
|
| Name /type | Description /example | Constraints |
| expiry string (date-time) | The date after upload will not be accepted
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/direct_upload" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"maxDurationSeconds":300,"expiry":"2021-01-02T02:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"uploadURL": "www.example.com/samplepath",
"uid": "ea95132c15732412d22c1476fa83f27a"
}
}| Name /type | Description /example | Constraints |
| after string (date-time) | Show videos created after this date-time
| |
| before string (date-time) | Show videos created before this time
| |
| include_counts boolean | Include stats in the response about the number of videos in response range and total number of videos available
|
|
| search string | A string provided in this field will be used to search over the 'name' key in meta field, which can be set with the upload request of after.
| |
| limit integer | Number of videos to include in the response |
|
| asc boolean | List videos in ascending order of creation
|
|
| status string | Filter by statuses
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream?after=2014-01-02T02:20:00Z&before=2014-01-02T02:20:00Z&include_counts=false&search=puppy.mp4&limit=undefined&asc=false&status=downloading,queued,inprogress,ready,error" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"allowedOrigins": [
"example.com"
],
"created": "2014-01-02T02:20:00Z",
"duration": 300,
"input": {
"height": 1080,
"width": 1920
},
"maxDurationSeconds": 300,
"meta": {},
"modified": "2014-01-02T02:20:00Z",
"uploadExpiry": "2014-01-02T02:20:00Z",
"playback": {
"hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
"dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
},
"preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
"readyToStream": true,
"requireSignedURLs": true,
"size": 4190963,
"status": {
"state": "inprogress",
"pctComplete": 51
},
"thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
"uid": "ea95132c15732412d22c1476fa83f27a",
"uploaded": "2014-01-02T02:20:00Z"
}
],
"total": "35586",
"range": "1000"
}curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: 900000000"curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"allowedOrigins": [
"example.com"
],
"created": "2014-01-02T02:20:00Z",
"duration": 300,
"input": {
"height": 1080,
"width": 1920
},
"maxDurationSeconds": 300,
"meta": {},
"modified": "2014-01-02T02:20:00Z",
"uploadExpiry": "2014-01-02T02:20:00Z",
"playback": {
"hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
"dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
},
"preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
"readyToStream": true,
"requireSignedURLs": true,
"size": 4190963,
"status": {
"state": "inprogress",
"pctComplete": 51
},
"thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
"uid": "ea95132c15732412d22c1476fa83f27a",
"uploaded": "2014-01-02T02:20:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a/embed" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"<stream id="ea95132c15732412d22c1476fa83f27a"></stream><script data-cfasync="false" defer type="text/javascript" src="https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js"></script>
curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"| Code | Description |
| 10000 | Internal Server Error |
| 10001 | Authentication Failure |
curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "5213cfa121f70b8c1380686ffc371ba3",
"pem": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=",
"jwk": "eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=",
"created": "2014-01-02T02:20:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "5213cfa121f70b8c1380686ffc371ba3",
"created": "2014-01-02T02:20:00Z"
}
]
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys/5213cfa121f70b8c1380686ffc371ba3" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": ""
}| Name /type | Description /example | Constraints |
| file string | WebVTT file to upload
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions/tr" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
--form 'file=@/Users/kyle/Desktop/tr.vtt'{
"success": true,
"errors": [],
"messages": [],
"result": {
"label": "Türkçe",
"language": "tr"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"label": "Türkçe",
"language": "tr"
}
]
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions/tr" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": ""
}For more detailed documentation on using the API for Workers see the Workers API.
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/javascript" \
--data "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"{
"success": true,
"errors": [],
"messages": [],
"result": {
"script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })",
"etag": "ea95132c15732412d22c1476fa83f27a",
"size": 1024,
"modified_on": "2017-01-01T00:00:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "this-is_my_script-01",
"etag": "ea95132c15732412d22c1476fa83f27a",
"created_on": "2017-01-01T00:00:00Z",
"modified_on": "2017-01-01T00:00:00Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Accept: application/javascript"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"| Code | Description |
| 10001 | Unsupported or unexpected Content Type |
| 10002 | Unexpected internal server error |
| 10003 | Missing required URL parameter |
| 10004 | Malformed URL parameter |
| 10006 | Unparseable script body |
| 10007 | Resource not found (similar to HTTP 404) |
| 10014 | Internal error while attempting authorization checks |
| 10015 | The current account is not authorized to use workers |
| 10018 | Attempted to update a script where the e-tag does not match |
| 10021 | Script content failed validation checks, but was otherwise parseable |
| 10023 | Unauthorized access attempt |
| 10027 | Script body was too large |
For more detailed documentation on using the API for Workers see the Workers API.
| Name /type | Description /example | Constraints |
| pattern string |
|
| Name /type | Description /example | Constraints |
| script string | Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"pattern":"example.net/*","script":"this-is_my_script-01"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"pattern": "example.net/*",
"script": "this-is_my_script-01"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"pattern": "example.net/*",
"script": "this-is_my_script-01"
}
}| Name /type | Description /example | Constraints |
| pattern string |
|
| Name /type | Description /example | Constraints |
| script string | Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"pattern":"example.net/*","script":"this-is_my_script-01"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"pattern": "example.net/*",
"script": "this-is_my_script-01"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Code | Description |
| 10001 | Unsupported or unexpected Content Type |
| 10002 | Unexpected internal server error |
| 10003 | Missing required URL parameter |
| 10004 | Malformed URL parameter |
| 10007 | Resource not found (similar to HTTP 404) |
| 10014 | Internal error while attempting authorization checks |
| 10015 | The current account is not authorized to use workers |
| 10020 | Attempted to create a route for a pattern that already exists |
| 10022 | Route pattern was invalid |
| 10023 | Unauthorized access attempt |
| 10026 | Route pattern was unparseable |
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page
|
|
| order | Field to order results by
|
|
| direction | Direction to order namespaces
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces?page=1&per_page=20&order=id&direction=asc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "0f2ac74b498b48028cb68387c421e279",
"title": "My Own Namespace",
"supports_url_encoding": true
}
]
}| Name /type | Description /example | Constraints |
| title string | A human-readable string name for a Namespace.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"title":"My Own Namespace"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "0f2ac74b498b48028cb68387c421e279",
"title": "My Own Namespace",
"supports_url_encoding": true
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| title string | A human-readable string name for a Namespace.
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"title":"My Own Namespace"}'{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| limit number | The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.
|
|
| cursor string | Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.
| |
| prefix string | A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/keys?limit=1000&cursor=6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw&prefix=My-Prefix" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"name": "My-Key",
"expiration": 1577836800,
"metadata": {
"someMetadataKey": "someMetadataValue"
}
}
],
"result_info": {
"count": 1,
"cursor": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41""Some Value"
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key?expiration=1578435000&expiration_ttl=300" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: text/plain" \
--data '"Some Value"'{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| value string | A byte sequence to be stored, up to 10 MB in length.
| |
| metadata string | Arbitrary JSON to be associated with a key/value pair
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key?expiration=1578435000&expiration_ttl=300" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: multipart/form-data" \
--form 'value=Some Value' \
--form 'metadata={"someMetadataKey": "someMetadataValue"}'{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| key string | A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.
|
|
| value string | A UTF-8 encoded string to be stored, up to 10 MB in length.
|
|
| Name /type | Description /example | Constraints |
| expiration number | The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
| |
| expiration_ttl number | The number of seconds for which the key should be visible before it expires. At least 60.
| |
| metadata object | Arbitrary JSON that is associated with a key
| |
| base64 boolean | Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/bulk" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"key":"My-Key","value":"Some string","expiration":1578435000,"expiration_ttl":300,"metadata":{"someMetadataKey":"someMetadataValue"},"base64":false}]'{
"success": true,
"errors": [],
"messages": []
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": []
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/bulk" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '["My-Key"]'{
"success": true,
"errors": [],
"messages": []
}| Code | Description |
| 10001 | service temporarily unavailable |
| 10002 | missing CF-Ray header |
| 10003 | missing account public ID |
| 10004 | missing account tag |
| 10005 | URL parameter account tag does not match JWT account tag |
| 10006 | malformed account tag |
| 10007 | malformed page argument |
| 10008 | malformed per_page argument |
| 10009 | key not found |
| 10010 | malformed namespace |
| 10011 | malformed namespace ID |
| 10012 | malformed value |
| 10013 | namespace not found |
| 10014 | namespace already exists |
| 10015 | missing account internal ID |
| 10016 | malformed account internal ID |
| 10018 | too many namespaces in this account |
| 10019 | missing title |
| 10021 | this namespace does not support the list-keys endpoint |
| 10022 | too many requests |
| 10024 | payload too large |
| 10025 | endpoint does not exist |
| 10026 | not entitled |
| 10028 | invalid limit argument |
| 10029 | invalid request |
| 10030 | key too long |
| 10033 | invalid expiration |
| 10034 | invalid expiration ttl |
| 10035 | this namespace does not support the bulk endpoint |
| 10037 | the user lacks the permissions to perform this operation |
| 10038 | this namespace does not support the list-keys prefix parameter |
| 10041 | invalid "list keys" cursor |
| 10042 | illegal key name |
| 10043 | invalid order |
| 10044 | invalid direction |
| 10045 | deprecated endpoint |
| 10046 | too many bulk requests |
| 10047 | invalid metadata |
| Name /type | Description /example | Constraints | |||||||||||||||||||||
| limit integer | Limit number of returned metrics.
|
| |||||||||||||||||||||
| since string (date-time) | Start of time interval to query, defaults to 6 hours before request received.
|
| |||||||||||||||||||||
| until string (date-time) | End of time interval to query, defaults to current time.
|
| |||||||||||||||||||||
| metrics array | One or more metrics to compute.
|
| |||||||||||||||||||||
| dimensions array | Can be used to break down the data by given attributes.
|
| |||||||||||||||||||||
| sort array | Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending)
|
| |||||||||||||||||||||
| filters string | Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/analytics?limit=10000&since=2019-01-02T02:20:00Z&until=2019-01-02T03:20:00Z&metrics=requests,readKiB&dimensions=accountId,responseCode&sort=+requests,-responseCode&filters=requestType==read AND responseCode!=200" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 2,
"data": [
{
"metrics": [
[
2,
4
],
[
16,
32
]
]
}
],
"data_lag": 0,
"min": {
"requests": 2,
"readKiB": 16
},
"max": {
"requests": 4,
"readKiB": 32
},
"totals": {
"requests": 6,
"readKiB": 48
},
"query": {
"limit": 10000,
"since": "2019-01-02T02:20:00Z",
"until": "2019-01-02T03:20:00Z",
"metrics": [
"requests",
"readKiB"
],
"dimensions": [
"accountId",
"responseCode"
],
"sort": [
"+requests",
"-responseCode"
],
"filters": "requestType==read AND responseCode!=200"
}
}
}| Code | Description |
| 10001 | missing CF-Ray header |
| 10002 | missing account ID |
| 10003 | malformed account ID |
| 10004 | malformed query |
| 10005 | unauthorized method |
| Name /type | Description /example | Constraints | |||||||||||||||||||||
| limit integer | Limit number of returned metrics.
|
| |||||||||||||||||||||
| since string (date-time) | Start of time interval to query, defaults to 6 hours before request received.
|
| |||||||||||||||||||||
| until string (date-time) | End of time interval to query, defaults to current time.
|
| |||||||||||||||||||||
| metrics array | One or more metrics to compute.
|
| |||||||||||||||||||||
| dimensions array | Can be used to break down the data by given attributes.
|
| |||||||||||||||||||||
| sort array | Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending)
|
| |||||||||||||||||||||
| filters string | Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/analytics/stored?limit=10000&since=2019-01-02T02:20:00Z&until=2019-01-02T03:20:00Z&metrics=storedBytes,storedKeys&dimensions=namespaceId&sort=+storedBytes,-namespaceId&filters=namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 2,
"data": [
{
"metrics": [
[
2,
4
],
[
16,
32
]
]
}
],
"data_lag": 0,
"min": {
"storedKeys": 2,
"storedBytes": 16
},
"max": {
"storedKeys": 4,
"storedBytes": 32
},
"totals": {
"storedKeys": 6,
"storedBytes": 48
},
"query": {
"limit": 10000,
"since": "2019-01-02T02:20:00Z",
"until": "2019-01-02T03:20:00Z",
"metrics": [
"storedBytes",
"storedKeys"
],
"dimensions": [
"namespaceId"
],
"sort": [
"+storedBytes",
"-namespaceId"
],
"filters": "namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64"
}
}
}| Code | Description |
| 10001 | missing CF-Ray header |
| 10002 | missing account ID |
| 10003 | malformed account ID |
| 10004 | malformed query |
| 10005 | unauthorized method |
NOTE: This API is deprecated, please use equivalent /accounts API endpoints where possible. These APIs are for use with the previously limited single-script zones.
curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Accept: application/javascript"addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/javascript" \
--data "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"{
"success": true,
"errors": [],
"messages": [],
"result": {
"script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })",
"etag": "ea95132c15732412d22c1476fa83f27a",
"size": 1024,
"modified_on": "2017-01-01T00:00:00Z"
}
}| Code | Description |
| 10001 | Unsupported or unexpected Content Type |
| 10002 | Unexpected internal server error |
| 10003 | Missing required URL parameter |
| 10004 | Malformed URL parameter |
| 10006 | Unparseable script body |
| 10007 | Resource not found (similar to HTTP 404) |
| 10014 | Internal error while attempting authorization checks |
| 10015 | The current account is not authorized to use workers |
| 10018 | Attempted to update a script where the e-tag does not match |
| 10021 | Script content failed validation checks, but was otherwise parseable |
| 10023 | Unauthorized access attempt |
| 10027 | Script body was too large |
NOTE: This API is deprecated, please use equivalent /accounts API endpoints where possible. These APIs are for use with the previously limited single-script zones.
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/script/bindings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"name": "myBinding",
"type": "kv_namespace",
"namespace_id": "0f2ac74b498b48028cb68387c421e279"
}
]
}NOTE: This API is deprecated, please use equivalent /routes API endpoints where possible. These APIs are for use with the previously limited single-script zones.
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"pattern": "example.net/*",
"enabled": true
}
]
}| Name /type | Description /example | Constraints |
| pattern string |
| |
| enabled boolean |
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"pattern":"example.net/*","enabled":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"pattern": "example.net/*",
"enabled": true
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Name /type | Description /example | Constraints |
| pattern string |
| |
| enabled boolean |
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"pattern":"example.net/*","enabled":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}| Code | Description |
| 10001 | Unsupported or unexpected Content Type |
| 10002 | Unexpected internal server error |
| 10003 | Missing required URL parameter |
| 10004 | Malformed URL parameter |
| 10007 | Resource not found (similar to HTTP 404) |
| 10014 | Internal error while attempting authorization checks |
| 10015 | The current account is not authorized to use workers |
| 10020 | Attempted to create a filter for a pattern that already exists |
| 10022 | Filter pattern was invalid |
| 10023 | Unauthorized access attempt |
| 10026 | Filter pattern was unparseable |
The List Spectrum Applications endpoint will no longer return all applications by default. Instead, the response will always be paginated in the standard format. If you are already using the page query parameter, there will be no effective change. The endpoint itself is NOT being deprecated.
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query,
|
|
| per_page number | Maximum number of results per page
|
|
| direction string | Direction to order results
|
|
| order string | Application field to order results by
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps?page=1&per_page=20&direction=desc&order=protocol" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "ea95132c15732412d22c1476fa83f27a",
"protocol": "tcp/22",
"dns": {
"type": "CNAME",
"name": "ssh.example.com"
},
"origin_direct": [
"tcp://192.0.2.1:22"
],
"proxy_protocol": "off",
"ip_firewall": true,
"tls": "full",
"edge_ips": {
"type": "dynamic",
"connectivity": "all"
},
"traffic_type": "direct",
"argo_smart_routing": true,
"created_on": "2014-01-02T02:20:00Z",
"modified_on": "2014-01-02T02:20:00Z"
}
]
}| Name /type | Description /example | Constraints |
| origin_direct array | A list of destination addresses to the origin.
| |
| dns object | The name and type of DNS record for the Spectrum application.
| |
| protocol string | Port configuration at Cloudflare’s edge.
|
| Name /type | Description /example | Constraints |
| proxy_protocol string | Enables Proxy Protocol to the origin. See the developer documentation for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.
|
|
| edge_ips | The anycast edge IP configuration for the hostname of this application.
|
|
| argo_smart_routing boolean | Enables Argo Smart Routing for this application.
|
|
| ip_firewall boolean | Enables IP Access Rules for this application.
|
|
| tls string | The type of TLS termination associated with the application.
|
|
| traffic_type string | Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"protocol":"tcp/22","dns":{"type":"CNAME","name":"ssh.example.com"},"origin_direct":["tcp://192.0.2.1:22"],"proxy_protocol":"off","ip_firewall":true,"tls":"full","edge_ips":{"type":"dynamic","connectivity":"all"},"traffic_type":"direct","argo_smart_routing":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a",
"protocol": "tcp/22",
"dns": {
"type": "CNAME",
"name": "ssh.example.com"
},
"origin_direct": [
"tcp://192.0.2.1:22"
],
"proxy_protocol": "off",
"ip_firewall": true,
"tls": "full",
"edge_ips": {
"type": "dynamic",
"connectivity": "all"
},
"traffic_type": "direct",
"argo_smart_routing": true,
"created_on": "2014-01-02T02:20:00Z",
"modified_on": "2014-01-02T02:20:00Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a",
"protocol": "tcp/22",
"dns": {
"type": "CNAME",
"name": "ssh.example.com"
},
"origin_direct": [
"tcp://192.0.2.1:22"
],
"proxy_protocol": "off",
"ip_firewall": true,
"tls": "full",
"edge_ips": {
"type": "dynamic",
"connectivity": "all"
},
"traffic_type": "direct",
"argo_smart_routing": true,
"created_on": "2014-01-02T02:20:00Z",
"modified_on": "2014-01-02T02:20:00Z"
}
}| Name /type | Description /example | Constraints |
| origin_direct array | A list of destination addresses to the origin.
| |
| dns object | The name and type of DNS record for the Spectrum application.
| |
| protocol string | Port configuration at Cloudflare’s edge.
|
| Name /type | Description /example | Constraints |
| proxy_protocol string | Enables Proxy Protocol to the origin. See the developer documentation for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.
|
|
| edge_ips | The anycast edge IP configuration for the hostname of this application.
|
|
| argo_smart_routing boolean | Enables Argo Smart Routing for this application.
|
|
| ip_firewall boolean | Enables IP Access Rules for this application.
|
|
| tls string | The type of TLS termination associated with the application.
|
|
| traffic_type string | Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"protocol":"tcp/22","dns":{"type":"CNAME","name":"ssh.example.com"},"origin_direct":["tcp://192.0.2.1:22"],"proxy_protocol":"off","ip_firewall":true,"tls":"full","edge_ips":{"type":"dynamic","connectivity":"all"},"traffic_type":"direct","argo_smart_routing":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a",
"protocol": "tcp/22",
"dns": {
"type": "CNAME",
"name": "ssh.example.com"
},
"origin_direct": [
"tcp://192.0.2.1:22"
],
"proxy_protocol": "off",
"ip_firewall": true,
"tls": "full",
"edge_ips": {
"type": "dynamic",
"connectivity": "all"
},
"traffic_type": "direct",
"argo_smart_routing": true,
"created_on": "2014-01-02T02:20:00Z",
"modified_on": "2014-01-02T02:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a"
}
}| Code | Description |
| 10000 | Unknown Error |
| 10001 | Unexpected Content Type |
| 10002 | Internal Server Error |
| 10003 | Missing Required URL Param |
| 10004 | Malformed URL Param |
| 10005 | JSON Parsing Error |
| 10006 | Resource Not Found |
| 10007 | Forbidden |
| 11000 | Invalid Origin Configuration |
| 11002 | Invalid Origin Address |
| 11003 | Invalid Edge Port |
| 11004 | Invalid DNS Configuration |
| 11005 | Proxy Protocol v1 Not Supported for non TCP Applications |
| 11006 | TLS Termination Not Supported for non TCP Applications |
| 11007 | Origin/Edge Transport Mismatch |
| 11008 | UDP Not Enabled |
| 12000 | No Address Available |
| 13000 | Protocol Not Found |
| 13002 | Protocol Not Available |
| 14002 | Port Conflict |
| 1402 | DNS Validation Error |
| 81053 | DNS Record Exists Error |
| Name /type | Description /example | Constraints | ||||||||||||||||||||||||||||||||
| metrics array | One or more metrics to compute. Options are:
| |||||||||||||||||||||||||||||||||
| dimensions array | Can be used to break down the data by given attributes. Options are:
| |||||||||||||||||||||||||||||||||
| filters string | Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:
| |||||||||||||||||||||||||||||||||
| sort array | The sort order for the result set; sort fields must be included in
| |||||||||||||||||||||||||||||||||
| since string (date-time) | Start of time interval to query, defaults to
| |||||||||||||||||||||||||||||||||
| until string (date-time) | End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/events/summary?metrics=count,bytesIngress&dimensions=event,appID&filters=event==disconnect%20AND%20coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 2,
"data": [
{
"dimensions": [
"connect",
"42aea0b453934875a216920f1ec8f074"
],
"metrics": [
2,
1
]
},
{
"dimensions": [
"disconnect",
"42aea0b453934875a216920f1ec8f074"
],
"metrics": [
2,
2
]
}
],
"totals": {
"count": 4,
"bytesIngress": 3
},
"min": {
"count": 2,
"bytesIngress": 1
},
"max": {
"count": 2,
"bytesIngress": 2
},
"data_lag": 60,
"query": {
"metrics": [
"count",
"bytesIngress"
],
"dimensions": [
"event",
"appID"
],
"filters": "event==disconnect%20AND%20coloName!=SFO",
"sort": [
{
"Id": "count",
"Desc": false
},
{
"Id": "bytesIngress",
"Desc": true
}
],
"since": "2014-01-02T02:20:00Z",
"until": "2014-01-02T03:20:00Z",
"limit": 10000
}
}
}| Name /type | Description /example | Constraints | ||||||||||||||||||||||||||||||||
| metrics array | One or more metrics to compute. Options are:
| |||||||||||||||||||||||||||||||||
| dimensions array | Can be used to break down the data by given attributes. Options are:
| |||||||||||||||||||||||||||||||||
| filters string | Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:
| |||||||||||||||||||||||||||||||||
| sort array | The sort order for the result set; sort fields must be included in
| |||||||||||||||||||||||||||||||||
| since string (date-time) | Start of time interval to query, defaults to
| |||||||||||||||||||||||||||||||||
| until string (date-time) | End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
| |||||||||||||||||||||||||||||||||
| time_delta string | Used to select time series resolution.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/events/bytime?metrics=count,bytesIngress&dimensions=event,appID&filters=event==disconnect%20AND%20coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z&time_delta=minute" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"rows": 2,
"data": [
{
"dimensions": [
"connect",
"42aea0b453934875a216920f1ec8f074"
],
"metrics": [
[
1,
2
],
[
0,
0
]
]
},
{
"dimensions": [
"disconnect",
"42aea0b453934875a216920f1ec8f074"
],
"metrics": [
[
3,
1
],
[
1,
1
]
]
}
],
"totals": {
"count": 5,
"bytesIngress": 4
},
"min": {
"count": 0,
"bytesIngress": 0
},
"max": {
"count": 3,
"bytesIngress": 2
},
"data_lag": 60,
"time_intervals": [
[
"2018-10-01T12:31:00Z",
"2018-10-01T12:31:59Z"
],
[
"2018-10-01T12:39:00Z",
"2018-10-01T12:39:59Z"
]
],
"query": {
"metrics": [
"count",
"bytesIngress"
],
"dimensions": [
"event",
"appID"
],
"filters": "event==disconnect%20AND%20coloName!=SFO",
"sort": [
{
"Id": "count",
"Desc": false
},
{
"Id": "bytesIngress",
"Desc": true
}
],
"since": "2014-01-02T02:20:00Z",
"until": "2014-01-02T03:20:00Z",
"time_delta": "minute",
"limit": 10000
}
}
}| Name /type | Description /example | Constraints |
| coloName string | Co-location Identifier.
|
|
| appID string | Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/aggregate/current?coloName=PDX&appID=ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"appID": "ea95132c15732412d22c1476fa83f27a",
"bytesIngress": 500,
"bytesEgress": 500,
"connections": 10,
"durationAvg": 10000
}
]
}| Name /type | Description /example | Constraints |
| status string | Status of the page rule
|
|
| order string | Field to order page rules by
|
|
| direction string | Direction to order page rules
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules?status=active&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"targets": [
{
"target": "url",
"constraint": {
"operator": "matches",
"value": "*example.com/images/*"
}
}
],
"actions": [
{
"id": "always_online",
"value": "on"
}
],
"priority": 1,
"status": "active",
"modified_on": "2014-01-01T05:20:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z"
}
]
}| Name /type | Description /example | Constraints |
| targets array | Targets to evaluate on a request
| |
| actions array | The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
|
| Name /type | Description /example | Constraints |
| priority integer | A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
|
|
| status string | Status of the page rule
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"targets": [
{
"target": "url",
"constraint": {
"operator": "matches",
"value": "*example.com/images/*"
}
}
],
"actions": [
{
"id": "always_online",
"value": "on"
}
],
"priority": 1,
"status": "active",
"modified_on": "2014-01-01T05:20:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"targets": [
{
"target": "url",
"constraint": {
"operator": "matches",
"value": "*example.com/images/*"
}
}
],
"actions": [
{
"id": "always_online",
"value": "on"
}
],
"priority": 1,
"status": "active",
"modified_on": "2014-01-01T05:20:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| targets array | Targets to evaluate on a request
| |
| actions array | The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
|
| Name /type | Description /example | Constraints |
| priority integer | A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
|
|
| status string | Status of the page rule
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"targets": [
{
"target": "url",
"constraint": {
"operator": "matches",
"value": "*example.com/images/*"
}
}
],
"actions": [
{
"id": "always_online",
"value": "on"
}
],
"priority": 1,
"status": "active",
"modified_on": "2014-01-01T05:20:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| targets array | Targets to evaluate on a request
| |
| actions array | The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
| |
| priority integer | A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
|
|
| status string | Status of the page rule
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"targets": [
{
"target": "url",
"constraint": {
"operator": "matches",
"value": "*example.com/images/*"
}
}
],
"actions": [
{
"id": "always_online",
"value": "on"
}
],
"priority": 1,
"status": "active",
"modified_on": "2014-01-01T05:20:00.12345Z",
"created_on": "2014-01-01T05:20:00.12345Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/settings" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "always_online",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "browser_cache_ttl",
"properties": [
{
"name": "value",
"type": "range",
"min": 1800,
"max": 31536000,
"suggested_values": [
1800,
3600,
7200,
10800,
14400,
18000,
28800,
43200,
57600,
72000,
86400,
172800,
259200,
345600,
432000,
691200,
1382400,
2073600,
2678400,
5356800,
16070400,
31536000
]
}
]
},
{
"id": "browser_check",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "cache_key_fields",
"properties": [
{
"name": "value",
"type": "object",
"properties": [
{
"name": "query_string",
"type": "select",
"multiple": false,
"allowEmpty": true,
"choices": [
"include",
"exclude"
]
},
{
"name": "header",
"type": "select",
"multiple": true,
"allowEmpty": true,
"choices": [
"include",
"exclude",
"check_presence"
]
},
{
"name": "host",
"type": "select",
"multiple": true,
"allowEmpty": false,
"choices": [
"resolved"
]
},
{
"name": "cookie",
"type": "select",
"multiple": true,
"allowEmpty": true,
"choices": [
"include",
"check_presence"
]
},
{
"name": "user",
"type": "select",
"multiple": true,
"allowEmpty": false,
"choices": [
"device_type",
"geo",
"lang"
]
}
]
}
]
},
{
"id": "cache_deception_armor",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "cache_level",
"properties": [
{
"name": "value",
"type": "select",
"multiple": false,
"choices": [
"bypass",
"basic",
"simplified",
"aggressive",
"cache_everything"
]
}
]
},
{
"id": "cache_ttl_by_status",
"properties": [
{
"name": "value",
"type": "object",
"allowEmpty": false
}
]
},
{
"id": "disable_apps",
"properties": []
},
{
"id": "disable_performance",
"properties": []
},
{
"id": "disable_security",
"properties": []
},
{
"id": "edge_cache_ttl",
"properties": [
{
"name": "value",
"type": "range",
"min": 7200,
"max": 2419200,
"suggested_values": [
7200,
10800,
14400,
18000,
28800,
43200,
57600,
72000,
86400,
172800,
259200,
345600,
432000,
518400,
604800,
1209600,
2419200
]
}
]
},
{
"id": "email_obfuscation",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "forwarding_url",
"properties": [
{
"name": "status_code",
"type": "choice",
"multiple": false,
"choices": [
301,
302
]
},
{
"name": "url",
"type": "forwardingUrl"
}
]
},
{
"id": "ip_geolocation",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "minify",
"properties": [
{
"name": "value",
"type": "select",
"multiple": true,
"allowEmpty": true,
"choices": [
"html",
"css",
"js"
]
}
]
},
{
"id": "explicit_cache_control",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "rocket_loader",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "security_level",
"properties": [
{
"name": "value",
"type": "select",
"multiple": false,
"choices": [
"essentially_off",
"low",
"medium",
"high",
"under_attack"
]
}
]
},
{
"id": "server_side_exclude",
"properties": [
{
"name": "value",
"type": "toggle"
}
]
},
{
"id": "ssl",
"properties": [
{
"name": "value",
"type": "choice",
"multiple": false,
"choices": [
"off",
"flexible",
"full",
"strict"
]
}
]
}
]
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits?page=1&per_page=20" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"disabled": false,
"description": "Prevent multiple login failures to mitigate brute force attacks",
"match": {
"request": {
"methods": [
"GET",
"POST"
],
"schemes": [
"HTTP",
"HTTPS"
],
"url": "*.example.org/path*"
},
"response": {},
"headers": [
{
"name": "Cf-Cache-Status",
"op": "ne",
"value": "HIT"
}
]
},
"bypass": [
{
"name": "url",
"value": "api.example.com/*"
}
],
"threshold": 60,
"period": 900,
"action": {
"mode": "challenge",
"timeout": 86400,
"response": {
"content_type": "text/xml",
"body": "<error>This request has been rate-limited.</error>"
}
}
}
]
}| Name /type | Description /example | Constraints |
| match object | Determines which traffic the rate limit counts towards the threshold
| |
| threshold number | The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period
|
|
| period number | The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed
|
|
| action object | The action to be performed when the threshold of matched traffic within the period defined is exceeded
|
| Name /type | Description /example | Constraints |
| id string | Ratelimit identifier
|
|
| disabled boolean | Whether this ratelimit is currently disabled
|
|
| description string | A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed
|
|
| bypass array | Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","disabled":false,"description":"Prevent multiple login failures to mitigate brute force attacks","match":{"request":{"methods":["GET","POST"],"schemes":["HTTP","HTTPS"],"url":"*.example.org/path*"},"response":{},"headers":[{"name":"Cf-Cache-Status","op":"ne","value":"HIT"}]},"bypass":[{"name":"url","value":"api.example.com/*"}],"threshold":60,"period":900,"action":{"mode":"challenge","timeout":86400,"response":{"content_type":"text/xml","body":"<error>This request has been rate-limited.</error>"}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"disabled": false,
"description": "Prevent multiple login failures to mitigate brute force attacks",
"match": {
"request": {
"methods": [
"GET",
"POST"
],
"schemes": [
"HTTP",
"HTTPS"
],
"url": "*.example.org/path*"
},
"response": {},
"headers": [
{
"name": "Cf-Cache-Status",
"op": "ne",
"value": "HIT"
}
]
},
"bypass": [
{
"name": "url",
"value": "api.example.com/*"
}
],
"threshold": 60,
"period": 900,
"action": {
"mode": "challenge",
"timeout": 86400,
"response": {
"content_type": "text/xml",
"body": "<error>This request has been rate-limited.</error>"
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"disabled": false,
"description": "Prevent multiple login failures to mitigate brute force attacks",
"match": {
"request": {
"methods": [
"GET",
"POST"
],
"schemes": [
"HTTP",
"HTTPS"
],
"url": "*.example.org/path*"
},
"response": {},
"headers": [
{
"name": "Cf-Cache-Status",
"op": "ne",
"value": "HIT"
}
]
},
"bypass": [
{
"name": "url",
"value": "api.example.com/*"
}
],
"threshold": 60,
"period": 900,
"action": {
"mode": "challenge",
"timeout": 86400,
"response": {
"content_type": "text/xml",
"body": "<error>This request has been rate-limited.</error>"
}
}
}
}| Name /type | Description /example | Constraints |
| id string | Ratelimit identifier
|
|
| match object | Determines which traffic the rate limit counts towards the threshold
| |
| threshold number | The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period
|
|
| period number | The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed
|
|
| action object | The action to be performed when the threshold of matched traffic within the period defined is exceeded
|
| Name /type | Description /example | Constraints |
| disabled boolean | Whether this ratelimit is currently disabled
|
|
| description string | A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed
|
|
| bypass array | Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","disabled":false,"description":"Prevent multiple login failures to mitigate brute force attacks","match":{"request":{"methods":["GET","POST"],"schemes":["HTTP","HTTPS"],"url":"*.example.org/path*"},"response":{},"headers":[{"name":"Cf-Cache-Status","op":"ne","value":"HIT"}]},"bypass":[{"name":"url","value":"api.example.com/*"}],"threshold":60,"period":900,"action":{"mode":"challenge","timeout":86400,"response":{"content_type":"text/xml","body":"<error>This request has been rate-limited.</error>"}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"disabled": false,
"description": "Prevent multiple login failures to mitigate brute force attacks",
"match": {
"request": {
"methods": [
"GET",
"POST"
],
"schemes": [
"HTTP",
"HTTPS"
],
"url": "*.example.org/path*"
},
"response": {},
"headers": [
{
"name": "Cf-Cache-Status",
"op": "ne",
"value": "HIT"
}
]
},
"bypass": [
{
"name": "url",
"value": "api.example.com/*"
}
],
"threshold": 60,
"period": 900,
"action": {
"mode": "challenge",
"timeout": 86400,
"response": {
"content_type": "text/xml",
"body": "<error>This request has been rate-limited.</error>"
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59"
}
}| Code | Description |
| 10000 | Invalid user |
| 10001 | Rate limit not found |
| 10002 | Rate limit not unique (edit the existing rather than adding a new) |
| 10004 | Invalid data submitted |
| 10006 | Auth missing |
| 10007 | Auth corrupt |
| 10008 | Auth expired |
| 10009 | Unauthorized |
| 10010 | Time param not valid |
| 10011 | Pagination results in empty page |
| 10012 | URL Param incorrect format |
| 10013 | Patch values not valid |
| 10014 | Patch operation not valid |
| 10015 | Patch value not valid for given context |
| 10016 | Patch not valid |
| Name /type | Description /example | Constraints |
| notes string | Search in the access rules by notes.
|
|
| mode string | The action to apply to a matched request
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
| configuration.target string | Search rules by target
|
|
| order string | Field to order rules by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| configuration.value string | Search by IP, range, or country code
|
|
| direction string | Direction to order rules
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4¬es=my note&match=all&order=mode&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
]
}| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| configuration object | Rule configuration
|
| Name /type | Description /example | Constraints |
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X POST "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b"
}
}| Name /type | Description /example | Constraints |
| notes string | Search in the access rules by notes.
|
|
| mode string | The action to apply to a matched request
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
| configuration.target string | Search rules by target
|
|
| order string | Field to order rules by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| configuration.value string | Search by IP, range, or country code
|
|
| direction string | Direction to order rules
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4¬es=my note&match=all&order=mode&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
]
}| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| configuration object | Rule configuration
|
| Name /type | Description /example | Constraints |
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}| Name /type | Description /example | Constraints |
| id string | Access rule identifier tag
|
|
| allowed_modes array | The possible modes the rule can be in.
|
|
| mode string | The action to apply to a matched request
|
|
| configuration object | Rule configuration
| |
| scope object | All zones owned by the user will have the rule applied.
|
|
| Name /type | Description /example | Constraints |
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
| |
| created_on string (date-time) | When the rule was created
|
|
| modified_on string (date-time) | When the rule was last modified
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"92f17202ed8bd63d69a66b86a49a8f6b","notes":"This rule is on because of an event that occured on date X","allowed_modes":["whitelist","block","challenge","js_challenge"],"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"created_on":"2014-01-01T05:20:00.12345Z","modified_on":"2014-01-01T05:20:00.12345Z","scope":{"id":"7c5dae5552338874e5053f2534d2767a","email":"user@example.com","type":"user"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac"
}
}Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| notes string | Search in the access rules by notes.
|
|
| mode string | The action to apply to a matched request
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
| configuration.target string | Search rules by target
|
|
| order string | Field to order rules by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| configuration.value string | Search by IP, range, or country code
|
|
| direction string | Direction to order rules
|
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4¬es=my note&match=all&order=mode&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| configuration object | Rule configuration
|
| Name /type | Description /example | Constraints |
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b"
}
}Access Rules are a way to allow, challenge, or block requests to your website based on the IP address, IP address range, or country of the browser making the request.
You can apply Access Rules to one zone only or all zones in your account. See the User-level or Organization-level access rules endpoints for creating rules that are applied across all zones owned by the user or organization.
| Name /type | Description /example | Constraints |
| notes string | Search in the access rules by notes.
|
|
| mode string | The action to apply to a matched request
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
| configuration.target string | Search rules by target
|
|
| order string | Field to order rules by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| configuration.value string | Search by IP, range, or country code
|
|
| direction string | Direction to order rules
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4¬es=my note&match=all&order=mode&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
]
}| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| configuration object | Rule configuration
| |
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}| Name /type | Description /example | Constraints |
| mode string | The action to apply to a matched request
|
|
| notes string | A personal note about the rule. Typically used as a reminder or explanation for the rule.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"challenge","notes":"This rule is on because of an event that occured on date X"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"notes": "This rule is on because of an event that occured on date X",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge"
],
"mode": "challenge",
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"scope": {
"id": "7c5dae5552338874e5053f2534d2767a",
"email": "user@example.com",
"type": "user"
}
}
}| Name /type | Description /example | Constraints |
| cascade string | The level to attempt to delete rules defined on other zones that are similar to this rule
|
|
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"cascade":"none"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "92f17202ed8bd63d69a66b86a49a8f6b"
}
}Web application firewall rule packages are collections of rule groups.
| Name /type | Description /example | Constraints |
| name string | Name of the firewall package
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of packages per page
|
|
| order string | Field to order packages by
|
|
| direction string | Direction to order packages
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages?name=USER&page=1&per_page=50&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| sensitivity string | The sensitivity of the firewall package.
|
|
| action_mode string | The default action that will be taken for rules under the firewall package.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"sensitivity":"high","action_mode":"challenge"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "a25a9a7e9c00afc1fb2e0245519d725b",
"name": "OWASP ModSecurity Core Rule Set",
"description": "Covers OWASP Top 10 vulnerabilities, and more.",
"detection_mode": "anomaly",
"zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
"status": "active",
"sensitivity": "high",
"action_mode": "challenge"
}
}| Name /type | Description /example | Constraints |
| name string | Name of the firewall rule group
|
|
| mode string | Whether or not the rules contained within this group are configurable/usable
|
|
| rules_count number | How many rules are contained within this group
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of groups per page
|
|
| order | Field to order groups by
|
|
| direction | Direction to order groups
|
|
| match | Whether to match all search requirements or at least one (any)
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups?name=Project Honey Pot&mode=on&rules_count=10&page=1&per_page=50&order=mode&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot",
"description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
"rules_count": 10,
"modified_rules_count": 2,
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"mode": "on",
"allowed_modes": [
"on",
"off"
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups/de677e5818985db1285d0e80225f06e5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot",
"description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
"rules_count": 10,
"modified_rules_count": 2,
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"mode": "on",
"allowed_modes": [
"on",
"off"
]
}
}| Name /type | Description /example | Constraints |
| mode string | Whether or not the rules contained within this group are configurable/usable
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups/de677e5818985db1285d0e80225f06e5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot",
"description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
"rules_count": 10,
"modified_rules_count": 2,
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"mode": "on",
"allowed_modes": [
"on",
"off"
]
}
}| Name /type | Description /example | Constraints |
| mode string | The setting a rule has been overridden to
|
|
| priority string | The order in which the individual rule is executed within the related group
|
|
| match string | Whether to match all search requirements or at least one (any)
|
|
| order string | Field to order rules by
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of rules per page
|
|
| group_id string | WAF group identifier tag
|
|
| description string | Public description of the rule
|
|
| direction string | Direction to order rules
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules?description=SQL injection prevention for SELECT statements&mode=CHL&priority=5&group_id=de677e5818985db1285d0e80225f06e5&page=1&per_page=50&order=status&direction=desc&match=all" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f939de3be84e66e757adcdcb87908023",
"description": "SQL injection prevention for SELECT statements",
"priority": 5,
"group": {
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot"
},
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"allowed_modes": [
"on",
"off"
],
"mode": "on"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules/f939de3be84e66e757adcdcb87908023" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f939de3be84e66e757adcdcb87908023",
"description": "SQL injection prevention for SELECT statements",
"priority": 5,
"group": {
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot"
},
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"allowed_modes": [
"on",
"off"
],
"mode": "on"
}
}| Name /type | Description /example | Constraints |
| mode | The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules/f939de3be84e66e757adcdcb87908023" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"mode":"on"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f939de3be84e66e757adcdcb87908023",
"description": "SQL injection prevention for SELECT statements",
"priority": 5,
"group": {
"id": "de677e5818985db1285d0e80225f06e5",
"name": "Project Honey Pot"
},
"package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
"allowed_modes": [
"on",
"off"
],
"mode": "on"
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of WAF configurations per page
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides?page=1&per_page=50" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "de677e5818985db1285d0e80225f06e5",
"description": "Enable Cloudflare Magento ruleset for shop.example.com",
"urls": [
"shop.example.com/*"
],
"priority": 1,
"groups": {
"ea8687e59929c1fd05ba97574ad43f77": "default"
},
"rules": {
"100015": "disable"
},
"rewrite_action": {
"default": "block",
"challenge": "block",
"simulate": "disable"
}
}
]
}| Name /type | Description /example | Constraints |
| urls array | URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
| |
| rules object | Change the action assigned to a WAF rule. The keys of this object are WAF rule IDs and the values must be a valid WAF action. Unless disabling the rule, ensure that you also enable the rule group that this WAF rule belongs to.
|
| Name /type | Description /example | Constraints |
| paused boolean | Whether this package is currently paused |
|
| description stringnull | A note that you can use to describe the purpose of this configuration.
|
|
| priority number | Relative priority of this configuration when multiple configurations match a single URL. Higher priority configurations may overwrite values set by lower priority configurations.
|
|
| groups object | Enable or disable WAF rule groups. The keys of this object are WAF rule group IDs and the values must be a valid WAF action (usually default or disable).
| |
| rewrite_action object | When a WAF rule matches, substitute its configured action for a different action specified by this object.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Enable Cloudflare Magento ruleset for shop.example.com","urls":["shop.example.com/*"],"priority":1,"groups":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"rules":{"100015":"disable"},"rewrite_action":{"default":"block","challenge":"block","simulate":"disable"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "de677e5818985db1285d0e80225f06e5",
"description": "Enable Cloudflare Magento ruleset for shop.example.com",
"urls": [
"shop.example.com/*"
],
"priority": 1,
"groups": {
"ea8687e59929c1fd05ba97574ad43f77": "default"
},
"rules": {
"100015": "disable"
},
"rewrite_action": {
"default": "block",
"challenge": "block",
"simulate": "disable"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "de677e5818985db1285d0e80225f06e5",
"description": "Enable Cloudflare Magento ruleset for shop.example.com",
"urls": [
"shop.example.com/*"
],
"priority": 1,
"groups": {
"ea8687e59929c1fd05ba97574ad43f77": "default"
},
"rules": {
"100015": "disable"
},
"rewrite_action": {
"default": "block",
"challenge": "block",
"simulate": "disable"
}
}
}| Name /type | Description /example | Constraints |
| urls array | URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
| |
| rules object | Change the action assigned to a WAF rule. The keys of this object are WAF rule IDs and the values must be a valid WAF action. Unless disabling the rule, ensure that you also enable the rule group that this WAF rule belongs to.
| |
| rewrite_action object | When a WAF rule matches, substitute its configured action for a different action specified by this object.
|
| Name /type | Description /example | Constraints |
| paused boolean | Whether this package is currently paused |
|
| description stringnull | A note that you can use to describe the purpose of this configuration.
|
|
| priority number | Relative priority of this configuration when multiple configurations match a single URL. Higher priority configurations may overwrite values set by lower priority configurations.
|
|
| groups object | Enable or disable WAF rule groups. The keys of this object are WAF rule group IDs and the values must be a valid WAF action (usually default or disable).
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Enable Cloudflare Magento ruleset for shop.example.com","urls":["shop.example.com/*"],"priority":1,"groups":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"rules":{"100015":"disable"},"rewrite_action":{"default":"block","challenge":"block","simulate":"disable"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "de677e5818985db1285d0e80225f06e5",
"description": "Enable Cloudflare Magento ruleset for shop.example.com",
"urls": [
"shop.example.com/*"
],
"priority": 1,
"groups": {
"ea8687e59929c1fd05ba97574ad43f77": "default"
},
"rules": {
"100015": "disable"
},
"rewrite_action": {
"default": "block",
"challenge": "block",
"simulate": "disable"
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"result": {
"id": "de677e5818985db1285d0e80225f06e5"
}
}| Code | Description |
| 10000 | Invalid user |
| 10001 | lockdown rule not found |
| 10002 | lockdown rule not unique (edit the existing rather than adding a new) |
| 10004 | Invalid data submitted |
| 10006 | Auth missing |
| 10007 | Auth corrupt |
| 10008 | Auth expired |
| 10009 | Unauthorized |
| 10011 | Pagination results in empty page |
| 10013 | Patch values not valid |
| 10014 | Patch operation not valid |
| 10015 | Patch value not valid for given context |
| 10016 | Patch not valid |
The access control mechanisms can be defined within a rule to help manage traffic from particular clients. This will enable you to customise the access to your site. The mechanisms are: -
block - Blocks the request immediately
challenge - Send a challenge to the originator of the request
js_challenge - Send a JavaScript based challenge to the originator of the request
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| description string | A single string to search for in the description
| |
| user_agent string | A single UserAgent string to search for
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules?page=1&per_page=20&description=abusive&user_agent=Safari" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"paused": false,
"description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
"mode": "js_challenge",
"configuration": {
"target": "ua",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
}
]
}| Name /type | Description /example | Constraints |
| mode | The type of action to perform.
|
|
| configuration object | Target/Value pair to use for this rule. The value is the exact UserAgent to match
|
| Name /type | Description /example | Constraints |
| id string | UA rule identifier
|
|
| paused boolean | Whether this UA rule is currently paused
|
|
| description string | Some useful information about this rule to help identify the purpose of it.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","paused":false,"description":"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack","mode":"js_challenge","configuration":{"target":"ua","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"paused": false,
"description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
"mode": "js_challenge",
"configuration": {
"target": "ua",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"paused": false,
"description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
"mode": "js_challenge",
"configuration": {
"target": "ua",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
}
}| Name /type | Description /example | Constraints |
| id string | UA rule identifier
|
|
| mode | The type of action to perform.
|
|
| configuration object | Target/Value pair to use for this rule. The value is the exact UserAgent to match
|
| Name /type | Description /example | Constraints |
| paused boolean | Whether this UA rule is currently paused
|
|
| description string | Some useful information about this rule to help identify the purpose of it.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","paused":false,"description":"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack","mode":"js_challenge","configuration":{"target":"ua","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"paused": false,
"description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
"mode": "js_challenge",
"configuration": {
"target": "ua",
"value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59"
}
}| Code | Description |
| 10000 | Invalid user |
| 10001 | UserAgent rule not found |
| 10002 | UserAgent rule not unique (edit the existing rather than adding a new) |
| 10004 | Invalid data submitted |
| 10006 | Auth missing |
| 10007 | Auth corrupt |
| 10008 | Auth expired |
| 10009 | Unauthorized |
| 10011 | Pagination results in empty page |
| 10013 | Patch values not valid |
| 10014 | Patch operation not valid |
| 10015 | Patch value not valid for given context |
| 10016 | Patch not valid |
Ensure that part(s) of your site can only be accessed from permitted IP addresses or IP ranges. Zone Lockdown allows you to define one or more URLs (with wildcard matching on the domain or path) that will only permit access if the request originates from an IP address that matches a safelist of one or more IP addresses and/or IP ranges.
| Name /type | Description /example | Constraints |
| priority number | The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
| |
| ip_range string | A single IP range to search for
| |
| ip string | A single IP address to search for
| |
| uri string | A single URI to search for in the list of URLs
| |
| page number | Page number of paginated results
|
|
| per_page number | Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
|
|
| modified_on string (date-time) | When the lockdown rule was modified
|
|
| created_on string (date-time) | When the lockdown rule was created
|
|
| description string | A single string to search for in the description
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns?page=1&per_page=20&description=endpoints&created_on=2014-01-01T05:20:00.12345Z&modified_on=2014-01-01T05:20:00.12345Z&uri=/some/path&ip=1.2.3.4&ip_range=1.2.3.0/16&priority=5" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"paused": false,
"description": "Restrict access to these endpoints to requests from a known IP address",
"urls": [
"api.mysite.com/some/endpoint*"
],
"configurations": [
{
"target": "ip",
"value": "198.51.100.4"
}
]
}
]
}| Name /type | Description /example | Constraints |
| urls array | URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
| |
| configurations array | List of IP addresses or CIDR ranges to use for this rule. This can include any number of
|
| Name /type | Description /example | Constraints |
| paused boolean | Whether this zone lockdown is currently paused
|
|
| description string | A note that you can use to describe the reason for a Lockdown rule.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"paused":false,"description":"Restrict access to these endpoints to requests from a known IP address","urls":["api.mysite.com/some/endpoint*"],"configurations":[{"target":"ip","value":"198.51.100.4"}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"paused": false,
"description": "Restrict access to these endpoints to requests from a known IP address",
"urls": [
"api.mysite.com/some/endpoint*"
],
"configurations": [
{
"target": "ip",
"value": "198.51.100.4"
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"paused": false,
"description": "Restrict access to these endpoints to requests from a known IP address",
"urls": [
"api.mysite.com/some/endpoint*"
],
"configurations": [
{
"target": "ip",
"value": "198.51.100.4"
}
]
}
}| Name /type | Description /example | Constraints |
| urls array | URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
| |
| configurations array | List of IP addresses or CIDR ranges to use for this rule. This can include any number of
|
| Name /type | Description /example | Constraints |
| paused boolean | Whether this zone lockdown is currently paused
|
|
| description string | A note that you can use to describe the reason for a Lockdown rule.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"paused":false,"description":"Restrict access to these endpoints to requests from a known IP address","urls":["api.mysite.com/some/endpoint*"],"configurations":[{"target":"ip","value":"198.51.100.4"}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"paused": false,
"description": "Restrict access to these endpoints to requests from a known IP address",
"urls": [
"api.mysite.com/some/endpoint*"
],
"configurations": [
{
"target": "ip",
"value": "198.51.100.4"
}
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b59"
}
}| Code | Description |
| 10000 | Invalid user |
| 10001 | lockdown rule not found |
| 10002 | lockdown rule not unique (edit the existing rather than adding a new) |
| 10004 | Invalid data submitted |
| 10006 | Auth missing |
| 10007 | Auth corrupt |
| 10008 | Auth expired |
| 10009 | Unauthorized |
| 10011 | Pagination results in empty page |
| 10013 | Patch values not valid |
| 10014 | Patch operation not valid |
| 10015 | Patch value not valid for given context |
| 10016 | Patch not valid |
| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
| description string | Case-insensitive search in description
| |
| action string | Exact match on a rule action
| |
| paused boolean | Whether this firewall rule is currently paused.
|
|
| page number | Page number of paginated results
|
|
| per_page number | Number of firewall rules per page
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules?id=372e67954025e0ba6aaa6d586b9e0b60&description=mir&action=block&paused=false&page=1&per_page=25" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
]
}| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60?id=372e67954025e0ba6aaa6d586b9e0b60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
}| Name /type | Description /example | Constraints |
| action string | The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
|
|
| filter |
|
| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
| products array |
| |
| priority number | The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
|
|
| paused boolean | Whether this firewall rule is currently paused.
|
|
| description string | A description of the rule to help identify it.
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}]'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
]
}| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
| Name /type | Description /example | Constraints |
| action string | The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
|
|
| products array |
| |
| priority number | The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
|
|
| paused boolean | Whether this firewall rule is currently paused.
|
|
| description string | A description of the rule to help identify it.
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
| filter |
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}]'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
]
}| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
| action string | The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
|
|
| filter |
|
| Name /type | Description /example | Constraints |
| products array |
| |
| priority number | The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
|
|
| paused boolean | Whether this firewall rule is currently paused.
|
|
| description string | A description of the rule to help identify it.
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
}| Name /type | Description /example | Constraints |
| id string | Firewall Rule identifier
|
|
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b60"}'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
]
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "372e67954025e0ba6aaa6d586b9e0b60",
"action": "block",
"products": [
"waf"
],
"priority": 50,
"paused": false,
"description": "Blocks traffic identified during investigation for MIR-31",
"ref": "MIR-31",
"filter": {
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
}
}| Code | Description |
| 10000 | Invalid user |
| Name /type | Description /example | Constraints |
| id string | Filter identifier
|
|
| paused boolean | Whether this filter is currently paused
|
|
| expression string | Case-insensitive string to find in expression
| |
| description string | Case-insensitive string to find in description
| |
| ref string | Exact match search on a ref
| |
| page number | Page number of paginated results
|
|
| per_page number | Number of filter based firewall rules per page
|
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters?id=372e67954025e0ba6aaa6d586b9e0b61&paused=false&expression=php&description=browsers&ref=FIL-100&page=1&per_page=25" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}| Name /type | Description /example | Constraints |
| expression string | The filter expression to be used
|
| Name /type | Description /example | Constraints |
| id string | Filter identifier
|
|
| paused boolean | Whether this filter is currently paused
|
|
| description string | A note that you can use to describe the purpose of the filter
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}]'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
]
}| Name /type | Description /example | Constraints |
| id string | Filter identifier
|
|
| Name /type | Description /example | Constraints |
| expression string | The filter expression to be used
| |
| paused boolean | Whether this filter is currently paused
|
|
| description string | A note that you can use to describe the purpose of the filter
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '[{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}]'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
]
}| Name /type | Description /example | Constraints |
| id string | Filter identifier
|
|
| Name /type | Description /example | Constraints |
| expression string | The filter expression to be used
| |
| paused boolean | Whether this filter is currently paused
|
|
| description string | A note that you can use to describe the purpose of the filter
|
|
| ref string | Short reference tag to quickly select related rules.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}'{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}| Name /type | Description /example | Constraints |
| id string | Filter identifier
|
|
curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"372e67954025e0ba6aaa6d586b9e0b61"}'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}
]
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"id": "372e67954025e0ba6aaa6d586b9e0b61",
"expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"paused": false,
"description": "Restrict access from these browsers on this address range.",
"ref": "FIL-100"
}| Code | Description |
| 10000 | Invalid user |
Provides a full log of the mitigations performed by the Cloudflare Firewall features including; Firewall Rules, Rate Limiting, Security Level, Access Rules (IP, IP Range, ASN, and Country), WAF (Web Application Firewall), User Agent Blocking, Zone Lockdown, and Advanced DDoS Protection. For all mitigated events you are able to access the time, IP, and URI of the request that triggered the mitigation and a list of other matches that were made against the request.
End of life Date: October 26, 2020
For analytics queries, please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/ and blog post at https://blog.cloudflare.com/introducing-the-graphql-analytics-api-exactly-the-data-you-need-all-in-one-place/ . The GraphQL API has more features, is more powerful, easy to use and is also more performant. For a full feed of all Firewall Events, this blog post provides a guided walkthrough: https://blog.cloudflare.com/stream-firewall-events-directly-to-your-siem/
| Name /type | Description /example | Constraints |
| ip_class | IP class is a map of client IP to visitor classification
|
|
| method | The HTTP method of the request
|
|
| scheme | The scheme of the uri
|
|
| ip string | The IPv4 or IPv6 address from which the request originated
| |
| host string | The hostname the request attempted to access
| |
| proto | The protocol of the request
|
|
| uri string | The URI requested from the hostname
| |
| ua string | The client user agent that initiated the request
| |
| colo string | The 3-letter airport code of the Cloudflare data-center that handled the request
| |
| ray_id string | Ray ID of the request. For more information on what a Ray ID is, please refer to: https://support.cloudflare.com/hc/en-us/articles/200169746-What-is-the-CF-RAY-header-
|
|
| kind |
|
|
| action | What type of action was taken
|
|
| cursor string | Cursor position and direction for requesting next set of records when amount of results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.
| |
| country string | The 2-digit country code in which the request originated
|
|
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format.
| |
| source string | Source of the event
|
|
| limit number | The number of events to return. The cursor attribute may be used to iterate over the next batch of events, if there are more events in the queried time range. Note that the scanned_range parameter in the result_info structure gives an indication until when events were considered in the current resultset if a limit was applied.
|
|
| rule_id string | The ID of the rule that triggered the event, should be considered in the context of source.
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/security/events?action=challenge&colo=SJC&country=US&host=www.example.com&ip=198.51.100.4&ip_class=clean&kind=firewall&method=POST&proto=HTTP/2&ray_id=187d944c61940c77&rule_id=273954afcd654af1a7643b378899abba&scheme=https&source=rateLimit&ua=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.120 Safari/537.36&uri=/myexploit.php&limit=50&since=2016-11-11T12:00:00Z&until=2016-11-11T12:00:00Z&cursor=6yDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"ray_id": "187d944c61940c77",
"kind": "firewall",
"action": "challenge",
"source": "rateLimit",
"country": "US",
"ip": "198.51.100.4",
"ip_class": "clean",
"proto": "HTTP/2",
"method": "POST",
"host": "www.example.com",
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.120 Safari/537.36",
"scheme": "https",
"uri": "/myexploit.php",
"rule_id": "273954afcd654af1a7643b378899abba",
"colo": "SJC",
"occurred_at": "2016-11-11T12:00:00Z",
"matches": [
{
"rule_id": "273954afcd654af1a7643b378899abba",
"source": "rateLimit",
"action": "challenge"
}
]
}
],
"result_info": {
"cursors": {
"after": "6yDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw",
"before": "6yDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"
},
"scanned_range": {
"since": "2016-11-11T12:00:00Z",
"until": "2016-11-11T12:00:00Z"
}
}
}| Code | Description |
| 10007 | Service temporarily unavailable. |
| 10008 | Query is estimated to take too long. Try to shrink the time range or reduce query complexity. |
| 10009 | Query reads too many rows. Try to shrink the time range. |
| 10010 | Quota exceeded. Try again later. |
curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/monitors" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true
}
]
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
|
curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/monitors" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true
}
}| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
| |
| expected_codes string | The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/preview" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"pools": {
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
"ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/preview/f1aba936b94213e5b8dca0c0dbf1f9cc?" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
"healthy": true,
"origins": [
{
"originone.example.com.": {
"healthy": true,
"rtt": "66ms",
"failure_reason": "No failures",
"response_code": 200
}
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
]
}| Name /type | Description /example | Constraints |
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
|
| Name /type | Description /example | Constraints |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| check_regions arraynull | A list of regions from which to run health checks. Null means every Cloudflare datacenter.
|
|
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
| |
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| description string | A human-readable description of the pool.
|
curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/pools" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"check_regions":["WEU","ENAM"],"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/health" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"pool_id": "17b5962d775c646f3f9725cbc7a53df4",
"pop_health": {
"Amsterdam, NL": {
"healthy": true,
"origins": [
{
"2001:DB8::5": {
"healthy": true,
"rtt": "12.1ms",
"failure_reason": "No failures",
"response_code": 401
}
}
]
}
}
}
}| Name /type | Description /example | Constraints |
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
|
| Name /type | Description /example | Constraints |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| check_regions arraynull | A list of regions from which to run health checks. Null means every Cloudflare datacenter.
|
|
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
| |
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| description string | A human-readable description of the pool.
|
curl -X PUT "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"check_regions":["WEU","ENAM"],"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}| Name /type | Description /example | Constraints |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| check_regions arraynull | A list of regions from which to run health checks. Null means every Cloudflare datacenter.
|
|
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
| |
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| description string | A human-readable description of the pool.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"check_regions":["WEU","ENAM"],"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4"
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/preview" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"pools": {
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
"ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
}
}
}| Name /type | Description /example | Constraints |
| since string (date-time) | Start date and time of requesting data period in the ISO8601 format
| |
| until string (date-time) | End date and time of requesting data period in the ISO8601 format
| |
| origin_name string | The name for the origin to filter for.
| |
| pool_name string | The name for the pool to filter for.
| |
| pool_id string | API item identifier tag
|
|
| origin_healthy boolean | If true, filter events where the origin status is healthy, if false, filter events where the origin status is unhealthy.
|
|
| pool_healthy boolean | If true, filter events where the pool status is healthy, if false, filter events where the pool status is unhealthy.
|
|
curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancing_analytics/events?since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&origin_name=primary-dc-1&pool_name=primary-dc&pool_id=17b5962d775c646f3f9725cbc7a53df4&origin_healthy=true&pool_healthy=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 2,
"timestamp": "2014-01-01T05:20:00.12345Z",
"pool": {
"id": "74bc6a8b9b0dda3d651707a2928bad0c",
"name": "some-pool",
"healthy": true,
"changed": true,
"minimum_origins": 1
},
"origins": [
{
"name": "some-origin",
"address": "198.51.100.4",
"ip": "198.51.100.4",
"enabled": true,
"healthy": true,
"failure_reason": "No failures",
"changed": true
}
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true,
"consecutive_up": 3,
"consecutive_down": 2,
"probe_zone": "example.com"
}
]
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| consecutive_up integer | To be marked healthy the monitored origin must pass this healthcheck N consecutive times
|
|
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| consecutive_down integer | To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true,
"consecutive_up": 3,
"consecutive_down": 2,
"probe_zone": "example.com"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true,
"consecutive_up": 3,
"consecutive_down": 2,
"probe_zone": "example.com"
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| consecutive_up integer | To be marked healthy the monitored origin must pass this healthcheck N consecutive times
|
|
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| consecutive_down integer | To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true,
"consecutive_up": 3,
"consecutive_down": 2,
"probe_zone": "example.com"
}
}| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| interval integer | The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| consecutive_up integer | To be marked healthy the monitored origin must pass this healthcheck N consecutive times
|
|
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| consecutive_down integer | To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
| |
| description string | Object description
| |
| expected_codes string | The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"type": "https",
"description": "Login page monitor",
"method": "GET",
"path": "/health",
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
},
"port": 8080,
"timeout": 3,
"retries": 0,
"interval": 90,
"expected_body": "alive",
"expected_codes": "2xx",
"follow_redirects": true,
"allow_insecure": true,
"consecutive_up": 3,
"consecutive_down": 2,
"probe_zone": "example.com"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/preview" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"pools": {
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
"ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/preview/p1aba936b94213e5b8dca0c0dbf1f9cc?" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
"healthy": true,
"origins": [
{
"originone.example.com.": {
"healthy": true,
"rtt": "66ms",
"failure_reason": "No failures",
"response_code": 200
}
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
]
}| Name /type | Description /example | Constraints |
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
|
| Name /type | Description /example | Constraints |
| description string | A human-readable description of the pool.
| |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/health" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"pool_id": "17b5962d775c646f3f9725cbc7a53df4",
"pop_health": {
"Amsterdam, NL": {
"healthy": true,
"origins": [
{
"2001:DB8::5": {
"healthy": true,
"rtt": "12.1ms",
"failure_reason": "No failures",
"response_code": 401
}
}
]
}
}
}
}| Name /type | Description /example | Constraints |
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
|
| Name /type | Description /example | Constraints |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| check_regions arraynull | A list of regions from which to run health checks. Null means every Cloudflare datacenter.
|
|
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
| |
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| description string | A human-readable description of the pool.
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"check_regions":["WEU","ENAM"],"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}| Name /type | Description /example | Constraints |
| enabled boolean | Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
|
|
| notification_email string | The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
| |
| check_regions arraynull | A list of regions from which to run health checks. Null means every Cloudflare datacenter.
|
|
| name string | A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| notification_filter objectnull | Filter pool and origin health notifications by resource type or health status. Use null to reset.
| |
| origins array | The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
| |
| monitor string | The ID of the Monitor to use for health checking origins within this pool.
|
|
| minimum_origins integer | The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
|
|
| description string | A human-readable description of the pool.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":true,"check_regions":["WEU","ENAM"],"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56}],"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Primary data center - Provider XYZ",
"name": "primary-dc-1",
"enabled": true,
"minimum_origins": 2,
"monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"check_regions": [
"WEU",
"ENAM"
],
"origins": [
{
"name": "app-server-1",
"address": "0.0.0.0",
"enabled": true,
"weight": 0.56
}
],
"notification_email": "someone@example.com,sometwo@example.com",
"notification_filter": {
"origin": {
"disable": false,
"healthy": null
},
"pool": {
"disable": false,
"healthy": null
}
}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "17b5962d775c646f3f9725cbc7a53df4"
}
}| Name /type | Description /example | Constraints |
| expected_codes string | The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| Name /type | Description /example | Constraints |
| port integer | Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
|
|
| method string | The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
|
|
| timeout integer | The timeout (in seconds) before marking the health check as failed
|
|
| path string | The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| follow_redirects boolean | Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
|
|
| expected_body string | A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
| |
| header object | The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
| |
| allow_insecure boolean | Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
|
|
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
|
|
| probe_zone string | Assign this monitor to emulate the specified zone while probing
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/preview" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"pools": {
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
"ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
}
}
}| Name /type | Description /example | Constraints |
| page number | Requested page within paginated list of results
|
|
| per_page number | Maximum number of results requested
|
|
| query string | Search query term
|
|
| references string | The type of references to include ("*" for all).
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/search?page=undefined&per_page=25&query=primary&references=*" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"resources": [
{
"resource_id": "17b5962d775c646f3f9725cbc7a53df4",
"resource_name": "primary-dc-1",
"resource_type": "pool",
"references": [
{
"resource_id": "699d98642c564d2e855e9661899b7252",
"resource_name": "www.example.com",
"resource_type": "load_balancer",
"reference_type": "referrer"
},
{
"resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
"resource_name": "Login page monitor",
"resource_type": "monitor",
"reference_type": "referral"
}
]
}
]
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Load Balancer for www.example.com",
"name": "www.example.com",
"enabled": true,
"ttl": 30,
"fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
"default_pools": [
"17b5962d775c646f3f9725cbc7a53df4",
"9290f38c5d07c2e2f4df57b1f61d4196",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"region_pools": {
"WNAM": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"ENAM": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"pop_pools": {
"LAX": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"LHR": [
"abd90f38ced07c2e2f4df50b1f61d4194",
"f9138c5d07c2e2f4df57b1f61d4196"
],
"SJC": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"proxied": true,
"steering_policy": "dynamic_latency",
"session_affinity": "cookie",
"session_affinity_attributes": {
"samesite": "Auto",
"secure": "Auto"
},
"session_affinity_ttl": 5000
}
]
}| Name /type | Description /example | Constraints |
| name string | The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
| |
| default_pools array | A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
| |
| fallback_pool string | The pool ID to use when all other pools are detected as unhealthy.
|
|
| Name /type | Description /example | Constraints |
| steering_policy string | Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
|
|
| session_affinity_attributes object | Configure cookie attributes for session affinity cookie.
| |
| pop_pools object | (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
| |
| ttl number | Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
| |
| region_pools object | A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
| |
| session_affinity string | The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
|
|
| description string | Object description
| |
| proxied boolean | Whether the hostname should be gray clouded (false) or orange clouded (true).
|
|
| session_affinity_ttl number | Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto"},"session_affinity_ttl":5000}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Load Balancer for www.example.com",
"name": "www.example.com",
"enabled": true,
"ttl": 30,
"fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
"default_pools": [
"17b5962d775c646f3f9725cbc7a53df4",
"9290f38c5d07c2e2f4df57b1f61d4196",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"region_pools": {
"WNAM": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"ENAM": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"pop_pools": {
"LAX": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"LHR": [
"abd90f38ced07c2e2f4df50b1f61d4194",
"f9138c5d07c2e2f4df57b1f61d4196"
],
"SJC": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"proxied": true,
"steering_policy": "dynamic_latency",
"session_affinity": "cookie",
"session_affinity_attributes": {
"samesite": "Auto",
"secure": "Auto"
},
"session_affinity_ttl": 5000
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Load Balancer for www.example.com",
"name": "www.example.com",
"enabled": true,
"ttl": 30,
"fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
"default_pools": [
"17b5962d775c646f3f9725cbc7a53df4",
"9290f38c5d07c2e2f4df57b1f61d4196",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"region_pools": {
"WNAM": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"ENAM": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"pop_pools": {
"LAX": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"LHR": [
"abd90f38ced07c2e2f4df50b1f61d4194",
"f9138c5d07c2e2f4df57b1f61d4196"
],
"SJC": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"proxied": true,
"steering_policy": "dynamic_latency",
"session_affinity": "cookie",
"session_affinity_attributes": {
"samesite": "Auto",
"secure": "Auto"
},
"session_affinity_ttl": 5000
}
}| Name /type | Description /example | Constraints |
| name string | The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
| |
| default_pools array | A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
| |
| fallback_pool string | The pool ID to use when all other pools are detected as unhealthy.
|
|
| Name /type | Description /example | Constraints |
| steering_policy string | Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
|
|
| enabled boolean | Whether to enable (the default) this load balancer.
|
|
| session_affinity_attributes object | Configure cookie attributes for session affinity cookie.
| |
| pop_pools object | (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
| |
| ttl number | Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
| |
| region_pools object | A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
| |
| session_affinity string | The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
|
|
| description string | Object description
| |
| proxied boolean | Whether the hostname should be gray clouded (false) or orange clouded (true).
|
|
| session_affinity_ttl number | Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"enabled":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto"},"session_affinity_ttl":5000}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Load Balancer for www.example.com",
"name": "www.example.com",
"enabled": true,
"ttl": 30,
"fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
"default_pools": [
"17b5962d775c646f3f9725cbc7a53df4",
"9290f38c5d07c2e2f4df57b1f61d4196",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"region_pools": {
"WNAM": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"ENAM": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"pop_pools": {
"LAX": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"LHR": [
"abd90f38ced07c2e2f4df50b1f61d4194",
"f9138c5d07c2e2f4df57b1f61d4196"
],
"SJC": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"proxied": true,
"steering_policy": "dynamic_latency",
"session_affinity": "cookie",
"session_affinity_attributes": {
"samesite": "Auto",
"secure": "Auto"
},
"session_affinity_ttl": 5000
}
}| Name /type | Description /example | Constraints |
| steering_policy string | Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
|
|
| enabled boolean | Whether to enable (the default) this load balancer.
|
|
| session_affinity_attributes object | Configure cookie attributes for session affinity cookie.
| |
| pop_pools object | (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
| |
| name string | The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
| |
| ttl number | Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
| |
| region_pools object | A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
| |
| session_affinity string | The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
|
|
| default_pools array | A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
| |
| fallback_pool string | The pool ID to use when all other pools are detected as unhealthy.
|
|
| description string | Object description
| |
| proxied boolean | Whether the hostname should be gray clouded (false) or orange clouded (true).
|
|
| session_affinity_ttl number | Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"enabled":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto"},"session_affinity_ttl":5000}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"description": "Load Balancer for www.example.com",
"name": "www.example.com",
"enabled": true,
"ttl": 30,
"fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
"default_pools": [
"17b5962d775c646f3f9725cbc7a53df4",
"9290f38c5d07c2e2f4df57b1f61d4196",
"00920f38ce07c2e2f4df50b1f61d4194"
],
"region_pools": {
"WNAM": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"ENAM": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"pop_pools": {
"LAX": [
"de90f38ced07c2e2f4df50b1f61d4194",
"9290f38c5d07c2e2f4df57b1f61d4196"
],
"LHR": [
"abd90f38ced07c2e2f4df50b1f61d4194",
"f9138c5d07c2e2f4df57b1f61d4196"
],
"SJC": [
"00920f38ce07c2e2f4df50b1f61d4194"
]
},
"proxied": true,
"steering_policy": "dynamic_latency",
"session_affinity": "cookie",
"session_affinity_attributes": {
"samesite": "Auto",
"secure": "Auto"
},
"session_affinity_ttl": 5000
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"created_at": "2014-01-01T05:20:00.12345Z",
"modified_at": "2014-01-01T05:20:00.12345Z",
"cidr": "192.0.2.0/24",
"account_id": "01a7362d577a6c3019a474fd6f485823",
"description": "Internal test prefix",
"approved": "P",
"on_demand_enabled": true,
"advertised": true,
"advertised_modified_at": "2014-01-01T05:20:00.12345Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"created_at": "2014-01-01T05:20:00.12345Z",
"modified_at": "2014-01-01T05:20:00.12345Z",
"cidr": "192.0.2.0/24",
"account_id": "01a7362d577a6c3019a474fd6f485823",
"description": "Internal test prefix",
"approved": "P",
"on_demand_enabled": true,
"advertised": true,
"advertised_modified_at": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| description string | Description of the prefix
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"description":"Internal test prefix"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "9a7806061c88ada191ed06f989cc3dac",
"created_at": "2014-01-01T05:20:00.12345Z",
"modified_at": "2014-01-01T05:20:00.12345Z",
"cidr": "192.0.2.0/24",
"account_id": "01a7362d577a6c3019a474fd6f485823",
"description": "Internal test prefix",
"approved": "P",
"on_demand_enabled": true,
"advertised": true,
"advertised_modified_at": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/bgp/status" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"advertised": true,
"advertised_modified_at": "2014-01-01T05:20:00.12345Z"
}
}| Name /type | Description /example | Constraints |
| advertised boolean | Enablement of prefix advertisement to the Internet.
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/bgp/status" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"advertised":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"advertised": true,
"advertised_modified_at": "2014-01-01T05:20:00.12345Z"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "d933b1530bc56c9953cf8ce166da8004",
"created_at": "2014-01-01T05:20:00.12345Z",
"modified_at": "2014-01-01T05:20:00.12345Z",
"cidr": "192.0.2.0/24",
"delegated_account_id": "b1946ac92492d2347c6235b4d2611184",
"parent_prefix_id": "9a7806061c88ada191ed06f989cc3dac"
}
]
}| Name /type | Description /example | Constraints |
| cidr string | IP Prefix in Classless Inter-Domain Routing format
| |
| delegated_account_id string | Account identifier for the account to which prefix is being delegated
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"cidr":"192.0.2.0/24","delegated_account_id":"b1946ac92492d2347c6235b4d2611184"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "d933b1530bc56c9953cf8ce166da8004",
"created_at": "2014-01-01T05:20:00.12345Z",
"modified_at": "2014-01-01T05:20:00.12345Z",
"cidr": "192.0.2.0/24",
"delegated_account_id": "b1946ac92492d2347c6235b4d2611184",
"parent_prefix_id": "9a7806061c88ada191ed06f989cc3dac"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations/d933b1530bc56c9953cf8ce166da8004" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| direction string | Direction to order Railguns
|
|
curl -X GET "https://api.cloudflare.com/client/v4/railguns?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"status": "active",
"enabled": true,
"zones_connected": 2,
"build": "b1234",
"version": "2.1",
"revision": "123",
"activation_key": "e4edc00281cb56ebac22c81be9bac8f3",
"activated_on": "2014-01-02T02:20:00Z",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
]
}| Name /type | Description /example | Constraints |
| name string | Readable identifier of the railgun
|
|
curl -X POST "https://api.cloudflare.com/client/v4/railguns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Railgun"}'{
"success": true,
"errors": [],
"messages": []
}curl -X GET "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| enabled boolean | Flag to determine if the Railgun is accepting connections
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":true}'{
"success": true,
"errors": [],
"messages": []
}curl -X DELETE "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "e928d310693a83094309acf9ead50448"
}
}curl -X GET "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448/zones" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"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"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"enabled": true,
"connected": true
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"enabled": true,
"connected": true
}
}| Name /type | Description /example | Constraints |
| connected boolean | A flag indicating whether the given zone is connected to the Railgun
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"connected":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"enabled": true,
"connected": true
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448/diagnose" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"method": "GET",
"host_name": "www.example.com",
"http_status": 200,
"railgun": "on",
"url": "https://www.cloudflare.com",
"response_status": "200 OK",
"protocol": "HTTP/1.1",
"elapsed_time": "0.239013s",
"body_size": "63910 bytes",
"body_hash": "be27f2429421e12f200cab1da43ba301bdc70e1d",
"missing_headers": "No Content-Length or Transfer-Encoding",
"connection_close": false,
"cloudflare": "on",
"cf-ray": "1ddd7570575207d9-LAX",
"cf-wan-error": null,
"cf-cache-status": null
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| direction | Direction to order Railguns
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"status": "active",
"enabled": true,
"zones_connected": 2,
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z",
"activation": {
"key": "e4edc00281cb56ebac22c81be9bac8f3",
"activated_on": "2014-01-02T02:20:00Z",
"version": {
"number": "2.1",
"build": "b1234",
"revision": "123"
}
}
}
]
}| Name /type | Description /example | Constraints |
| name string | Readable identifier of the railgun
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Railgun"}'{
"success": true,
"errors": [],
"messages": []
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}| Name /type | Description /example | Constraints |
| enabled boolean | Flag to determine if the Railgun is accepting connections
|
|
| name string | Readable identifier of the railgun
|
|
| zones_connected number | The number of zones using this railgun
|
|
| status string | Status of the railgun
|
|
| activation object |
|
|
| id string | Railgun identifier tag
|
|
| Name /type | Description /example | Constraints |
| upgrade_info object | Defined when the Railgun version is out of date from the latest release from Cloudflare
| |
| modified_on string (date-time) | When the Railgun was last modified
|
|
| created_on string (date-time) | When the Railgun was created
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"e928d310693a83094309acf9ead50448","name":"My Railgun","status":"active","enabled":true,"zones_connected":2,"created_on":"2014-01-01T05:20:00Z","modified_on":"2014-01-01T05:20:00Z","activation":{"key":"e4edc00281cb56ebac22c81be9bac8f3","activated_on":"2014-01-02T02:20:00Z","version":{"number":"2.1","build":"b1234","revision":"123"}}}'{
"success": true,
"errors": [],
"messages": []
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "e928d310693a83094309acf9ead50448"
}
}| Name /type | Description /example | Constraints |
| page number | Requested page within paginated list of results
| |
| per_page number | Maximum number of results requested
| |
| enabled boolean | A value indicating whether the connection is enabled or not
|
|
curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections?page=1&per_page=20&enabled=true" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "c4a7362d577a6c3019a474fd6f485821",
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"enabled": true,
"created_on": "2017-06-14T00:00:00Z",
"modified_on": "2017-06-14T05:20:00Z"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "c4a7362d577a6c3019a474fd6f485821",
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"enabled": true,
"created_on": "2017-06-14T00:00:00Z",
"modified_on": "2017-06-14T05:20:00Z"
}
}| Name /type | Description /example | Constraints |
| id string | Connection identifier tag
|
|
| zone object |
| |
| enabled boolean | A value indicating whether the connection is enabled or not
|
|
| Name /type | Description /example | Constraints |
| created_on string (date-time) | When the connection was created
|
|
| modified_on string (date-time) | When the connection was last modified
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":"c4a7362d577a6c3019a474fd6f485821","zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"enabled":true,"created_on":"2017-06-14T00:00:00Z","modified_on":"2017-06-14T05:20:00Z"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "c4a7362d577a6c3019a474fd6f485821",
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"enabled": true,
"created_on": "2017-06-14T00:00:00Z",
"modified_on": "2017-06-14T05:20:00Z"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "c4a7362d577a6c3019a474fd6f485821"
}
}| Name /type | Description /example | Constraints |
| zone |
|
| Name /type | Description /example | Constraints |
| enabled boolean | A value indicating whether the connection is enabled or not
|
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353"},"enabled":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "c4a7362d577a6c3019a474fd6f485821",
"zone": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com"
},
"enabled": true,
"created_on": "2017-06-14T00:00:00Z",
"modified_on": "2017-06-14T05:20:00Z"
}
}| Code | Description |
Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| direction | Direction to order Railguns
|
|
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns?page=1&per_page=20&direction=desc" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "e928d310693a83094309acf9ead50448",
"name": "My Railgun",
"status": "active",
"enabled": true,
"zones_connected": 2,
"build": "b1234",
"version": "2.1",
"revision": "123",
"activation_key": "e4edc00281cb56ebac22c81be9bac8f3",
"activated_on": "2014-01-02T02:20:00Z",
"created_on": "2014-01-01T05:20:00Z",
"modified_on": "2014-01-01T05:20:00Z"
}
]
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| name string | Readable identifier of the railgun
|
|
curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"My Railgun"}'{
"success": true,
"errors": [],
"messages": []
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": []
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
| Name /type | Description /example | Constraints |
| enabled boolean | Flag to determine if the Railgun is accepting connections
|
|
curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"enabled":true}'{
"success": true,
"errors": [],
"messages": []
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "e928d310693a83094309acf9ead50448"
}
}End of life Date: February 4, 2020
This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/zones" \
-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"
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages/basic_challenge" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
}| Name /type | Description /example | Constraints |
| url string (url) | A URL that is associated with the Custom Page.
|
|
| state | The Custom Page state
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages/basic_challenge" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"url":"http://www.example.com","state":"default"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"url": "http://www.example.com",
"state": "default",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"preview_target": "preview:target",
"description": true
}
}| Code | Description |
| 1000 | Invalid user |
| 1001 | Invalid request. Could not connect to database |
| 1002 | Validator dispatcher expects an array |
| 1006 | Cannot find a valid customization page |
| 1007 | Invalid validation method being called |
| 1200 | A URL is required |
| 1201 | The URL provided seems to be irregular |
| 1202 | Unable to grab the content for the URL provided. Please try again. |
| 1203 | Your custom page must be larger than <characters> characters |
| 1204 | Your custom page must be smaller than <characters> characters |
| 1205 | A <token> token was not detected on the error page, and must be added before this page can be integrated into Cloudflare. The default error page will show until this is corrected and rescanned. |
| 1206 | Could not find a valid zone |
| 1207 | That customization page is not modifiable |
| 1208 | An unknown error has occurred and has been logged. We will fix this problem promptly. We apologize for the inconvenience. |
| 1209 | Could not find a valid customization page for this operation |
| 1210 | That operation is no longer allowed for that domain. |
| 1211 | Could not find a valid customization page to disable |
| 1212 | An undocumented error has occurred and has been logged. |
| 1213 | That operation has already been performed for this challenge/error. |
| 1214 | Rate limit reached for this operation. Please try again in a minute |
| 1215 | Rate limit reached for this operation. Please try again in a minute |
| 1217 | Invalid state passed |
| 1218 | Missing Custom Page state |
| 1219 | Please upgrade to access this feature |
| 1220 | We were unable to scan the page provided. Please ensure it is accessible publicly and is larger than 100 characters |
curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Widget Corps Internal Applications",
"auth_domain": "test.cloudflareaccess.com",
"login_design": {
"background_color": "#c5ed1b",
"text_color": "#c5ed1b",
"logo_path": "https://example.com/logo.png"
}
}
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Organization.
| |
| auth_domain string | The domain that you will be redirected to on Access login attempts
|
| Name /type | Description /example | Constraints |
| login_design |
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Widget Corps Internal Applications",
"auth_domain": "test.cloudflareaccess.com",
"login_design": {
"background_color": "#c5ed1b",
"text_color": "#c5ed1b",
"logo_path": "https://example.com/logo.png"
}
}
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Organization.
| |
| auth_domain string | The domain that you will be redirected to on Access login attempts
| |
| login_design |
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Widget Corps Internal Applications",
"auth_domain": "test.cloudflareaccess.com",
"login_design": {
"background_color": "#c5ed1b",
"text_color": "#c5ed1b",
"logo_path": "https://example.com/logo.png"
}
}
}| Name /type | Description /example | Constraints |
| email string | The email of the user to revoke
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations/revoke_user" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"email":"test@example.com"}'{
"success": true,
"result": true
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "Widget Corps OTP",
"type": "onetimepin",
"config": {}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "Widget Corps OTP",
"type": "onetimepin",
"config": {}
}
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Identity Provider.
| |
| type string | The type of Identity Provider
| |
| config object | The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "Widget Corps OTP",
"type": "onetimepin",
"config": {}
}
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Identity Provider.
| |
| type string | The type of Identity Provider
| |
| config object | The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "Widget Corps OTP",
"type": "onetimepin",
"config": {}
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "Widget Corps OTP",
"type": "onetimepin",
"config": {}
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}| Name /type | Description /example | Constraints |
| name string | The name of the group. Only used in the UI.
| |
| include array | The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
|
| Name /type | Description /example | Constraints |
| exclude array | The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
| |
| require array | The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}| Name /type | Description /example | Constraints |
| name string | The name of the group. Only used in the UI.
| |
| include array | The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
|
| Name /type | Description /example | Constraints |
| exclude array | The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
| |
| require array | The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "CI/CD token",
"client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
}
]
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Service Token.
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"CI/CD token"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "CI/CD token",
"client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com",
"client_secret": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5"
}
}| Name /type | Description /example | Constraints |
| name string | The name of your Access Service Token.
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"CI/CD token"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "CI/CD token",
"client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "CI/CD token",
"client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"expires_on": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
"associated_hostnames": [
"admin.example.com"
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"expires_on": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
"associated_hostnames": [
"admin.example.com"
]
}
}| Name /type | Description /example | Constraints |
| name string | The name of the Certificate. Only used in the UI.
| |
| certificate string | The Root CA for your certificates
|
| Name /type | Description /example | Constraints |
| associated_hostnames array | The hostnames that will be prompted for this certificate.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Allow devs","certificate":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","associated_hostnames":["admin.example.com"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"expires_on": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
"associated_hostnames": [
"admin.example.com"
]
}
}| Name /type | Description /example | Constraints |
| name string | The name of the Certificate. Only used in the UI.
| |
| associated_hostnames array | The hostnames that will be prompted for this certificate.
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Allow devs","associated_hostnames":["admin.example.com"]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"expires_on": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
"associated_hostnames": [
"admin.example.com"
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
"name": "Admin Site",
"domain": "test.example.com/admin",
"session_duration": "24h",
"allowed_idps": [
"699d98642c564d2e855e9661899b7252"
],
"auto_redirect_to_identity": false
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
"name": "Admin Site",
"domain": "test.example.com/admin",
"session_duration": "24h",
"allowed_idps": [
"699d98642c564d2e855e9661899b7252"
],
"auto_redirect_to_identity": false
}
}| Name /type | Description /example | Constraints |
| name string | The name of the Application.
| |
| domain string | The domain and path that Access will block
|
| Name /type | Description /example | Constraints |
| session_duration string | Defines the amount of time that the tokens issued for this application will be valid
|
|
| allowed_idps array | The identity providers selected for application
| |
| auto_redirect_to_identity boolean | Option to skip identity provider selection if only one is configured in allowed_idps.
|
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Admin Site","domain":"test.example.com/admin","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
"name": "Admin Site",
"domain": "test.example.com/admin",
"session_duration": "24h",
"allowed_idps": [
"699d98642c564d2e855e9661899b7252"
],
"auto_redirect_to_identity": false
}
}| Name /type | Description /example | Constraints |
| name string | The name of the Application.
| |
| domain string | The domain and path that Access will block
|
| Name /type | Description /example | Constraints |
| session_duration string | Defines the amount of time that the tokens issued for this application will be valid
|
|
| allowed_idps array | The identity providers selected for application
| |
| auto_redirect_to_identity boolean | Option to skip identity provider selection if only one is configured in allowed_idps.
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"Admin Site","domain":"test.example.com/admin","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
"name": "Admin Site",
"domain": "test.example.com/admin",
"session_duration": "24h",
"allowed_idps": [
"699d98642c564d2e855e9661899b7252"
],
"auto_redirect_to_identity": false
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
}curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/revoke-tokens" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": "1",
"decision": "allow",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": "1",
"decision": "allow",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}| Name /type | Description /example | Constraints |
| decision string | Defines the action Access will take if the policy matches the user.
|
|
| name string | The name of the policy. Only used in the UI.
| |
| include array | The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
|
| Name /type | Description /example | Constraints |
| precedence integer | The unique precedence for policies on a single application
| |
| exclude array | The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
| |
| require array | The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"precedence":"1","decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": "1",
"decision": "allow",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}| Name /type | Description /example | Constraints |
| decision string | Defines the action Access will take if the policy matches the user.
|
|
| name string | The name of the policy. Only used in the UI.
| |
| include array | The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
|
| Name /type | Description /example | Constraints |
| precedence integer | The unique precedence for policies on a single application
| |
| exclude array | The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
| |
| require array | The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"precedence":"1","decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": "1",
"decision": "allow",
"created_at": "2014-01-01T05:20:00.12345Z",
"updated_at": "2014-01-01T05:20:00.12345Z",
"name": "Allow devs",
"include": [
{
"email": {
"email": "test@example.com"
}
}
],
"exclude": [
{
"email": {
"email": "test@example.com"
}
}
],
"require": [
{
"email": {
"email": "test@example.com"
}
}
]
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
}| Name /type | Description /example | Constraints |
| page number | Page number of paginated results
|
|
| per_page number | Number of items per page
|
|
| name string | Filter health checks with name partially matching this string
|
curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks?page=1&per_page=25&name=server-1" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
]
}| Name /type | Description /example | Constraints |
| name string | A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| address string | The hostname or IP address of the origin server to run health checks on.
|
| Name /type | Description /example | Constraints |
| consecutive_fails integer | The number of consecutive fails required from a health check before changing the health to unhealthy
|
|
| tcp_config objectnull | Parameters specific to TCP health check
| |
| timeout integer | The timeout (in seconds) before marking the health check as failed.
|
|
| interval integer | The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| check_regions arraynull | A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
| |
| notification objectnull | Notifications are sent when the status of a health check changes.
| |
| http_config objectnull | Parameters specific to an HTTP or HTTPS health check
| |
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
|
|
| suspended boolean | If suspended, no health checks are sent to the origin.
|
|
| consecutive_successes integer | The number of consecutive successes required from a health check before changing the health to healthy
|
|
| description string | A human-readable description of the health check.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}| Name /type | Description /example | Constraints |
| name string | A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| address string | The hostname or IP address of the origin server to run health checks on.
|
| Name /type | Description /example | Constraints |
| consecutive_fails integer | The number of consecutive fails required from a health check before changing the health to unhealthy
|
|
| tcp_config objectnull | Parameters specific to TCP health check
| |
| timeout integer | The timeout (in seconds) before marking the health check as failed.
|
|
| interval integer | The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| check_regions arraynull | A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
| |
| notification objectnull | Notifications are sent when the status of a health check changes.
| |
| http_config objectnull | Parameters specific to an HTTP or HTTPS health check
| |
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
|
|
| suspended boolean | If suspended, no health checks are sent to the origin.
|
|
| consecutive_successes integer | The number of consecutive successes required from a health check before changing the health to healthy
|
|
| description string | A human-readable description of the health check.
|
curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}| Name /type | Description /example | Constraints |
| name string | A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| address string | The hostname or IP address of the origin server to run health checks on.
|
| Name /type | Description /example | Constraints |
| consecutive_fails integer | The number of consecutive fails required from a health check before changing the health to unhealthy
|
|
| tcp_config objectnull | Parameters specific to TCP health check
| |
| timeout integer | The timeout (in seconds) before marking the health check as failed.
|
|
| interval integer | The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| check_regions arraynull | A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
| |
| notification objectnull | Notifications are sent when the status of a health check changes.
| |
| http_config objectnull | Parameters specific to an HTTP or HTTPS health check
| |
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
|
|
| suspended boolean | If suspended, no health checks are sent to the origin.
|
|
| consecutive_successes integer | The number of consecutive successes required from a health check before changing the health to healthy
|
|
| description string | A human-readable description of the health check.
|
curl -X PATCH "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252"
}
}| Name /type | Description /example | Constraints |
| name string | A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
| |
| address string | The hostname or IP address of the origin server to run health checks on.
|
| Name /type | Description /example | Constraints |
| consecutive_fails integer | The number of consecutive fails required from a health check before changing the health to unhealthy
|
|
| tcp_config objectnull | Parameters specific to TCP health check
| |
| timeout integer | The timeout (in seconds) before marking the health check as failed.
|
|
| interval integer | The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
|
|
| retries integer | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
|
|
| check_regions arraynull | A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
| |
| notification objectnull | Notifications are sent when the status of a health check changes.
| |
| http_config objectnull | Parameters specific to an HTTP or HTTPS health check
| |
| type string | The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
|
|
| suspended boolean | If suspended, no health checks are sent to the origin.
|
|
| consecutive_successes integer | The number of consecutive successes required from a health check before changing the health to healthy
|
|
| description string | A human-readable description of the health check.
|
curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "server-1",
"description": "Health check for www.example.com",
"suspended": false,
"notification": {
"suspended": false,
"email_addresses": [
"alert@example.com",
"oncall@example.com"
],
"trigger": "FAIL"
},
"check_regions": [
"WEU",
"ENAM"
],
"type": "HTTPS",
"consecutive_successes": 1,
"consecutive_fails": 1,
"http_config": {
"method": "GET",
"port": 80,
"path": "/health",
"expected_codes": [
"2xx",
"302"
],
"expected_body": "success",
"follow_redirects": false,
"allow_insecure": false,
"header": {
"Host": [
"example.com"
],
"X-App-ID": [
"abc123"
]
}
},
"tcp_config": {
"method": "connection_established",
"port": 80
},
"timeout": 5,
"retries": 2,
"interval": 60,
"address": "www.example.com",
"status": "healthy",
"failure_reason": ""
}
}curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview/699d98642c564d2e855e9661899b7252" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "699d98642c564d2e855e9661899b7252"
}
}| Name /type | Description /example | Constraints |
| id array | List of domain names
|
curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"id":["cloudflare.com","cloudflare.net"]}'{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "ea95132c15732412d22c1476fa83f27a",
"available": false,
"supported_tld": true,
"can_register": false,
"transfer_in": {
"unlock_domain": "ok",
"disable_privacy": "ok",
"enter_auth_code": "needed",
"approve_transfer": "unknown",
"accept_foa": "needed",
"can_cancel_transfer": true
},
"current_registrar": "Cloudflare",
"expires_at": "2019-08-28T23:59:59Z",
"registry_statuses": "ok,serverTransferProhibited",
"locked": false,
"created_at": "2018-08-28T17:26:26Z",
"updated_at": "2018-08-28T17:26:26Z",
"registrant_contact": {
"id": "ea95132c15732412d22c1476fa83f27a",
"first_name": "John",
"last_name": "Appleseed",
"organization": "Cloudflare, Inc.",
"address": "123 Sesame St.",
"address2": "Suite 430",
"city": "Austin",
"state": "TX",
"zip": "12345",
"country": "US",
"phone": "+1 123-123-1234",
"email": "user@example.com",
"fax": "123-867-5309"
}
}
]
}curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains/cloudflare.com" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json"{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a",
"available": false,
"supported_tld": true,
"can_register": false,
"transfer_in": {
"unlock_domain": "ok",
"disable_privacy": "ok",
"enter_auth_code": "needed",
"approve_transfer": "unknown",
"accept_foa": "needed",
"can_cancel_transfer": true
},
"current_registrar": "Cloudflare",
"expires_at": "2019-08-28T23:59:59Z",
"registry_statuses": "ok,serverTransferProhibited",
"locked": false,
"created_at": "2018-08-28T17:26:26Z",
"updated_at": "2018-08-28T17:26:26Z",
"registrant_contact": {
"id": "ea95132c15732412d22c1476fa83f27a",
"first_name": "John",
"last_name": "Appleseed",
"organization": "Cloudflare, Inc.",
"address": "123 Sesame St.",
"address2": "Suite 430",
"city": "Austin",
"state": "TX",
"zip": "12345",
"country": "US",
"phone": "+1 123-123-1234",
"email": "user@example.com",
"fax": "123-867-5309"
}
}
}| Name /type | Description /example | Constraints |
| name_servers array | List of name servers
| |
| privacy boolean | Privacy option controls redacting WHOIS information
|
|
| locked boolean | Whether a registrar lock in place for this domain
|
|
| auto_renew boolean | Auto-renew controls whether subscription is automatically renewed upon domain expiration
|
|
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains/cloudflare.com" \
-H "X-Auth-Email: user@example.com" \
-H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
-H "Content-Type: application/json" \
--data '{"name_servers":["preston.ns.cloudflare.com","oli.ns.cloudflare.com"],"privacy":true,"locked":false,"auto_renew":true}'{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": "ea95132c15732412d22c1476fa83f27a",
"available": false,
"supported_tld": true,
"can_register": false,
"transfer_in": {
"unlock_domain": "ok",
"disable_privacy": "ok",
"enter_auth_code": "needed",
"approve_transfer": "unknown",
"accept_foa": "needed",
"can_cancel_transfer": true
},
"current_registrar": "Cloudflare",
"expires_at": "2019-08-28T23:59:59Z",
"registry_statuses": "ok,serverTransferProhibited",
"locked": false,
"created_at": "2018-08-28T17:26:26Z",
"updated_at": "2018-08-28T17:26:26Z",
"registrant_contact": {
"id": "ea95132c15732412d22c1476fa83f27a",
"first_name": "John",
"last_name": "Appleseed",
"organization": "Cloudflare, Inc.",
"address": "123 Sesame St.",
"address2": "Suite 430",
"city": "Austin",
"state": "TX",
"zip": "12345",
"country": "US",
"phone": "+1 123-123-1234",
"email": "user@example.com",
"fax": "123-867-5309"
}
}
}| Code | Description |
| 10000 | Internal Server Error |
| 10001 | Authentication Failure |