API Reference
Domains
Register, list, update, delete, and verify custom domains.
Register a Domain
POST/domains
Add a custom domain
Request Body
| Field | Type | Description |
|---|
domain* | string | Must be a valid domain. IP addresses and reserved domains (aplnk.to, warplink.app) are not allowed.e.g. links.myapp.com |
Responses
201Domain created
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
domain | string | e.g. links.myapp.com |
verified | boolean | |
ssl_status | string | |
verification_token | string | |
verified_at | string | null | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden, plan upgrade required, or domain limit exceeded
| Field | Type | Description |
|---|
error* | object | |
409Domain already registered
| Field | Type | Description |
|---|
error* | object | |
List Domains
GET/domains
List custom domains
Parameters
| Name | Type | In | Description |
|---|
limit | integer | query | |
offset | integer | query | |
Responses
200List of custom domains
| Field | Type | Description |
|---|
data | object[] | |
pagination | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
Get a Domain
GET/domains/{id}
Get a custom domain
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Domain details
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
domain | string | e.g. links.myapp.com |
verified | boolean | |
ssl_status | string | |
verification_token | string | |
verified_at | string | null | |
created_at | string | |
updated_at | string | |
400Invalid ID
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
Update a Domain
Operation not found: PATCH /domains/{id}
Delete a Domain
DELETE/domains/{id}
Delete a custom domain
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Deleted domain
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
domain | string | e.g. links.myapp.com |
verified | boolean | |
ssl_status | string | |
verification_token | string | |
verified_at | string | null | |
created_at | string | |
updated_at | string | |
400Invalid ID
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
Verify a Domain
POST/domains/{id}/verify
Verify a custom domain's DNS configuration
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Verification result
400Invalid ID
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |