Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Copy Jobs

The /CopyJobs resource collection allows you to manage backup copy jobs.

Get Backup Copy Jobs

Returns a collection of configured backup copy jobs.

SecurityBearer
Request
query Parameters
organizationId
string <uuid>

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

repositoryId
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/CopyJobs
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Create Backup Copy Job
Creates a backup copy job.


x-codegen-request-body-name:  jobFromClient
SecurityBearer 
Request 
Request Body schema: application/json
required
backupJobId
required
string <uuid> 
Backup job ID.


 
repositoryId
required
string <uuid> 
ID of one of the following object storage repositories: Azure Blob Storage Archive access tier, Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval or Amazon S3 Glacier Deep Archive storage classes.


 
organizationId
required
string <uuid> 
ID of the Microsoft 365 organization.


 
object (RESTCopyJobSchedulePolicy) 
 
isEnabled
boolean or null
Defines whether the backup copy job is enabled.


 
Responses 
201
Created


default
Operation failure response.


post/v8/CopyJobs
Request samples 
application/json
{
  • "backupJobId": "00000000-0000-0000-0000-000000000000",
  • "schedulePolicy": {
    },
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "isEnabled": true
}
Response samples 
application/json
{
  • "backupJobId": "00000000-0000-0000-0000-000000000000",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "eTag": 0,
  • "_links": {
    }
}
Get Backup Copy Job
Returns a resource representation of a backup copy job with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/CopyJobs/{id}
Request samples 
Response samples 
application/json
{
  • "backupJobId": "00000000-0000-0000-0000-000000000000",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "eTag": 0,
  • "_links": {
    }
}
Edit Backup Copy Job Settings
Modifies settings of a backup copy job with the specified ID.


x-codegen-request-body-name:  jobFromClient
SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Request Body schema: application/json
required
backupJobId
string or null <uuid> 
Backup job ID.


 
object (RESTCopyJobSchedulePolicy) 
 
organizationId
string or null <uuid> 
ID of the Microsoft 365 organization.


 
repositoryId
string or null <uuid> 
ID of one of the following object storage repositories: Azure Blob Storage Archive access tier, Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval or Amazon S3 Glacier Deep Archive storage classes.


 
isEnabled
boolean or null
Defines whether the backup copy job is enabled.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/CopyJobs/{id}
Request samples 
application/json
{
  • "backupJobId": "00000000-0000-0000-0000-000000000000",
  • "schedulePolicy": {
    },
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "isEnabled": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Copy Job
Removes a backup copy job with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/CopyJobs/{id}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Backup Job by Backup Copy Job ID
Returns a resource representation of a backup job for which the backup copy job with the specified ID was created.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/CopyJobs/{id}/BackupJob
Request samples 
Response samples 
application/json
{
  • "description": "string",
  • "backupType": "EntireOrganization",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "totalObjects": 0,
  • "processedObjects": 0,
  • "eTag": 0,
  • "_links": {
    }
}
Enable Backup Copy Job
Enables a backup copy job with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/CopyJobs/{id}/enable
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Disable Backup Copy Job
Disables a backup copy job with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/CopyJobs/{id}/disable
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Start Backup Copy Job
Starts a backup copy job with the specified ID.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
200
OK


default
Operation failure response.


post/v8/CopyJobs/{id}/start
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "jobId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "mainSessionId": "00000000-0000-0000-0000-000000000000",
  • "details": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "retryCount": 0,
  • "jobWillBeRetried": true,
  • "progress": 0,
  • "total": 0,
  • "jobType": "Backup",
  • "jobSessionConfigType": "Full",
  • "status": "Stopped",
  • "statistics": {
    },
  • "eTag": 0,
  • "_links": {
    },
  • "proxyId": "00000000-0000-0000-0000-000000000000",
  • "proxyPoolId": "00000000-0000-0000-0000-000000000000"
}
Stop Backup Copy Job
Stops a backup copy job with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the identification number of the backup copy job. For more information on how to get this parameter, see Get Backup Copy Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/CopyJobs/{id}/stop
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201