Enables, starts, stops or disables a backup job with the specified ID.
Request
To enable, start, stop or disable a job, send the POST HTTPS request to the URL of the /Jobs/{ID}/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v1/Jobs/{ID}/Action |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
Enable a backup job
To enable a backup job, the request body must contain the enable action:
{"enable": null} |
Start a backup job
To start a backup job, the request body must contain the start action:
{"start": null} |
Stop a backup job
To stop a backup job, the request body must contain the stop action:
{"stop": null} |
Disable a backup job
To disable a backup job, the request body must contain the disable action:
{"disable": null} |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 request 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://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/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://support.east.local:4443/v1/Jobs/3396ba22-21b1-4666-a631-0edfc12a59cd/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "disable": null }
Response: 200 OK |
Related Topics
