Skip to main content
POST
Start a database export

Authorizations

Authorization
string
header
required

A personal access token. Create one in the API tokens section of your profile page in the PivoCloud console. The token is shown once, when you create it.

Path Parameters

id
string<uuid>
required

The identifier of the database to export.

Response

The export was accepted, and the response carries the download URL for it.

The reply to an export request. Both fields are always present.

url
string<uri>
required

The download link for this export, complete with its signature and expiry. Store it as it is and request it as it is.

expires_at
string<date-time>
required

The moment the download link stops working. Links are short-lived, minutes rather than days, so read this value rather than taking a horizon from any example you have seen. A link requested after this moment answers 401 with the code SIGNED_URL_EXPIRED, which is the link having lapsed rather than anything wrong with the request.