Add a tracking domain

Claims a subdomain, such as t.example.com, for the project and returns the DNS records to create.

The domain starts serving once its DNS proves it belongs to the project; one that does not within seven days is removed. A project has at most five.

Guide: Tracking domain

Errors

Status	`type`	`code`	When
400	`invalid_request`	`invalid_tracking_domain`	For a hostname that cannot be used, one the project already has, or a project at its limit.
503	`unavailable`	`tracking_domains_unavailable`	Where this deployment does not host tracking domains; proxy the web SDK through your own server there.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Tracking domains

Something wrong or missing on this page? Tell us by email or on Discord.

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

hostname*string

A subdomain you control, such as t.example.com; a scheme, a trailing slash and letter case are ignored. It needs at least three labels, since a CNAME cannot sit at the root of a domain.

Lengthlength <= 255

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/tracking-domains" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "hostname": "t.example.com"  }'

{  "id": "tdom_e2r5t8y1u4i7o0p3a6s9d2f5",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "hostname": "t.example.com",  "status": "pending_dns",  "failureReason": null,  "dnsRecords": [    {      "type": "CNAME",      "name": "t.example.com",      "value": "p7k2m9x4.track.voidhash.link",      "purpose": "routing"    }  ],  "lastCheckedAt": null,  "activatedAt": null,  "createdAt": "2026-03-03T12:00:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "invalid_tracking_domain",    "message": "t.example.com is already a tracking domain of this project.",    "param": "hostname"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

{  "error": {    "type": "unavailable",    "code": "tracking_domains_unavailable",    "message": "This deployment does not host tracking domains. Put a reverse proxy on your own domain in front of the API instead."  }}

Add a tracking domain

Errors

More in Tracking domains

Add a tracking domain

Errors

More in Tracking domains

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Add a tracking domain

Add a tracking domain

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`