Export Source

POST /api/v1/sources/{source_id}/exports

Export Source

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/sources/{source_id}/exports \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "include_files": true,
  "create_folders": true
}
'

202

{
  "id": "<string>",
  "source_id": "<string>",
  "status": "pending",
  "filename": "<string>",
  "include_files": true,
  "create_folders": true,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "size_bytes": 123,
  "error": "<string>",
  "download_url": "<string>",
  "download_url_expires_at": "2023-11-07T05:31:56Z",
  "poll_after_seconds": 123,
  "instructions": "<string>",
  "object": "source_export"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

source_id · string<uuid> · required

Body

application/json

include_files · boolean · default: true

create_folders · boolean · default: true

Response

202 - application/json

Accepted

id · string · required

source_id · string · required

status · enum<string> · required

Available options: pending, processing, ready, failed, expired

filename · string · required

include_files · boolean · required

create_folders · boolean · required

created_at · string<date-time> · required

completed_at · string<date-time> | null · required

expires_at · string<date-time> · required

size_bytes · integer | null · required

error · string | null · required

download_url · string | null · required

download_url_expires_at · string<date-time> | null · required

poll_after_seconds · integer | null · required

instructions · string · required

object · string · default: source_export