Client API: Platform Domains
Names claimed under the platform's customer suffixes, such as example.coritan.gg.
Names claimed under the platform's customer suffixes, such as example.coritan.gg.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Client API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/platform-domains |
Overview |
| GET | /api/v1/client/platform-domains/availability |
Check availability |
| POST | /api/v1/client/platform-domains/claims |
Create claim |
| DELETE | /api/v1/client/platform-domains/claims/{claim_id} |
Delete claim |
| POST | /api/v1/client/platform-domains/claims/{claim_id}/certificate |
(Re)queue the .<claim wildcard certificate |
Overview
Section titled OverviewGET /api/v1/client/platform-domains
Authentication: an access token, sent as Authorization: Bearer <token>.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
Check availability
Section titled Check availabilityGET /api/v1/client/platform-domains/availability
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
label |
query | string | yes |
suffix |
query | string or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Create claim
Section titled Create claimPOST /api/v1/client/platform-domains/claims
Authentication: an access token, sent as Authorization: Bearer <token>.
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
label |
string | yes |
suffix |
string or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Delete claim
Section titled Delete claimDELETE /api/v1/client/platform-domains/claims/{claim_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
claim_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
(Re)queue the .<claim wildcard certificate
Section titled (Re)queue the .<claim wildcard certificatePOST /api/v1/client/platform-domains/claims/{claim_id}/certificate
(Re)queue the *.<claim> wildcard certificate. Claims request it on
creation; this is for a claim made before the suffix was delegated, or
after a failed order.
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
claim_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
202 |
Success. |
422 |
The request is not valid. detail lists each problem. |