Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Job Sessions

The /jobSessions resource collection represents statistics for every performed operation in Veeam Backup for Microsoft Azure.

Get Collection of Sessions

The HTTP GET request to the /jobSessions endpoint retrieves a list of Veeam Backup for Microsoft Azure sessions.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
PolicyId
string or null <uuid>

Returns only sessions of a backup policy with the specified ID.

x-veeam-parameter-group: RESTJobSessionFiltersV8
Filter
string or null

Returns only sessions that match the specified filter in the parameter value.

x-veeam-parameter-group: RESTJobSessionFiltersV8
Status
Array of strings or null (JobStatus)

Returns only sessions with the specified status.

Enum: "Canceled" "Canceling" "Error" "NeverExecuted" "Running" "RunningWithError" "RunningWithWarning" "Success" "Warning" "Pending" "Unknown"
x-veeam-parameter-group: RESTJobSessionFiltersV8
Types
Array of strings or null (JobSessionFilterType)

Returns only sessions of the specified types.

Enum: "BackupRetention" "InvalidSnapshotRetention" "ObsoleteSnapshotRetention" "OrphanedSnapshotRetention" "ManualSnapshot" "ManualSnapshotDeletion" "PolicyBackup" "PolicySnapshot" "PolicyArchive" "RestoreDisks" "RestoreVms" "FileLevelRestore" "BackupDeletion" "SnapshotDeletion" "SnapshotBackup" "RepositoryCreation" "RepositoryDeletion" "RepositoryEdit" "SqlPolicyBackup" "SqlPolicyArchive" "SqlManualBackup" "SqlRestore" "RestorePointDataRetrieval" "SqlRestorePointDataRetrieval" "FileSharePolicySnapshot" "FileShareManualSnapshot" "FileShareRestore" "FileShareFileRestore" "FileShareIndexing" "FileShareSnapshotRetention" "FileShareSnapshotDeletion" "FileShareManualSnapshotDeletion" "ConfigurationBackupManual" "ConfigurationBackupScheduled" "ConfigurationBackupDeletion" "ConfigurationBackupDownload" "HealthCheck" "ConfigurationBackupSync" "ConfigurationRestoreStatus" "SnapshotRescan" "Unknown" "SqlBackupDeletion" "VnetPolicyBackup" "VnetFullRestore" "VnetGranularRestore" "VnetBackupDeletion" "VnetRetention" "VnetRepositoryImport" "VnetPolicyBackupToRepository" "CosmosDbConfiguration" "CosmosDbRestore" "CosmosDbContinuousRetention" "CosmosDbRestorePointDataRetrieval" "CosmosDbBackupDeletion" "PostgresDbPolicyBackup" "PostgresDbPolicyArchive" "PostgresDbManualBackup" "InfrastructureRescan" "MongoDbManualBackup" "MongoDbPolicyBackup" "MongoDbPolicyArchive" "CosmosDbContinuousBackupDeletion"
x-veeam-parameter-group: RESTJobSessionFiltersV8
FromUtc
string or null <date-time>

Returns only sessions launched after the specified date and time. Note: The property value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.

x-veeam-parameter-group: RESTJobSessionFiltersV8
ToUtc
string or null <date-time>

Returns only sessions launched before the specified date and time. Note: The property value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.

x-veeam-parameter-group: RESTJobSessionFiltersV8
ResourceId
string or null

Retrieves only sessions that process an Azure resource with the specified ID.

x-veeam-parameter-group: RESTJobSessionFiltersV8
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions?Offset=0&Limit=-1&PolicyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Filter=string&Status=Canceled&Types=BackupRetention&FromUtc=2019-08-24T14%3A15%3A22Z&ToUtc=2019-08-24T14%3A15%3A22Z&ResourceId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Retention Session Data

The HTTP GET request to the /session/{retentionSessionId}/deletedItems endpoint retrieves a list of restore points removed during the retention session with the specified ID.

SecurityBearer
Request
path Parameters
retentionJobSessionId
required
string or null

Specifies the system ID assigned to a retention session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: RetentionJobDeletedItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{retentionJobSessionId}/deletedItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{retentionJobSessionId}/deletedItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Backup Session Data

The HTTP GET request to the /jobSessions/{backupJobSessionId}/protectedItems endpoint retrieves a list of Azure resources protected during the backup session with the specified ID.

SecurityBearer
Request
path Parameters
backupJobSessionId
required
string or null

Specifies the system ID assigned to a backup session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: BackupJobProtectedItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{backupJobSessionId}/protectedItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{backupJobSessionId}/protectedItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Health Check Session Data

The HTTP GET request to the /jobSessions/{healthCheckJobSessionId}/checkedItems endpoint retrieves a list of Azure resources whose backups were checked during the health check session with the specified ID.

SecurityBearer
Request
path Parameters
healthCheckJobSessionId
required
string

