Organization API: Customer Portal: Import

The 5 Organization API operations for import.

View as Markdown

Operations

Method	Path	Summary
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`	Start server import
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`	Test import connection
DELETE	`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/import/{import_id}`	Cancel server import

Current server import

Section titled Current server import

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

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.

Start server import

Section titled Start server import

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

Parameters

Section titled Parameters

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

Request body

Section titled 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

Section titled Responses

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

Polled while an import runs

Section titled Polled while an import runs

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

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`import_id`	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.

Test import connection

Section titled Test import connection

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

Parameters

Section titled Parameters

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

Request body

Section titled 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

Section titled Responses

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

Cancel server import

Section titled Cancel server import

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

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`import_id`	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.