Domains API

Use the Domains API to connect branded domains from your own workflow. Domains still need valid DNS before they can serve links.

List domains

GET /api/v1/domains

Example:

curl https://www.qorlivo.com/api/v1/domains \
  -H "Authorization: Bearer $QORLIVO_API_KEY"

Response:

{
  "domains": [
    {
      "_id": "d52xxxxxxxxxxxxxxxxxxxxxxxxx",
      "hostname": "go.example.com",
      "status": "verified",
      "createdAt": 1783027439000
    }
  ]
}

Add a domain

POST /api/v1/domains

Body:

Example:

curl https://www.qorlivo.com/api/v1/domains \
  -X POST \
  -H "Authorization: Bearer $QORLIVO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "go.example.com"
  }'

The response includes the created domain details and may include DNS instructions. Add the shown DNS record at your domain provider, then verify the domain from Qorlivo.

Write access requires Creator or higher. Custom-domain limits depend on your plan.

Get a domain

GET /api/v1/domains/{id}

Example:

curl https://www.qorlivo.com/api/v1/domains/d52xxxxxxxxxxxxxxxxxxxxxxxxx \
  -H "Authorization: Bearer $QORLIVO_API_KEY"

Use this endpoint to inspect status, hostname, and available setup information.

Remove a domain

DELETE /api/v1/domains/{id}

Successful deletion returns 204 No Content.

curl https://www.qorlivo.com/api/v1/domains/d52xxxxxxxxxxxxxxxxxxxxxxxxx \
  -X DELETE \
  -H "Authorization: Bearer $QORLIVO_API_KEY"

Removing a domain stops new Qorlivo links from using that domain. Existing public URLs on that domain may stop resolving, so remove domains carefully.

Hostname rules

Qorlivo validates hostname format before creating a domain.

• Use lowercase domain names when possible.
• Do not include https://.
• Do not include a path such as /demo.
• Keep the hostname under 253 characters.
• Avoid connecting a domain you do not control.