Organization API: Customer Portal: Custom domain
The 5 Organization API operations for custom domain.
Part of Customer Portal.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain |
Vanity CNAME state for this server's join address |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain |
Link a customer hostname |
| PATCH | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain |
Show the vanity hostname, or the hosted one, in the public server list |
| DELETE | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain |
Unlink custom domain |
| POST | /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain/verify |
Check the CNAME now rather than waiting for the next maintenance pass |
Vanity CNAME state for this server's join address
Section titled Vanity CNAME state for this server's join addressGET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain
Vanity CNAME state for this server's join address.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Link a customer hostname
Section titled Link a customer hostnamePOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain
Link a customer hostname. Saved as pending when its CNAME is not
visible yet; the maintenance job promotes it when the record appears.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
domain |
string | yes |
subdomain |
string | no |
include_in_list |
boolean | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Show the vanity hostname, or the hosted one, in the public server list
Section titled Show the vanity hostname, or the hosted one, in the public server listPATCH /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain
Show the vanity hostname, or the hosted one, in the public server list.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
include_in_list |
boolean | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Unlink custom domain
Section titled Unlink custom domainDELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Check the CNAME now rather than waiting for the next maintenance pass
Section titled Check the CNAME now rather than waiting for the next maintenance passPOST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/custom-domain/verify
Check the CNAME now rather than waiting for the next maintenance pass.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
uuid |
path | string | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |