Requesting a backup
When requesting a backup, you can specify the following parameters:
| Parameter | Description | is required |
|---|---|---|
fromDate | Deprecated parameter. Not necessary for a successful request | No |
ids | A list of ids of the objects that should be included in the backup. | No |
apiNames | A list of apiNames of the objects that should be included in the backup. | No |
Must provide either apiName or object ids.
Backups are generated when requested and contains all data up to midnight of the previous day.
The backup is created for all objects in the site if daily backups are enabled. Optionally, you can request an adhoc backup indicating the object(s) you would like to backup, using either ids or apiName. The backup is created in the form of a zip file. The backup file can then be retrieved via the application (UI) or the API.
Body Parameters
Example ids
{
"ids" : [
2014,
2011,
2009,
2012,
2013,
25255,
2027,
2023,
17208,
16088,
13171,
13178,
13163,
2008,
2032
]
}Example apiNames
{
"apiNames": [
"Company",
"Contact",
"Document",
"Email",
"Interaction",
"LookUpTable",
"Note",
"Project",
"Report",
"Requirement",
"User"
]
}Example HTTP Request
POST {host}/api/rest/v4/backups/request HTTP/1.1
Authorization: {{auth}}
Content-Type: application/json
{
"ids": [2013, 16088, 13163]
}Example Response
HTTP/1.1 204 No Content