Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Cosmos DB Accounts Protected by Veeam Backup for Microsoft Azure

The /protectedItem/cosmosDb resource collection represents Cosmos DB accounts protected by Veeam Backup for Microsoft Azure.

Get Collection of Protected Cosmos DB Accounts

The HTTP GET request to the /protectedItem/cosmosDbAccount endpoint retrieves a list of Cosmos DB accounts protected by Veeam Backup for Microsoft Azure.

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
SearchPattern
string or null

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

x-veeam-parameter-group: ProtectedCosmosDbAccountOptions
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: ProtectedCosmosDbAccountOptions
Accounts
Array of strings or null

Returns only Cosmos DB accounts with the specified system IDs.

x-veeam-parameter-group: ProtectedCosmosDbAccountOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

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

Get Protected Cosmos DB Account Data

The HTTP GET request to the /protectedItem/cosmosDb/{cosmosDbAccountId} endpoint retrieves information on a protected Cosmos DB account with the specified ID.

SecurityBearer
Request
path Parameters
cosmosDbAccountId
required
string or null

Specifies the Cosmos DB account ID in Microsoft Azure.

x-position: 1
query Parameters
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}?Sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "Online",
  • "accountType": "NoSql",
  • "policyName": "string",
  • "latestRestorableTimestamp": "2019-08-24T14:15:22Z",
  • "earliestRestorableTimestamp": "2019-08-24T14:15:22Z",
  • "latestBackup": "2019-08-24T14:15:22Z",
  • "backupSizeBytes": 0,
  • "archiveSizeBytes": 0,
  • "subscriptionId": "string",
  • "subscriptionName": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "tenantId": "string",
  • "tenantName": "string",
  • "regionId": "string",
  • "regionName": "string",
  • "resourceGroupName": "string",
  • "readRegions": [
    ],
  • "writeRegions": [
    ],
  • "restorePointTypes": [
    ],
  • "protectionState": {
    },
  • "databaseName": "string",
  • "capacityMode": "None"
}

Export Collection of Protected Cosmos DB Accounts

The HTTP POST request to the /protectedItem/cosmosDb/export endpoint exports a list of Cosmos DB accounts protected by Veeam Backup for Microsoft Azure 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
accounts
Array of strings or null

Returns only information on the Cosmos DB accounts with the specified IDs.

searchPattern
string or null

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

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/api/v8/protectedItem/cosmosDb/export
Request samples
application/json
{
  • "accounts": [
    ],
  • "searchPattern": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Remove Backups of Protected Cosmos DB Account

The HTTP POST request to the /protectedItem/cosmosDb/{cosmosDbAccountId}/deleteBackups endpoint removes backups created using the Backup to repository option for a Cosmos DB for PostgreSQL account with the specified ID.

SecurityBearer
Request
path Parameters
cosmosDbAccountId
required
string

Specifies the Cosmos DB account ID in Microsoft Azure.

query Parameters
BackupTier
string (ProtectedDataBackupTier)

Specifies the type of the backups that will be deleted.

Enum: "NonArchive" "Archive" "Unknown" "All"
x-veeam-parameter-group: ProtectedDataDeleteOptions
Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteBackups?BackupTier=NonArchive' \
  -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": {}
}

Remove Manual Backups of Protected Cosmos DB Account

The HTTP POST request to the /protectedItem/cosmosDb/{cosmosDbAccountId}/deleteManualBackups endpoint deletes backups created manually for a Cosmos DB account with the specified ID.

SecurityBearer
Request
path Parameters
cosmosDbAccountId
required
string

Specifies the Cosmos DB account ID in Microsoft Azure.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteManualBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteManualBackups' \
  -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": {}
}

Remove Continuous Backups of Protected Cosmos DB Account

The HTTP POST request to the /protectedItem/cosmosDb/{cosmosDbAccountId}/deleteContinuousBackups endpoint removes from the Veeam Backup for Microsoft Azure configuration database backups created using the Continuous backup option for a Cosmos DB account with the specified ID.

SecurityBearer
Request
path Parameters
cosmosDbAccountId
required
string

Specifies the Cosmos DB account ID in Microsoft Azure.

Responses
202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteContinuousBackups
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/deleteContinuousBackups' \
  -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": {}
}

Perform Cosmos DB Account Point-in-time Restore

The HTTP POST request to the /protectedItem/cosmosDb/{cosmosDbAccountId}/restore endpoint launches a point-in-time restore operation for a Cosmos DB account with the specified ID.

SecurityBearer
Request
path Parameters
cosmosDbAccountId
required
string

Specifies the Cosmos DB account ID in Microsoft Azure.

Request Body schema: application/json
required
ServiceAccountId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure to a service account that will be used for the restore operation.

TargetRegionId
required
string

Specifies a Microsoft Azure ID assigned to a region to which the data will be restored.

TargetResourceGroupId
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure to a resource group to which the data will be restored.

PointInTime
required
string <date-time>

Specifies the date and time to which the data will be restored. Consider that the specified value must be within the available point-in-time restore period. To obtain this period for the Cosmos DB account, see Get Cosmos DB Account Point-in-time Restore Period.

TargetName
required
string

Specifies a name for the target Cosmos DB account that will be created by the restore process.

Reason
string or null

Specifies a reason for the restore operation.

Array of objects or null (CosmosDbAccountRestorableResource)

[Applies to Cosmos DB accounts of the following kinds only: NoSQL, MongoDB, Apache Gremlin and Table] Specifies items that will be restored.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/protectedItem/cosmosDb/{cosmosDbAccountId}/restore
Request samples
application/json
{
  • "ServiceAccountId": "1808023c-4705-425b-a5ab-3b946508a817",
  • "TargetRegionId": "string",
  • "TargetResourceGroupId": "string",
  • "PointInTime": "2019-08-24T14:15:22Z",
  • "TargetName": "string",
  • "Reason": "string",
  • "SelectedItems": [
    ]
}
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": {}
}