API docs

zpe files

mount /files · base https://zpe.vc/files · v1.0.0 · 15 operations · 10 write · 0 need no account · beta

archived: committed 2026-10-25, from 810709d5. Contract: https://zpe.vc/files/_/api/v1/openapi.json

POST /_/api/v1/copy Copy a file or a whole folder to another path postCopy

Copy a file or a whole folder to another path

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Copy a file or a whole folder to another path, with a token from the door.

POST /_/api/v1/copy
curl -X POST 'https://zpe.vc/files/_/api/v1/copy' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

POST /_/api/v1/counts Count the direct children of one or more folders postCounts

Count the direct children of one or more folders

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Count the direct children of one or more folders, with a token from the door.

POST /_/api/v1/counts
curl -X POST 'https://zpe.vc/files/_/api/v1/counts' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

DELETE /_/api/v1/delete Delete a file or folder, or move it to the trash with `?soft=1` deleteDelete

Delete a file or folder, or move it to the trash with `?soft=1`

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Delete a file or folder, or move it to the trash with `?soft=1`, with a token from the door.

DELETE /_/api/v1/delete
curl -X DELETE 'https://zpe.vc/files/_/api/v1/delete' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/download Download one file's bytes getDownload

Download one file's bytes

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Download one file's bytes, with a token from the door.

GET /_/api/v1/download
curl -X GET 'https://zpe.vc/files/_/api/v1/download' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/list List one folder, sorted, folders first getList

List one folder, sorted, folders first

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

List one folder, sorted, folders first, with a token from the door.

GET /_/api/v1/list
curl -X GET 'https://zpe.vc/files/_/api/v1/list' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

POST /_/api/v1/mkdir Create a folder, with its parent markers postMkdir

Create a folder, with its parent markers

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Create a folder, with its parent markers, with a token from the door.

POST /_/api/v1/mkdir
curl -X POST 'https://zpe.vc/files/_/api/v1/mkdir' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

POST /_/api/v1/rename Rename or move a file or folder postRename

Rename or move a file or folder

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Rename or move a file or folder, with a token from the door.

POST /_/api/v1/rename
curl -X POST 'https://zpe.vc/files/_/api/v1/rename' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/search Search the account's files by name getSearch

Search the account's files by name

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Search the account's files by name, with a token from the door.

GET /_/api/v1/search
curl -X GET 'https://zpe.vc/files/_/api/v1/search' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/stat Read one file's metadata without its bytes getStat

Read one file's metadata without its bytes

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Read one file's metadata without its bytes, with a token from the door.

GET /_/api/v1/stat
curl -X GET 'https://zpe.vc/files/_/api/v1/stat' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

GET /_/api/v1/trash List the trash, restore from it, or empty it getTrash

List the trash, restore from it, or empty it

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

List the trash, restore from it, or empty it, with a token from the door.

GET /_/api/v1/trash
curl -X GET 'https://zpe.vc/files/_/api/v1/trash' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

POST /_/api/v1/trash List the trash, restore from it, or empty it postTrash

List the trash, restore from it, or empty it

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

List the trash, restore from it, or empty it, with a token from the door.

POST /_/api/v1/trash
curl -X POST 'https://zpe.vc/files/_/api/v1/trash' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

DELETE /_/api/v1/trash List the trash, restore from it, or empty it deleteTrash

List the trash, restore from it, or empty it

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

List the trash, restore from it, or empty it, with a token from the door.

DELETE /_/api/v1/trash
curl -X DELETE 'https://zpe.vc/files/_/api/v1/trash' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

POST /_/api/v1/upload Upload a file, or write and remove one raw PUT at a time postUpload

Upload a file, or write and remove one raw PUT at a time

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Upload a file, or write and remove one raw PUT at a time, with a token from the door.

POST /_/api/v1/upload
curl -X POST 'https://zpe.vc/files/_/api/v1/upload' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

PUT /_/api/v1/upload Upload a file, or write and remove one raw PUT at a time putUpload

Upload a file, or write and remove one raw PUT at a time

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Upload a file, or write and remove one raw PUT at a time, with a token from the door.

PUT /_/api/v1/upload
curl -X PUT 'https://zpe.vc/files/_/api/v1/upload' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.

DELETE /_/api/v1/upload Upload a file, or write and remove one raw PUT at a time deleteUpload

Upload a file, or write and remove one raw PUT at a time

Parameters

No parameters.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200The answerobject
400The request could not be readobject
401The credential is missing or does not open this accountobject
403This account may not do thatobject
404Nothing is hereobject
429Too many requestsobject

Example

Upload a file, or write and remove one raw PUT at a time, with a token from the door.

DELETE /_/api/v1/upload
curl -X DELETE 'https://zpe.vc/files/_/api/v1/upload' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.