Getting Backup Copy Jobs

You can get a list of configured backup copy jobs.

Request

GET https://<hostname>:4443/v6/CopyJobs?repositoryId=<string>

Request Headers

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

Request Parameters

The following optional parameter can be specified in the URL of the request:

Parameter

Type

Description

repositoryId

string

Specifies the identification number of the backup repository extended with an archive object storage. For more information on how to get this parameter, see Getting Backup Repositories.

Request Body

None.

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 resource.

Example

The example returns a list of configured backup copy jobs for which the backup repository with the ID f93dc1b5-5ecd-45ce-b4dd-5519160b6713 was specified as a target backup repository.

Request:

GET https://abc.tech.local:4443/v6/CopyJobs?repositoryId=f93dc1b5-5ecd-45ce-b4dd-5519160b6713

 

Request Header:

Authorization: Bearer <Access-Token>

 

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,

         true,

         true,

         true,

         true

       ],

       "minuteOffset": 0

     }

   },

   "id": "beace76b-1ac7-4b5a-8fae-6f6cccd83f1f",

   "repositoryId": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713",

   "name": "Backup1 - copy job",

   "lastRun": "2022-01-11T13:54:47.3621792Z",

   "isEnabled": true,

   "lastStatus": "Success",

   "_links": {

     "self": {

       "href": "/v6/copyJobs/beace76b-1ac7-4b5a-8fae-6f6cccd83f1f"

     },

     "organization": {

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

     },

     "backupJob": {

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

     },

     "backupRepository": {

       "href": "/v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713"

     }

   }

 },

 {

   "backupJobId": "50f5eff0-9575-451d-8712-ed6439be9b34",

   "schedulePolicy": {

     "type": "DailyAtTime",

     "dailyType": "Everyday",

     "dailyTime": "22:00:00",

     "backupCopyWindowEnabled": false

   },

   "id": "9d445cce-c81b-4b4d-9c10-a8326f7bb616",

   "repositoryId": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713",

   "name": "Backup2 - copy job",

   "lastRun": "2022-01-20T17:15:53.5378787Z",

   "nextRun": "2022-01-20T22:00:00Z",

   "isEnabled": true,

   "lastStatus": "Success",

   "_links": {

     "self": {

       "href": "/v6/copyJobs/9d445cce-c81b-4b4d-9c10-a8326f7bb616"

     },

     "organization": {

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

     },

     "backupJob": {

       "href": "/v6/job/50f5eff0-9575-451d-8712-ed6439be9b34"

     },

     "backupRepository": {

       "href": "/v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713"

     }

   }

 }

]