Organization API: DNS

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled The organization's zones by domain, each with its recordcount

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The organization's zones by domain, each with its recordcount

GET /api/v1/orgs/{org_slug}/dns/zones

The organization's zones by domain, each with its record_count.

The search, status and DNSSEC filters run in the query, before the page is cut. Without with_total the answer is the bare list it always was. With it, total is counted from the clause the page is cut from, counts has all and each status for the search and the DNSSEC filter, and dnssec has signed and off for the search and the status filter: the numbers the list's two filters show.

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`page`	query	integer	no	Default: `1`.
`per_page`	query	integer	no	Default: `25`.
`q`	query	string or null	no	Part of the domain or the SOA contact, or a zone number.
`status`	query	string or null	no	One zone status. Left out, every status.
`dnssec`	query	string or null	no	`signed` for the zones DNSSEC signs, `off` for the others. Left out, both.
`limit`	query	integer or null	no	Rows per page, with `offset`, in place of `page` and `per_page`.
`offset`	query	integer or null	no	Rows to skip, with `limit`.
`with_total`	query	boolean	no	Answers `{items, total, limit, offset, counts, dnssec}` instead of a bare list. Default: `False`.

Responses

Section titled Create zone

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create zone

POST /api/v1/orgs/{org_slug}/dns/zones

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`domain`	string	yes

Responses

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`service_id`	integer or null
`user_id`	integer
`org_id`	integer or null
`domain`	string
`status`	string
`dnssec_enabled`	boolean
`serial`	integer
`soa_email`	string
`record_count`	integer or null
`record_limit`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Get zone

Section titled Get zone

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Update zone

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`service_id`	integer or null
`user_id`	integer
`org_id`	integer or null
`domain`	string
`status`	string
`dnssec_enabled`	boolean
`serial`	integer
`soa_email`	string
`record_count`	integer or null
`record_limit`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Update zone

PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`soa_email`	string or null	no

Responses

Section titled Delete zone

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`service_id`	integer or null
`user_id`	integer
`org_id`	integer or null
`domain`	string
`status`	string
`dnssec_enabled`	boolean
`serial`	integer
`soa_email`	string
`record_count`	integer or null
`record_limit`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Delete zone

DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Get DNSSEC info

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get DNSSEC info

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/dnssec

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Export zone

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`enabled`	boolean
`algorithm`	string
`ksk_key_tag`	integer or null
`zsk_key_tag`	integer or null
`ds_records`	array of string
`zsk_rotated_at`	string (date-time) or null

Export zone

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/export

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Import zone

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Import zone

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/import

Add the records of a BIND zone file, such as another DNS host's export, to the organization's zone.

It needs an organization admin. Only the records the zone does not have are added, and the file is read as the account import reads it, a Cloudflare export and its cf-proxied tags included. The answer has the same imported, proxied, duplicates, notes and errors. A zone the organization does not hold answers 404.

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`zone_file`	string	yes

Responses

Section titled List LB pools

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List LB pools

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Create LB pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].zone_id`	integer
`[].name`	string
`[].description`	string or null
`[].hostname`	string or null
`[].algorithm`	string
`[].ttl`	integer
`[].session_affinity`	string
`[].primary_location_code`	string or null
`[].enabled`	boolean
`[].members`	array of LbMemberResponse
`[].members[].id`	integer
`[].members[].pool_id`	integer
`[].members[].address`	string
`[].members[].address_type`	string
`[].members[].weight`	integer
`[].members[].priority`	integer
`[].members[].enabled`	boolean
`[].members[].health_mode`	string
`[].members[].health_port`	integer or null
`[].members[].health_path`	string
`[].members[].health_interval_s`	integer
`[].members[].health_timeout_s`	integer
`[].members[].health_status`	string
`[].members[].last_check_at`	string (date-time) or null
`[].members[].last_error`	string or null
`[].members[].created_at`	string (date-time)
`[].members[].updated_at`	string (date-time)
`[].healthy_members`	integer or null
`[].total_members`	integer or null
`[].created_at`	string (date-time)
`[].updated_at`	string (date-time)

Create LB pool

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`description`	string or null	no
`hostname`	string or null	no
`algorithm`	string	no
`ttl`	integer	no
`session_affinity`	string	no
`primary_location_code`	string or null	no
`enabled`	boolean	no

Responses

Section titled Get LB pool

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Get LB pool

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Update LB pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Update LB pool

PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string or null	no
`description`	string or null	no
`algorithm`	string or null	no
`ttl`	integer or null	no
`session_affinity`	string or null	no
`primary_location_code`	string or null	no
`enabled`	boolean or null	no

Responses

Section titled Delete LB pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Delete LB pool

DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org list lbs

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org list lbs

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org create LB

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].zone_id`	integer
`[].name`	string
`[].hostname`	string
`[].enabled`	boolean
`[].ttl`	integer
`[].session_affinity`	string
`[].steering_policy`	string
`[].location_strategy`	string
`[].fallback_pool_id`	integer or null
`[].default_pools`	array of integer
`[].location_pools`	Location Pools
`[].country_pools`	Country Pools
`[].region_pools`	Region Pools
`[].created_at`	string (date-time)
`[].updated_at`	string (date-time)

