# Client API: Platform Domains

> Names claimed under the platform's customer suffixes, such as example.coritan.gg.

Source: https://www.coritan.com/docs/api/reference/client/platform-domains/

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](https://api.coritan.com/docs).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/client/platform-domains`](#op-get-api-v1-client-platform-domains) | Overview |
| GET | [`/api/v1/client/platform-domains/availability`](#op-get-api-v1-client-platform-domains-availability) | Check availability |
| POST | [`/api/v1/client/platform-domains/claims`](#op-post-api-v1-client-platform-domains-claims) | Create claim |
| DELETE | [`/api/v1/client/platform-domains/claims/{claim_id}`](#op-delete-api-v1-client-platform-domains-claims-claim-id) | Delete claim |
| POST | [`/api/v1/client/platform-domains/claims/{claim_id}/certificate`](#op-post-api-v1-client-platform-domains-claims-claim-id-certificate) | (Re)queue the .<claim wildcard certificate |

### Overview {#op-get-api-v1-client-platform-domains}

`GET /api/v1/client/platform-domains`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |

### Check availability {#op-get-api-v1-client-platform-domains-availability}

`GET /api/v1/client/platform-domains/availability`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `label` | query | string | yes |
| `suffix` | query | string or null | no |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Create claim {#op-post-api-v1-client-platform-domains-claims}

`POST /api/v1/client/platform-domains/claims`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `label` | string | yes |
| `suffix` | string or null | no |

#### Responses

| Status | Meaning |
| --- | --- |
| `201` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Delete claim {#op-delete-api-v1-client-platform-domains-claims-claim-id}

`DELETE /api/v1/client/platform-domains/claims/{claim_id}`

Authentication: an access token, sent as `Authorization: Bearer <token>`.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `claim_id` | path | integer | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### (Re)queue the .<claim wildcard certificate {#op-post-api-v1-client-platform-domains-claims-claim-id-certificate}

`POST /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

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `claim_id` | path | integer | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `202` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |