Export
Returns terminal backups and archives that can be selected as an export source. Backups that are still in progress are excluded.
Bearer <access_token>
Search term (max 80)
Number of page (min 1)
1Limit of entities per page (min 1, max 2000)
50jobIdValores possíveis: DESCValores possíveis: Backups available as export sources
Total number of entities.
1Invalid pagination, sorting, or search parameters
GET /api/v1/connections/{connectionId}/exports/backups?page=1&limit=50&types=full HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 1,
"items": [
{
"id": 1,
"name": "My backup",
"jobId": 1,
"jobStatus": "Completed",
"startedDate": "2026-01-01T00:00:00.000Z",
"duration": "text",
"size": 1,
"records": 1,
"operationType": "Composite Backup"
}
]
}Returns the objects and record totals stored in the selected backup. Use an object name from this response as steps[].objectApiName when creating an export.
Bearer <access_token>
Backup or archive identifier
Search term (max 80)
Number of page (min 1)
1Limit of entities per page (min 1, max 2000)
50nameDESCValores possíveis: falseObjects available in the selected backup
Total number of entities.
1Invalid backup ID, pagination, sorting, or filtering parameters
Backup not found
Backup is still in progress
GET /api/v1/connections/{connectionId}/exports/backups/{backupId}/objects?page=1&limit=50 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalData": {
"name": "Total",
"totalRecords": 1
},
"total": 1,
"items": [
{
"name": "text",
"totalRecords": 1,
"addedRecordVersions": 1,
"changedRecordVersions": 1,
"deletedRecordVersions": 1,
"size": 1
}
]
}Starts an asynchronous export for one or more objects from the selected backup and returns the job ID used to retrieve its status. For destination csv, the result is stored internally and can be downloaded when readyForDownload becomes true. For destination external-storage, storageId and path are required and the result is written directly to that storage. An object with no stored records can complete without generating a downloadable file. Object processing failures are reported asynchronously through the export status and public job logs.
Bearer <access_token>
Backup or archive identifier
Export destination: csv stores the result internally for later download; external-storage writes it to a configured storage.
Path prefix in the configured storage. Required for external-storage and not allowed for csv.
Configured storage identifier. Required for external-storage and not allowed for csv.
Export job created
Identifier used to retrieve the export status.
123Invalid request or destination configuration
Backup or configured external storage not found
Backup is still in progress
Monthly export limit reached
POST /api/v1/connections/{connectionId}/exports/backups/{backupId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212
{
"steps": [
{
"objectApiName": "Account",
"declarativeFilter": [
{
"value": "Test Name",
"field": "Name",
"option": "equals"
}
],
"declarativeFilterCustomLogic": "1 AND (2 OR 3)"
}
],
"destination": "csv",
"path": "text",
"storageId": 1
}{
"message": "text",
"jobId": 123
}Returns configured external storages. Pass the selected storage ID when destination is external-storage.
Bearer <access_token>
Search term (max 80)
Number of page (min 1)
1Limit of entities per page (min 1, max 2000)
50Column to sort by
idValores possíveis: Sort direction
DESCValores possíveis: Filter by default storage flag. If true, returns only backup default storages. If false, returns only non-default.
Configured external storages
Total number of entities.
1Invalid pagination, sorting, or filtering parameters
GET /api/v1/connections/{connectionId}/exports/storages?page=1&limit=50 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 1,
"items": [
{
"id": 1,
"name": "text",
"type": "Local"
}
]
}Returns the current export status and destination. Poll while jobStatus is In Progress. For an internal csv export, download the result when readyForDownload is true. External-storage exports are never available through the internal download endpoint. For Exception or Aborted jobs, use the public job log endpoints to retrieve failure details.
Bearer <access_token>
Export job identifier
Export status and download readiness
1Backupbackup42True only when an internally stored export has completed and contains downloadable data.
falseConfigured path for external-storage exports; null for internal exports.
csv is internal storage; external-storage writes to a configured storage.
Invalid job ID
Export not found
GET /api/v1/connections/{connectionId}/exports/{jobId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"jobId": 1,
"operation": "Backup",
"exportType": "backup",
"asOfDate": "2026-01-01T00:00:00.000Z",
"fromDate": "2026-01-01T00:00:00.000Z",
"toDate": "2026-01-01T00:00:00.000Z",
"backupId": 42,
"jobStatus": "In Progress",
"startedDate": "2026-01-01T00:00:00.000Z",
"duration": "text",
"readyForDownload": false,
"recordsSuccessCount": 1,
"endDate": "2026-01-01T00:00:00.000Z",
"path": "text",
"destination": "csv"
}Downloads the generated ZIP for a csv export when its status response has readyForDownload set to true. External-storage exports cannot be downloaded through this endpoint.
Bearer <access_token>
Export job identifier
ZIP archive containing the exported CSV files
Invalid job ID
Export is not ready, has failed, was cleared, contains no downloadable data, or uses external storage
Export not found
GET /api/v1/connections/{connectionId}/exports/{jobId}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryAtualizado
Isto foi útil?