Org create LB

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`hostname`	string	yes
`ttl`	integer	no
`session_affinity`	string	no
`steering_policy`	string	no
`location_strategy`	string	no
`default_pools`	array of integer	no
`fallback_pool_id`	integer or null	no
`location_pools`	Location Pools	no
`country_pools`	Country Pools	no
`region_pools`	Region Pools	no
`enabled`	boolean	no

Responses

Section titled Org get LB

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`hostname`	string
`enabled`	boolean
`ttl`	integer
`session_affinity`	string
`steering_policy`	string
`location_strategy`	string
`fallback_pool_id`	integer or null
`default_pools`	array of integer
`location_pools`	Location Pools
`country_pools`	Country Pools
`region_pools`	Region Pools
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org get LB

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers/{lb_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`lb_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org update LB

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`hostname`	string
`enabled`	boolean
`ttl`	integer
`session_affinity`	string
`steering_policy`	string
`location_strategy`	string
`fallback_pool_id`	integer or null
`default_pools`	array of integer
`location_pools`	Location Pools
`country_pools`	Country Pools
`region_pools`	Region Pools
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org update LB

PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers/{lb_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`lb_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string or null	no
`hostname`	string or null	no
`ttl`	integer or null	no
`session_affinity`	string or null	no
`steering_policy`	string or null	no
`location_strategy`	string or null	no
`default_pools`	array of integer or null	no
`fallback_pool_id`	integer or null	no
`location_pools`	object or null	no
`country_pools`	object or null	no
`region_pools`	object or null	no
`enabled`	boolean or null	no

Responses

Section titled Org delete LB

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`hostname`	string
`enabled`	boolean
`ttl`	integer
`session_affinity`	string
`steering_policy`	string
`location_strategy`	string
`fallback_pool_id`	integer or null
`default_pools`	array of integer
`location_pools`	Location Pools
`country_pools`	Country Pools
`region_pools`	Region Pools
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org delete LB

DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers/{lb_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`lb_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org preview LB

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org preview LB

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/load-balancers/{lb_id}/preview

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`lb_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`from_location`	string or null	no
`from_ip`	string or null	no
`qtype`	string	no

Responses

Section titled Org list pools

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Org list pools

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org create pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].zone_id`	integer
`[].name`	string
`[].description`	string or null
`[].hostname`	string or null
`[].algorithm`	string
`[].ttl`	integer
`[].session_affinity`	string
`[].primary_location_code`	string or null
`[].enabled`	boolean
`[].members`	array of LbMemberResponse
`[].members[].id`	integer
`[].members[].pool_id`	integer
`[].members[].address`	string
`[].members[].address_type`	string
`[].members[].weight`	integer
`[].members[].priority`	integer
`[].members[].enabled`	boolean
`[].members[].health_mode`	string
`[].members[].health_port`	integer or null
`[].members[].health_path`	string
`[].members[].health_interval_s`	integer
`[].members[].health_timeout_s`	integer
`[].members[].health_status`	string
`[].members[].last_check_at`	string (date-time) or null
`[].members[].last_error`	string or null
`[].members[].created_at`	string (date-time)
`[].members[].updated_at`	string (date-time)
`[].healthy_members`	integer or null
`[].total_members`	integer or null
`[].created_at`	string (date-time)
`[].updated_at`	string (date-time)

Org create pool

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`description`	string or null	no
`hostname`	string or null	no
`algorithm`	string	no
`ttl`	integer	no
`session_affinity`	string	no
`primary_location_code`	string or null	no
`enabled`	boolean	no

Responses

Section titled Org get pool

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org get pool

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Org update pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org update pool

PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string or null	no
`description`	string or null	no
`algorithm`	string or null	no
`ttl`	integer or null	no
`session_affinity`	string or null	no
`primary_location_code`	string or null	no
`enabled`	boolean or null	no

Responses

Section titled Org delete pool

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`description`	string or null
`hostname`	string or null
`algorithm`	string
`ttl`	integer
`session_affinity`	string
`primary_location_code`	string or null
`enabled`	boolean
`members`	array of LbMemberResponse
`members[].id`	integer
`members[].pool_id`	integer
`members[].address`	string
`members[].address_type`	string
`members[].weight`	integer
`members[].priority`	integer
`members[].enabled`	boolean
`members[].health_mode`	string
`members[].health_port`	integer or null
`members[].health_path`	string
`members[].health_interval_s`	integer
`members[].health_timeout_s`	integer
`members[].health_status`	string
`members[].last_check_at`	string (date-time) or null
`members[].last_error`	string or null
`members[].created_at`	string (date-time)
`members[].updated_at`	string (date-time)
`healthy_members`	integer or null
`total_members`	integer or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Org delete pool

DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`pool_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled List records

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

List records

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/records

Parameters

Name	In	Type	Required	Description
`zone_id`	path	integer	yes
`org_slug`	path	string	yes
`record_type`	query	string	no
`name`	query	string	no
`page`	query	integer	no	Default: `1`.
`per_page`	query	integer	no	Default: `100`.

Responses

Section titled Create record

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].zone_id`	integer
`[].name`	string
`[].record_type`	string
`[].content`	string
`[].ttl`	integer
`[].priority`	integer or null
`[].weight`	integer or null
`[].port`	integer or null
`[].proxied`	boolean
`[].comment`	string or null
`[].created_at`	string (date-time)
`[].updated_at`	string (date-time)

Create record

POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/records

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string	yes
`record_type`	string	yes
`content`	string	yes
`ttl`	integer	no
`priority`	integer or null	no
`weight`	integer or null	no
`port`	integer or null	no
`proxied`	boolean	no
`comment`	string or null	no

Responses

Section titled Get record

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`record_type`	string
`content`	string
`ttl`	integer
`priority`	integer or null
`weight`	integer or null
`port`	integer or null
`proxied`	boolean
`comment`	string or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Get record

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/records/{record_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`record_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Update record

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`record_type`	string
`content`	string
`ttl`	integer
`priority`	integer or null
`weight`	integer or null
`port`	integer or null
`proxied`	boolean
`comment`	string or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Update record

PUT /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/records/{record_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`record_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`name`	string or null	no
`record_type`	string or null	no
`content`	string or null	no
`ttl`	integer or null	no
`priority`	integer or null	no
`weight`	integer or null	no
`port`	integer or null	no
`proxied`	boolean or null	no
`comment`	string or null	no

Responses

Section titled Delete record

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`zone_id`	integer
`name`	string
`record_type`	string
`content`	string
`ttl`	integer
`priority`	integer or null
`weight`	integer or null
`port`	integer or null
`proxied`	boolean
`comment`	string or null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Delete record

DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/records/{record_id}

Parameters

Name	In	Type	Required
`zone_id`	path	integer	yes
`record_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Get zone stats

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get zone stats

GET /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/stats

Parameters

Name	In	Type	Required	Description
`zone_id`	path	integer	yes
`org_slug`	path	string	yes
`hours`	query	integer	no	Default: `24`.

Responses