# Organization API: Organizations & Members: Dns

> The 8 Organization API operations for dns.

Source: https://www.coritan.com/docs/api/reference/organizations/organizations-members/dns/

Part of [Organizations & Members](/docs/api/reference/organizations/organizations-members/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| POST | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members`](#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members) | Create LB member |
| PATCH | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}`](#op-patch-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id) | Update LB member |
| DELETE | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}`](#op-delete-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id) | Delete LB member |
| POST | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}/health-check`](#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id-h) | Health check LB member |
| POST | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members`](#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members) | Org create pool member |
| PATCH | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}`](#op-patch-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id) | Org update pool member |
| DELETE | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}`](#op-delete-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id) | Org delete pool member |
| POST | [`/api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}/health-check`](#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id-heal) | Org pool member health |

### Create LB member {#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members}

`POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `address` | string | yes |
| `address_type` | string | no |
| `weight` | integer | no |
| `priority` | integer | no |
| `enabled` | boolean | no |
| `health_mode` | string | no |
| `health_port` | integer or null | no |
| `health_path` | string | no |
| `health_interval_s` | integer | no |
| `health_timeout_s` | integer | no |

#### Responses

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

Fields of a `201` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |

### Update LB member {#op-patch-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id}

`PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `address` | string or null | no |
| `weight` | integer or null | no |
| `priority` | integer or null | no |
| `enabled` | boolean or null | no |
| `health_mode` | string or null | no |
| `health_port` | integer or null | no |
| `health_path` | string or null | no |
| `health_interval_s` | integer or null | no |
| `health_timeout_s` | integer or null | no |

#### Responses

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

Fields of a `200` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |

### Delete LB member {#op-delete-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id}

`DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Health check LB member {#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-lb-pools-pool-id-members-member-id-h}

`POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/lb-pools/{pool_id}/members/{member_id}/health-check`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

Fields of a `200` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |

### Org create pool member {#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members}

`POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `address` | string | yes |
| `address_type` | string | no |
| `weight` | integer | no |
| `priority` | integer | no |
| `enabled` | boolean | no |
| `health_mode` | string | no |
| `health_port` | integer or null | no |
| `health_path` | string | no |
| `health_interval_s` | integer | no |
| `health_timeout_s` | integer | no |

#### Responses

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

Fields of a `201` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |

### Org update pool member {#op-patch-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id}

`PATCH /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `address` | string or null | no |
| `weight` | integer or null | no |
| `priority` | integer or null | no |
| `enabled` | boolean or null | no |
| `health_mode` | string or null | no |
| `health_port` | integer or null | no |
| `health_path` | string or null | no |
| `health_interval_s` | integer or null | no |
| `health_timeout_s` | integer or null | no |

#### Responses

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

Fields of a `200` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |

### Org delete pool member {#op-delete-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id}

`DELETE /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Org pool member health {#op-post-api-v1-orgs-org-slug-dns-zones-zone-id-pools-pool-id-members-member-id-heal}

`POST /api/v1/orgs/{org_slug}/dns/zones/{zone_id}/pools/{pool_id}/members/{member_id}/health-check`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `zone_id` | path | integer | yes |
| `pool_id` | path | integer | yes |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

Fields of a `200` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `pool_id` | integer |
| `address` | string |
| `address_type` | string |
| `weight` | integer |
| `priority` | integer |
| `enabled` | boolean |
| `health_mode` | string |
| `health_port` | integer or null |
| `health_path` | string |
| `health_interval_s` | integer |
| `health_timeout_s` | integer |
| `health_status` | string |
| `last_check_at` | string (date-time) or null |
| `last_error` | string or null |
| `created_at` | string (date-time) |
| `updated_at` | string (date-time) |