Specifies the system ID assigned to a health check session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: HealthCheckedJobCheckedItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{healthCheckJobSessionId}/checkedItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{healthCheckJobSessionId}/checkedItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/restoredItems endpoint retrieves a list of Azure resources restored during the restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: RestoreJobRestoredItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/restoredItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/restoredItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get SQL Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/restoredDatabases endpoint retrieves a list of SQL databases restored during the restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/restoredDatabases
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/restoredDatabases' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Azure VM File-Level Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/fileLevelRestoredItems endpoint retrieves a list of items restored during a Azure VM file-level restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: FileLevelRestoreJobRestoredItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/fileLevelRestoredItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/fileLevelRestoredItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get File Share File-Level Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/fileLevelRestoredFileShareItems endpoint retrieves a list of items restored during a File Share file-level restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: FileLevelRestoreJobRestoredFileShareOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/fileLevelRestoredFileShareItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/fileLevelRestoredFileShareItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Virtual Network Configuration Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/vnetRestoredItems endpoint retrieves a list of Azure resources restored during the virtual network configuration restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
NameSearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

x-veeam-parameter-group: RestoreJobVnetRestoredItemOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/vnetRestoredItems
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/vnetRestoredItems?NameSearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Session Data

The HTTP GET request to the /jobSession/{sessionId} endpoint retrieves information on a Veeam Backup for Microsoft Azure session with the specified ID.

SecurityBearer
Request
path Parameters
sessionId
required
string or null

Specifies the system ID assigned to a session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
instanceId
string or null

Returns only sessions that process an Azure resource with the specified system ID assigned to the resource in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/jobSessions/{sessionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{sessionId}?instanceId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "BackupRetention",
  • "localizedType": "string",
  • "executionStartTime": "2019-08-24T14:15:22Z",
  • "executionStopTime": "2019-08-24T14:15:22Z",
  • "executionDuration": "string",
  • "status": "Canceled",
  • "backupJobInfo": {
    },
  • "healthCheckJobInfo": {
    },
  • "restoreJobInfo": {
    },
  • "fileLevelRestoreJobInfo": {
    },
  • "fileShareFileLevelRestoreJobInfo": {
    },
  • "repositoryJobInfo": {
    },
  • "restorePointDataRetrievalJobInfo": {
    },
  • "retentionJobInfo": {
    },
  • "_links": {}
}

Get Session Log Details

The HTTP GET request to the /jobSession/{sessionId}/log endpoint retrieves the detailed log of a session with the specified ID.

SecurityBearer
Request
path Parameters
sessionId
required
string or null

Specifies the system ID assigned to a session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
instanceId
string or null

Returns only logs related to processing an Azure resource with the specified system ID assigned to the resource in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/jobSessions/{sessionId}/log
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{sessionId}/log?instanceId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "jobSessionId": "string",
  • "log": [
    ]
}

Stop Session

The HTTP POST request to the /jobSessions/{sessionId}/stop endpoint sops processing of a session with the specified ID.

SecurityBearer
Request
path Parameters
sessionId
required
string or null

Specifies the system ID assigned to a session in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/jobSessions/{sessionId}/stop
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/jobSessions/{sessionId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Export Collection of Sessions

The HTTP POST request to the /jobSessions/export endpoint exports session statistics to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
jobSessionIds
Array of strings or null

Specifies system IDs assigned in the Veeam Backup for Microsoft Azure REST API to sessions whose data will be exported.

policyId
string or null <uuid>

Exports only statistics on sessions related to a backup policy with the specified system ID.

filter
string or null

Exports only statistics on sessions related to a backup policy with the specified name.

status
Array of strings or null (JobStatus)

Exports only statistics on sessions with the specified statuses.

Enum: "Canceled" "Canceling" "Error" "NeverExecuted" "Running" "RunningWithError" "RunningWithWarning" "Success" "Warning" "Pending" "Unknown"
sessionTypes
Array of strings or null (SessionType)

Exports only statistics on sessions of the specified types.

Enum: "ManualSnapshot" "ManualBackup" "PolicySnapshot" "PolicyBackup" "PolicyArchive" "Retention" "Restore" "FileLevelRestore" "Deletion" "ConfigurationBackup" "RepositoryTasks" "FileShareIndexing" "HealthCheck" "CosmosDbConfiguration" "InfrastructureRescan"
workloadTypes
Array of strings or null (WorkloadType)

Exports only statistics on sessions related to the specified workload types.

Enum: "VirtualMachine" "SQL" "FileShares" "VirtualNetwork" "WorkloadIndependent" "CosmosDb"
fromUtc
string or null <date-time>

Exports only statistics on sessions launched after the specified date and time. Note: The property value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.

toUtc
string or null <date-time>

Exports only statistics on sessions launched before the specified date and time. Note: The property value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/jobSessions/export
Request samples
application/json
{
  • "jobSessionIds": [
    ],
  • "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  • "filter": "string",
  • "status": [
    ],
  • "sessionTypes": [
    ],
  • "workloadTypes": [
    ],
  • "fromUtc": "2019-08-24T14:15:22Z",
  • "toUtc": "2019-08-24T14:15:22Z"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Get Cosmos DB Restore Session Data

The HTTP GET request to the /jobSessions/{restoreJobSessionId}/restoredCosmosDbAccounts endpoint retrieves a list of Cosmos DB accounts restored during the restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreJobSessionId
required
string or null

Specifies the system ID assigned to a restore session in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/jobSessions/{restoreJobSessionId}/restoredCosmosDbAccounts
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/jobSessions/{restoreJobSessionId}/restoredCosmosDbAccounts' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}