Skip to content
QuantCDN

Get details of a single domain

GET
/api/v2/organizations/{organization}/projects/{project}/domains/{domain}

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

project
required
string

Project identifier

domain
required
string

Domain identifier

Responses

200

The request has succeeded.

object
id
required

Domain ID

integer
123
domain
required

Domain name

string
test-domain.com
dns_engaged
required

DNS engagement status. 1 indicates DNS is properly configured and engaged, 0 indicates DNS configuration is pending or incomplete.

integer
1
dns_validation_records

DNS validation records required for SSL certificate validation. Present for domains pending certificate validation. Each record contains the CNAME information needed to validate domain ownership.

Array<object>
nullable
object
name

DNS record name (host/subdomain)

string
_abc123.example.com
type

DNS record type (typically CNAME)

string
CNAME
value

DNS record value to point to

string
_xyz789.validation.example.com.
[
  {
    "name": "_abc123.example.com",
    "type": "CNAME",
    "value": "_xyz789.validation.example.com."
  }
]
dns_go_live_records

DNS records required to route traffic to the CDN. These records differ based on domain type (apex vs subdomain). Present when the CDN is configured and ready to receive traffic.

Array<object>
nullable
object
type

DNS record type (CNAME, A, or ALIAS)

string
CNAME
name

DNS record name/host (@ for apex/root domains, subdomain name for subdomains)

string
www
value

DNS record value (IP addresses for A records, domain name for CNAME/ALIAS)

string
nullable 
cdn.example.com
description

Human-readable instructions for configuring this DNS record

string
Add a CNAME record with the host set to your subdomain pointing to the CDN endpoint.
[
  {
    "type": "CNAME",
    "name": "www",
    "value": "cdn.example.com",
    "description": "Add a CNAME record with the host set to your subdomain pointing to the CDN endpoint."
  }
]

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true