Organization API: Customer Portal: Files

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`files`	array of object	yes

Responses

Section titled Compress files

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

Compress files

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/compress

Parameters

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`files`	array of string	yes

Responses

Section titled File contents

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

File contents

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/contents

Parameters

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

Responses

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

Copy file

Section titled Copy file

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/copy

Parameters

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

Request body

application/json (required)

Field	Type	Required
`location`	string	yes

Responses

Section titled Decompress file

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

Decompress file

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/decompress

Parameters

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`file`	string	yes

Responses

Section titled Delete files

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

Delete files

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/delete

Parameters

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`files`	array of string	yes

Responses

Section titled Download file

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

Download file

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/download

Parameters

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

Responses

Section titled List files

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

List files

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/list

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`org_slug`	path	string	yes
`directory`	query	string	no	Default: `/`.

Responses

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

Mkdir

Section titled Mkdir

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/mkdir

Parameters

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`name`	string	yes

Responses

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

Pull file

Section titled Pull file

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/pull

Parameters

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

Request body

application/json (required)

Field	Type	Required
`url`	string	yes
`destination_path`	string	yes
`filename`	string or null	no

Responses

Section titled Cancel pull

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

Cancel pull

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/pull/cancel

Parameters

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

Responses

Section titled Pull status

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

Pull status

GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/pull/status

Parameters

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

Responses

Section titled Rename files

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

Rename files

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/rename

Parameters

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

Request body

application/json (required)

Field	Type	Required
`root`	string	no
`files`	array of object	yes

Responses

Section titled Upload files

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

Upload files

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/upload

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`org_slug`	path	string	yes
`directory`	query	string	no	Default: `/`.

Request body

multipart/form-data (required)

Field	Type	Required
`files`	array of string (binary)	yes

Responses

Section titled Write file

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

Write file

POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/files/write

Parameters

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

Request body

application/json (required)

Field	Type	Required
`path`	string	yes
`content`	string	no
`expected_hash`	string or null	no

Responses