Skip to content
QuantCDN

List all domains for a project

GET
/api/v2/organizations/{organization}/projects/{project}/domains
curl --request GET \
  --url https://dashboard.quantcdn.io/api/v2/organizations/test-org/projects/test-project/domains \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization
required
string

Organization identifier

Example
test-org
project
required
string

Project identifier

Example
test-project

Responses

Section titled “Responses”

200

Section titled “200”

The request has succeeded.

Media typeapplication/json
Array<object>
object
id
required

Domain ID

integer
domain
required

Domain name

string
dns_engaged
required

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

integer
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
type

DNS record type (typically CNAME)

string
value

DNS record value to point to

string
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
name

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

string
value

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

string
nullable
description

Human-readable instructions for configuring this DNS record

string
Example
[
  {
    "id": 123,
    "domain": "test-domain.com",
    "dns_engaged": 1,
    "dns_validation_records": [
      {
        "name": "_abc123.example.com",
        "type": "CNAME",
        "value": "_xyz789.validation.example.com."
      }
    ],
    "dns_go_live_records": [
      {
        "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

Section titled “400”

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

Media typeapplication/json
object
message
required

Error message

string
error
required

Error flag

boolean
Example
{
  "message": "The requested resource was not found",
  "error": true
}

403

Section titled “403”

Access is forbidden.

Media typeapplication/json
object
message
required

Error message

string
error
required

Error flag

boolean
Example
{
  "message": "The requested resource was not found",
  "error": true
}