Lists, searches, sorts, and filters your zones.
/zones
get
Zone
zones-get
nullnull[
{
"examples": {
"Basic Query": {
"summary": "Simple Query",
"value": "example.com"
},
"Contains Query": {
"summary": "Contains Query",
"value": "contains:.org"
},
"Ends With Query": {
"summary": "Ends With Query",
"value": "ends_with:arpa"
},
"Starts With Query": {
"summary": "Starts With Query",
"value": "starts_with:dev"
}
},
"in": "query",
"name": "name",
"schema": {
"description": "A domain name. Optional filter operators can be provided to extend refine the search:\n * `equal` (default)\n * `not_equal`\n * `starts_with`\n * `ends_with`\n * `contains`\n * `starts_with_case_sensitive`\n * `ends_with_case_sensitive`\n * `contains_case_sensitive`\n",
"maxLength": 253,
"type": "string"
}
},
{
"in": "query",
"name": "status",
"schema": {
"description": "A zone status",
"enum": [
"initializing",
"pending",
"active",
"moved"
],
"type": "string"
}
},
{
"in": "query",
"name": "account.id",
"schema": {
"description": "An account ID",
"type": "string"
}
},
{
"examples": {
"Basic Query": {
"summary": "Simple Query",
"value": "Dev Account"
},
"Contains Query": {
"summary": "Contains Query",
"value": "contains:Test"
}
},
"in": "query",
"name": "account.name",
"schema": {
"description": "An account Name. Optional filter operators can be provided to extend refine the search:\n * `equal` (default)\n * `not_equal`\n * `starts_with`\n * `ends_with`\n * `contains`\n * `starts_with_case_sensitive`\n * `ends_with_case_sensitive`\n * `contains_case_sensitive`\n",
"maxLength": 253,
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 20,
"description": "Number of zones per page.",
"maximum": 50,
"minimum": 5,
"type": "number"
}
},
{
"in": "query",
"name": "order",
"schema": {
"description": "Field to order zones by.",
"enum": [
"name",
"status",
"account.id",
"account.name"
],
"example": "status",
"type": "string"
}
},
{
"in": "query",
"name": "direction",
"schema": {
"description": "Direction to order zones.",
"enum": [
"asc",
"desc"
],
"example": "desc",
"type": "string"
}
},
{
"in": "query",
"name": "match",
"schema": {
"default": "all",
"description": "Whether to match all search requirements or at least one (any).",
"enum": [
"any",
"all"
],
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"success": {
"description": "Whether the API call was successful",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
},
{
"properties": {
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
},
{
"properties": {
"result": {
"items": {
"properties": {
"account": {
"description": "The account the zone belongs to",
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"type": "string"
},
"name": {
"description": "The name of the account",
"example": "Example Account Name",
"type": "string"
}
},
"type": "object"
},
"activated_on": {
"description": "The last time proof of ownership was detected and the zone was made\nactive",
"example": "2014-01-02T00:01:00.12345Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"created_on": {
"description": "When the zone was created",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"development_mode": {
"description": "The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.",
"example": 7200,
"readOnly": true,
"type": "number"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"type": "string"
},
"meta": {
"description": "Metadata about the zone",
"properties": {
"cdn_only": {
"description": "The zone is only configured for CDN",
"example": true,
"type": "boolean"
},
"custom_certificate_quota": {
"description": "Number of Custom Certificates the zone can have",
"example": 1,
"type": "integer"
},
"dns_only": {
"description": "The zone is only configured for DNS",
"example": true,
"type": "boolean"
},
"foundation_dns": {
"description": "The zone is setup with Foundation DNS",
"example": true,
"type": "boolean"
},
"page_rule_quota": {
"description": "Number of Page Rules a zone can have",
"example": 100,
"type": "integer"
},
"phishing_detected": {
"description": "The zone has been flagged for phishing",
"example": false,
"type": "boolean"
},
"step": {
"example": 2,
"type": "integer"
}
},
"type": "object"
},
"modified_on": {
"description": "When the zone was last modified",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The domain name",
"example": "example.com",
"maxLength": 253,
"pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$",
"type": "string"
},
"original_dnshost": {
"description": "DNS host at the time of switching to Cloudflare",
"example": "NameCheap",
"maxLength": 50,
"nullable": true,
"readOnly": true,
"type": "string"
},
"original_name_servers": {
"description": "Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?",
"example": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"items": {
"format": "hostname",
"type": "string"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"original_registrar": {
"description": "Registrar for the domain at the time of switching to Cloudflare",
"example": "GoDaddy",
"nullable": true,
"readOnly": true,
"type": "string"
},
"owner": {
"description": "The owner of the zone",
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"type": "string"
},
"name": {
"description": "Name of the owner",
"example": "Example Org",
"type": "string"
},
"type": {
"description": "The type of owner",
"example": "organization",
"type": "string"
}
},
"type": "object"
},
"vanity_name_servers": {
"description": "An array of domains used for custom name servers. This is only available for Business and Enterprise plans.",
"example": [
"ns1.example.com",
"ns2.example.com"
],
"items": {
"format": "hostname",
"maxLength": 253,
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"development_mode",
"owner",
"account",
"meta",
"original_name_servers",
"original_registrar",
"original_dnshost",
"created_on",
"modified_on",
"activated_on"
],
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List Zones response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "List Zones response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]