zpe-files v4.0.0 · zpe API

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

name	in	required	type	notes
`from`	query	no	string	The file or folder to copy. Send it here or as `from` in a JSON body.
`overwrite`	query	no	boolean	Replace the destination when it already exists. Default false.
`to`	query	no	string	Where the copy goes. Send it here or as `to` in a JSON body.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?from=string&overwrite=false&to=string' \
  -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

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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

name	in	required	type	notes
`path`	query	yes	string	The file or folder to delete, relative to the account's prefix.
`soft`	query	no	boolean	Move it to the trash instead of deleting it.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?path=string&soft=false' \
  -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

name	in	required	type	notes
`path`	query	yes	string	The object key to read, relative to the account's prefix.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?path=string' \
  -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

name	in	required	type	notes
`cursor`	query	no	string	The `nextCursor` a previous page answered, to read the next one.
`limit`	query	no	integer	How many entries to answer. The whole folder when absent.
`path`	query	no	string	The folder to list, relative to the account's prefix. The root when absent.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?cursor=string&limit=0&path=string' \
  -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

name	in	required	type	notes
`path`	query	yes	string	The folder to create, relative to the account's prefix.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?path=string' \
  -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

name	in	required	type	notes
`from`	query	no	string	The file or folder to move. Send it here or as `from` in a JSON body.
`overwrite`	query	no	boolean	Replace the destination when it already exists. Default false.
`to`	query	no	string	Its new path. Send it here or as `to` in a JSON body.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?from=string&overwrite=false&to=string' \
  -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

name	in	required	type	notes
`cursor`	query	no	string	The `nextCursor` a previous page answered, to read the next one.
`limit`	query	no	integer	How many hits to answer. Default 100.
`match`	query	no	"name"	`name` matches a file's whole name instead of a substring of it, for a caller that knows the name it wants.
`prefix`	query	no	string	Only search under this folder, relative to the account's prefix.
`q`	query	no	string	The text to find in a file's name. An empty one answers nothing rather than everything.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?cursor=string&limit=0&match=name&prefix=string&q=string' \
  -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

name	in	required	type	notes
`path`	query	yes	string	The object key to read the metadata of, relative to the account's prefix.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?path=string' \
  -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

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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

name	in	required	type	notes
`action`	query	no	"restore"	`restore` restores the keys named in the body. Absent, the body's keys are soft-deleted instead.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?action=restore' \
  -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

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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

name	in	required	type	notes
`overwrite`	query	no	boolean	Replace a file of the same name. Default false.
`path`	query	no	string	The folder to write into — or, with `uploads`, the file key the multipart upload is for.
`uploadId`	query	no	string	Complete the multipart upload this id names, with the parts in a JSON body.
`uploads`	query	no	boolean	Start a multipart upload and answer its `uploadId`. Send it with no value.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?overwrite=false&path=string&uploadId=string&uploads=false' \
  -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

name	in	required	type	notes
`partNumber`	query	yes	integer	Which part this body is, counted from 1.
`path`	query	yes	string	The file key this part belongs to.
`uploadId`	query	yes	string	The multipart upload this part belongs to.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?partNumber=0&path=string&uploadId=string' \
  -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

name	in	required	type	notes
`path`	query	yes	string	The file key the abandoned upload was for.
`uploadId`	query	yes	string	The multipart upload to abandon.

Request body

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

Responses

status	meaning	body
`200`	The answer	object
`400`	The request could not be read	object
`401`	The credential is missing or does not open this account	object
`403`	This account may not do that	object
`404`	Nothing is here	object
`429`	Too many requests	object

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?path=string&uploadId=string' \
  -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.

Matches in other apps

zpe files

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example

Parameters

Request body

Responses

Example