Editing Backup Copy Job Settings
You can edit a backup copy job with the specified ID.
Request
PUT https://<hostname>:4443/v6/CopyJobs/{id} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
id | string | Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Getting Backup Copy Jobs. |
Request Body
The request body must contain the following properties:
Property | Type | Description |
|---|---|---|
repositoryId | string | Specifies the ID of the backup repository extended with an archive object storage. |
schedulePolicy | Specifies the backup copy job scheduling options. |
Specify the following properties for the backup copy job schedule policy.
Mind that the type property must be specified if you want to enter the new values for the dailyType, dailyTime or periodicallyEvery properties.
Property | Type | Description |
|---|---|---|
type | string | Specifies the backup copy job schedule type. The following types are available:
|
dailyType | string | Specifies the days when the backup copy job will run. The following values are available:
|
dailyTime | UTC | Specifies the time to start the backup copy job. |
periodicallyEvery | string | Specifies the time interval between the backup copy job runs. The following values are available:
|
backupCopyWindowEnabled | boolean | If set to true, indicates that a backup copy window feature is enabled for this backup copy job. |
backupCopyWindowSettings | Specifies the backup copy window settings. A backup copy window is a time period within which the backup copy job must be completed. |
Specify the following properties for the backup copy window:
Property | Type | Description |
|---|---|---|
backupWindow | boolean[] | Defines an hourly scheme for the backup copy window. The scheduling scheme consists of 168 boolean elements. These elements can be logically divided into 7 groups by 24. Each group represents a day of the week starting from Sunday. Each element represents a backup copy hour:
|
minuteOffset | integer | Specifies the current minute offset from the UTC time. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 204 No Content.
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
The example shows how to change the target backup repository and scheduling options for the backup copy job with the ID 9d445cce-c81b-4b4d-9c10-a8326f7bb616.
Request: PUT https://abc.tech.local:4443/v6/CopyJobs/9d445cce-c81b-4b4d-9c10-a8326f7bb616
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265", "schedulePolicy": { "type": "DailyAtTime", "dailyType": "Sunday", "dailyTime": "18:00:00", "backupCopyWindowEnabled": true, "backupCopyWindowSettings": { "backupWindow": [ true, true, true, true, true, true, ... true, true, true, true ], "minuteOffset": 0 } }
Response: 204 No Content |