This is an archive version of the document. To get the most up-to-date information, see the current version.Managing Backup Jobs
Enables, starts, stops or disables a backup job with a specified ID.
Request
POST https://<hostname>:4443/v4/Jobs/{backup_job_id}/Action |
You can perform the following actions:
- Enable a backup job
- Start a backup job
- Stop a backup job
- Disable a backup job
- Start a restore session for the job backup
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
|---|---|---|
backup_job_id | string | An identification number of the backup job. |
To enable a backup job, the request body must contain the enable action:
{"enable": null} |
To start a backup job, the request body must contain the start action:
{"start": null} |
To stop a backup job, the request body must contain the stop action:
{"stop": null} |
To disable a backup job, the request body must contain the disable action:
{"disable": null} |
To start a restore session, the request body must contain the explore action property:
Property | Type | Description |
|---|---|---|
Datetime | UTC | Specifies the date and time. You can specify the date and the time in one of the following formats:
|
Type | sessionType | Specifies the type of the restore session to start:
|
ShowDeleted | boolean | Specifies the restore session will show the deleted items. |
ShowAllVersions | boolean | Specifies the restore session will show all versions of backed-up items. |
The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organization/{organizationId} resource inform you when the organization's data was backed up for the first and last times.
Mind the following:
- If you specify the point in time which precedes the organization's first backup time, the restore session will be created with no backup data for explore or restore.
- If you specify the point in time which exceeds the organization's last backup time, the restore session will be created with backup data as of the latest restore point.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
None.
Example 1
The example below shows how to enable the backup job with ID 3396ba22-21b1-4666-a631-0edfc12a59cd.
Request: POST https://abc.tech.local:4443/v4/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "enable": null }
Response: 200 OK |
Example 2
The example below shows how to start the backup job with ID 3396ba22-21b1-4666-a631-0edfc12a59cd.
Request: POST https://abc.tech.local:4443/v4/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "start": null }
Response: 200 OK |
Example 3
The example below shows how to stop the backup job with ID 3396ba22-21b1-4666-a631-0edfc12a59cd.
Request: POST https://abc.tech.local:4443/v4/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "stop": null }
Response: 200 OK |
Example 4
The example below shows how to disable the backup job with ID 3396ba22-21b1-4666-a631-0edfc12a59cd.
Request: POST https://abc.tech.local:4443/v4/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "disable": null }
Response: 200 OK |
Example 5
The example below shows how to start a restore session for the backup of the backup job with ID 3396ba22-21b1-4666-a631-0edfc12a59cd.
Request: POST https://abc.tech.local:4443/v4/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "explore": {"datetime": "2019-04-12T10:54:40.2794046Z", "type": "vex"} }
Response: 200 OK |