# Organization API: Customer Portal: Import

> The 5 Organization API operations for import.

Source: https://docs.coritan.com/api/reference/organizations/customer-portal/servers-import/

Part of [Customer Portal](/api/reference/organizations/customer-portal/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/current`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-import-current) | Current server import |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/start`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-import-start) | Start server import |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/status/{import_id}`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-import-status-import-id) | Polled while an import runs |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/test-connection`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-import-test-connection) | Test import connection |
| DELETE | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/{import_id}`](#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-import-import-id) | Cancel server import |

### Current server import {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-import-current}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/current`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Start server import {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-import-start}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/start`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `type` | string | yes |
| `remote_host` | string | yes |
| `remote_port` | integer or null | no |
| `username` | string | yes |
| `password` | string | yes |
| `base_path` | string | no |
| `truncate` | boolean | no |

#### Responses

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

### Polled while an import runs {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-import-status-import-id}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/status/{import_id}`

Polled while an import runs. Replica first; a miss re-asks the primary.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `import_id` | path | string | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Test import connection {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-import-test-connection}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/test-connection`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `type` | string | yes |
| `remote_host` | string | yes |
| `remote_port` | integer or null | no |
| `username` | string | yes |
| `password` | string | yes |
| `base_path` | string | no |
| `truncate` | boolean | no |

#### Responses

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

### Cancel server import {#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-import-import-id}

`DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/{import_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `import_id` | path | string | yes |
| `org_slug` | path | string | yes |

#### Responses

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