Skip to content
Docs
Select language:English

/api/v1/exports (POST)

POST
/api/v1/exports
curl --request POST \
  --url https://example.com/api/v1/exports \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "options": { "ended": true, "trashed": true, "history": true, "aiCalls": true, "readable": true, "pdf": true, "locale": "en", "digits": "western" }, "includeSecrets": true, "passphrase": "example", "passphraseAgain": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
Any of:
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
options
object
ended
boolean
trashed
boolean
history
boolean
aiCalls
boolean
readable
boolean
pdf
boolean
locale
string
Allowed values: en ar fr de it
digits
string
Allowed values: western eastern
includeSecrets
boolean
passphrase
string
<= 1024 characters
passphraseAgain
string
<= 1024 characters

Responses

Section titled “Responses”

202

Section titled “202”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
string
Allowed values: location me
locationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: queued running done failed cancelled expired
progress
required
object
done
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
integer
>= -9007199254740991 <= 9007199254740991
bytes
integer
>= -9007199254740991 <= 9007199254740991
sha256
string
includesSecrets
required
boolean
options
required
object
ended
required
boolean
trashed
required
boolean
history
required
boolean
aiCalls
required
boolean
readable
required
boolean
pdf
required
boolean
locale
required
string
digits
required
string
Allowed values: western eastern
createdAt
required
string
finishedAt
string
expiresAt
string
error
string
fileUrl
string
Example
{
  "scope": "location",
  "status": "queued",
  "options": {
    "digits": "western"
  }
}