Backups and archives

Get list of backups & archives

get

Returns a paginated list of backup and archive jobs with customizable page size. You can also select backup/archive types, date range, order, and sort field.

Autorizações

AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota

connectionIdnumberObrigatório

Parâmetros de consulta

searchstringOpcional

Search term (max 80)

pagenumberObrigatório

Number of page (min 1)

Example: 1

limitnumberObrigatório

Limit of entities per page (min 1, max 2000)

Example: 50

isIncludeMetadatabooleanOpcional

startedDatestringOpcionalExample: 2020-01-01T00:00:00.000Z

endDatestringOpcionalExample: 2026-05-20T09:00:43.285Z

sortBystring · enumOpcionalExample: jobIdValores possíveis:

orderstring · enumOpcionalExample: DESCValores possíveis:

Respostas

200

Returns a paginated list of Backups & Archives

application/json

totalnumberObrigatório

Total number of entities.

Example: 1

400

Incorrect request data is provided. For example, startedDate isn't a valid ISO 8601 date string

application/json

404

Connection not found

application/json

get/api/v1/connections/{connectionId}/backups

GET /api/v1/connections/{connectionId}/backups?page=1&limit=1&types=full&statuses=In+Progress HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": 1,
      "name": "My backup",
      "jobId": 1,
      "jobStatus": "In Progress",
      "startedDate": "2026-01-01T00:00:00.000Z",
      "duration": "text",
      "size": 1,
      "records": 1,
      "operationType": "Templated Archive"
    }
  ]
}

Create backup

post

Creates a backup job. You must use one of the supported backup types: full or template. The templateId parameter is optional and should only be provided for template backups

Autorizações

AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota

connectionIdnumberObrigatório

Corpo

namestringObrigatório

Backup or archive name.

Example: My backup

descriptionstringObrigatórioExample: This is my backup

modestring · enumObrigatórioExample: fullValores possíveis:

Respostas

201Sucesso

application/json

messagestringObrigatório

400

Invalid request data provided. Examples: unsupported mode selected, or numeric values in name/description fields

application/json

404

Connection not found

application/json

409

Backup job is already running. You must abort it or wait for it to finish before creating another

application/json

post/api/v1/connections/{connectionId}/backups/backup

POST /api/v1/connections/{connectionId}/backups/backup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "name": "My backup",
  "description": "This is my backup",
  "settings": {
    "isIncludeMetadata": true,
    "isIncludeBinaryObjects": true,
    "isIncludeBigObjects": true,
    "isIncludeFeedObjects": true,
    "isIncludeShareObjects": true,
    "isIncludeHistoryObjects": true,
    "isIncludeCustomMetadataTypeObjects": true,
    "isIncludeTagObjects": true,
    "templateId": 1
  },
  "mode": "full"
}

{
  "message": "text"
}