Client API: Container Apps: Import

The 5 Client API operations for import.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/client/servers/{uuid}/import/current`	Active import, or a recently finished one, so a refresh can resume the UI
POST	`/api/v1/client/servers/{uuid}/import/start`	Queue a remote tree copy onto this server
GET	`/api/v1/client/servers/{uuid}/import/status/{import_id}`	Poll an import the caller started
POST	`/api/v1/client/servers/{uuid}/import/test-connection`	Probe a remote SFTP/FTP host and count files without writing anything
DELETE	`/api/v1/client/servers/{uuid}/import/{import_id}`	Stop a pending or in-progress import

Active import, or a recently finished one, so a refresh can resume the UI

Section titled Active import, or a recently finished one, so a refresh can resume the UI

GET /api/v1/client/servers/{uuid}/import/current

Active import, or a recently finished one, so a refresh can resume the UI.

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

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	path	string	yes

Responses

Section titled Responses

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

Queue a remote tree copy onto this server

Section titled Queue a remote tree copy onto this server

POST /api/v1/client/servers/{uuid}/import/start

Queue a remote tree copy onto this server.

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

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	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.

Poll an import the caller started

Section titled Poll an import the caller started

GET /api/v1/client/servers/{uuid}/import/status/{import_id}

Poll an import the caller started. Replica first; a miss re-asks the primary.

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

Parameters

Section titled Parameters

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

Responses

Section titled Responses

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

Probe a remote SFTP/FTP host and count files without writing anything

Section titled Probe a remote SFTP/FTP host and count files without writing anything

POST /api/v1/client/servers/{uuid}/import/test-connection

Probe a remote SFTP/FTP host and count files without writing anything.

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

Parameters

Section titled Parameters

Name	In	Type	Required
`uuid`	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.

Stop a pending or in-progress import

Section titled Stop a pending or in-progress import

DELETE /api/v1/client/servers/{uuid}/import/{import_id}

Stop a pending or in-progress import.

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

Parameters

Section titled Parameters

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

Responses

Section titled Responses

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