[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/workers/subresources/domains [Back]  [Original]
Domains | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Workers
Copy Markdown

Domains

List Domains
GET/accounts/{account_id}/workers/domains
Get Domain
GET/accounts/{account_id}/workers/domains/{domain_id}
Attach Domain
PUT/accounts/{account_id}/workers/domains
Detach Domain
DELETE/accounts/{account_id}/workers/domains/{domain_id}
ModelsExpand Collapse
DomainListResponse object { id, cert_id, hostname, 4 more }
id: string

Immutable ID of the domain.

cert_id: string

ID of the TLS certificate issued for the domain.

formatuuid
hostname: string

Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.

service: string

Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.

zone_id: string

ID of the zone containing the domain hostname.

zone_name: string

Name of the zone containing the domain hostname.

Deprecatedenvironment: optional string

Worker environment associated with the domain.

DomainGetResponse object { id, cert_id, hostname, 4 more }
id: string

Immutable ID of the domain.

cert_id: string

ID of the TLS certificate issued for the domain.

formatuuid
hostname: string

Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.

service: string

Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.

zone_id: string

ID of the zone containing the domain hostname.

zone_name: string

Name of the zone containing the domain hostname.

Deprecatedenvironment: optional string

Worker environment associated with the domain.

DomainUpdateResponse object { id, cert_id, hostname, 4 more }
id: string

Immutable ID of the domain.

cert_id: string

ID of the TLS certificate issued for the domain.

formatuuid
hostname: string

Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.

service: string

Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.

zone_id: string

ID of the zone containing the domain hostname.

zone_name: string

Name of the zone containing the domain hostname.

Deprecatedenvironment: optional string

Worker environment associated with the domain.

DomainDeleteResponse object { errors, messages, success }
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

Previous

Account Settings
Next

Subdomains

On this page

Web Proxy Viewer  |  New URL  |  Original Page