Creating Backup Copy Jobs

In this article

    You can create a backup copy job.

    Request

    POST https://<hostname>:4443/v6/CopyJobs

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    None.

    Request Body

    The request body must contain the following properties:

    Property

    Type

    Description

    backupJobId

    string

    Specifies the backup job ID for which you want to create a backup copy job.

    repositoryId

    string

    Specifies the ID of the backup repository extended with an archive object storage.

    isEnabled

    boolean

    If set to true, indicates that the backup copy job is enabled.

    schedulePolicy

    schedulePolicy

    Specifies the backup copy job scheduling options.

    schedulePolicy

    Specify the following properties for the backup copy job schedule policy:

    Property

    Type

    Description

    type

    string

    Specifies the backup copy job schedule type. The following types are available:

    • Immediate. The backup copy job runs right after the latest restore point appears in a source backup repository.
    • DailyAtTime. The backup copy job runs on the specified days at the specified hours.
    • Periodically. The backup copy job runs repeatedly throughout a day with a specific time interval.

    dailyType

    string

    Specifies the days when the backup copy job will run. The following values are available:

    • Everyday
    • Weekends
    • Workdays
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday

    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:

    • Minutes5
    • Minutes10
    • Minutes15
    • Minutes30
    • Hours1
    • Hours2
    • Hours4
    • Hours8

    backupCopyWindowEnabled

    boolean

    If set to true, indicates that a backup copy window feature is enabled for this backup copy job.

    backupCopyWindowSettings

    backupCopyWindowSettings

    Specifies the backup copy window settings. A backup copy window is a time period within which the backup copy job must be completed.

    backupCopyWindowSettings

    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:

    • true — the allowed backup copy hour
    • false — the prohibited 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 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

    In the response body, the server returns a resource representation of the /CopyJobs/{id} resource. For more information, see Getting Backup Copy Jobs.

    Example

    The example shows how to create a backup copy job for the backup job with the ID b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504.

    Request:

    POST https://abc.tech.local:4443/v6/CopyJobs

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

       "backupJobId": "b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504",

       "schedulePolicy": {

         "type": "Immediate",

         "backupCopyWindowEnabled": true,

         "backupCopyWindowSettings": {

           "backupWindow": [

             true,

             true,

             true,

             true,

            ...

             true,

             true,

             true

           ],

           "minuteOffset": 0

         }

       },

       "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

       "isEnabled": true    

    }

     

    Response:

    200 OK

     

    Response Body:

    {

     "backupJobId": "b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504",

     "schedulePolicy": {

       "type": "Immediate",

       "backupCopyWindowEnabled": true,

       "backupCopyWindowSettings": {

         "backupWindow": [

           true,

           true,

           true,

          ...

           true,

           true,

           true,

           true

         ],

         "minuteOffset": 0

       }

     },

     "id": "1f6f7c97-0df4-4866-8c37-309fda301894",

     "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

     "name": "Backup1 - copy job",

     "isEnabled": true,

     "lastStatus": "Success",

     "_links": {

       "self": {

         "href": "/v6/copyJobs/1f6f7c97-0df4-4866-8c37-309fda301894"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       },

       "backupJob": {

         "href": "/v6/job/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

       },

       "backupRepository": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       }

     }

    }