Configuration

The /configuration resource collection allows to get information on Veeam Backup for Microsoft Azure current configuration.

Run Configuration Check

The HTTP POST request to the /configuration/check endpoint runs the configuration check operation for the specified check types.

SecurityBearer

Request

Request Body schema: application/json

checkType

Array of strings (ConfigurationCheckType)

Specifies types of configuration checks that must be run.

Items Enum: "AzureAccounts" "WorkerConfiguration" "Repositories" "RepositoriesEncryption" "PortalUsers" "SsoUsers" "Unknown" "AllPrivateDeployment" "RepositoriesOwnership"

Responses

202

Accepted

400

Bad Request

401

Unauthorized

post/api/v8/configuration/check

Request samples

Payload
curl

application/json

{"checkType": ["AzureAccounts"
]
}

Response samples

application/problem+json

{"extensions": { },
"status": 0,
"title": "string",
"detail": "string",
"type": "string"
}

Get Configuration Check Results

The HTTP GET request ot the /configuration/checkSession endpoint retrieves results of the configuration check operation.

x-veeam-custom-response: true

SecurityBearer

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

get/api/v8/configuration/checkSession

Request samples

curl

curl -i -X GET \
  https://123.123.123.123/api/v8/configuration/checkSession \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

{"logLine": [{"title": "string",
"status": "Unknown",
"result": "string",
"type": "AzureAccounts"
}
],
"overallStatus": "Unknown",
"checkResponse": {"missingRoles": {"accounts": [{"account": {"accountId": "string",
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"applicationCertificateName": "string",
"name": "string",
"description": "string",
"region": "Global",
"tenantId": "string",
"tenantName": "string",
"accountOrigin": "Device Authentication",
"expirationDate": "2019-08-24T14:15:22Z",
"accountState": "Created",
"adGroupId": "9a83eeeb-9c7f-43c1-8266-9a86d08b7e4a",
"cloudState": "Unknown",
"adGroupName": "string",
"purposes": ["None"
],
"managementGroupId": "string",
"managementGroupName": "string",
"subscriptionIds": ["string"
],
"selectedForWorkermanagement": true,
"azurePermissionsState": ["AllPermissionsAvailable"
],
"azurePermissionsStateCheckTimeUtc": "2019-08-24T14:15:22Z",
"subscriptionIdForWorkerDeployment": "fa8415e4-16b1-41c7-a585-5c880fe4dc6f",
"_links": {"property1": {"href": null
},
"property2": {"href": null
}
}
},
"subscriptions": [{"subscription": {"id": null,
"name": null,
"tenantId": null,
"permissionsState": null,
"missingPermissions": [ ],
"missingDataActions": [ ],
"resourceProvidersState": null,
"missingResourceProviders": [ ],
"purposes": [ ],
"missingPurposes": [ ],
"availability": null
},
"roleDefinition": "string",
"existingRole": "string"
}
],
"status": "Unknown,",
"severity": "Success"
}
]
},
"workerConfiguration": {"workerConfigurations": [{"configurations": {"virtualNetwork": {"name": "string",
"resourceId": "string",
"subnet": "string",
"regionId": "string",
"resourceGroupId": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"resourceGroupName": "string"
},
"region": {"id": "string",
"name": "string",
"resourceId": "string"
},
"networkSecurityGroup": {"id": "string",
"name": "string",
"regionId": "string",
"resourceGroupName": "string",
"subscriptionId": "string"
},
"forbidPublicIp": true,
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
"tenantName": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"subscriptionName": "string",
"resourceGroup": "string",
"configurationType": "Automatic",
"_links": {"property1": {"href": null
},
"property2": {"href": null
}
}
},
"status": "Valid",
"severity": "Success"
}
]
},
"repositories": {"repositories": [{"repository": {"id": "string",
"name": "string",
"description": "string",
"azureStorageAccountId": "string",
"azureStorageAccountName": "string",
"azureStorageFolder": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"azureStorageContainer": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"enableEncryption": true,
"hint": "string",
"regionId": "string",
"regionName": "string",
"azureAccountId": "string",
"environment": "Global",
"status": "Creating",
"storageTier": "Inferred",
"isStorageTierInferred": true,
"immutabilityEnabled": true,
"repositoryOwnership": {"hasAnotherOwner": true,
"currentOwnerIdentifier": "string",
"currentOwnerName": "string"
},
"concurrencyLimit": 1,
"_links": {"property1": {"href": null
},
"property2": {"href": null
}
}
},
"status": "Unknown",
"severity": "Success",
"message": "string"
}
]
},
"repositoryOwnership": {"repositories": [{"repository": {"id": "string",
"name": "string",
"description": "string",
"azureStorageAccountId": "string",
"azureStorageAccountName": "string",
"azureStorageFolder": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"azureStorageContainer": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"enableEncryption": true,
"hint": "string",
"regionId": "string",
"regionName": "string",
"azureAccountId": "string",
"environment": "Global",
"status": "Creating",
"storageTier": "Inferred",
"isStorageTierInferred": true,
"immutabilityEnabled": true,
"repositoryOwnership": {"hasAnotherOwner": true,
"currentOwnerIdentifier": "string",
"currentOwnerName": "string"
},
"concurrencyLimit": 1,
"_links": {"property1": {"href": null
},
"property2": {"href": null
}
}
},
"status": "Unknown",
"severity": "Success",
"message": "string",
"hasAnotherOwner": true,
"previousOwner": "string"
}
]
},
"repositoryEncryption": {"repositories": [{"repository": {"id": "string",
"name": "string",
"description": "string",
"azureStorageAccountId": "string",
"azureStorageAccountName": "string",
"azureStorageFolder": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"azureStorageContainer": {"name": "string",
"supportsVersioning": true,
"ImmutabilityPolicyState": "NotPresent",
"_links": {"property1": null,
"property2": null
}
},
"enableEncryption": true,
"hint": "string",
"regionId": "string",
"regionName": "string",
"azureAccountId": "string",
"environment": "Global",
"status": "Creating",
"storageTier": "Inferred",
"isStorageTierInferred": true,
"immutabilityEnabled": true,
"repositoryOwnership": {"hasAnotherOwner": true,
"currentOwnerIdentifier": "string",
"currentOwnerName": "string"
},
"concurrencyLimit": 1,
"_links": {"property1": {"href": null
},
"property2": {"href": null
}
}
},
"status": "Unknown",
"severity": "Success",
"encryptionMethod": "Unknown",
"message": "string"
}
]
},
"mfaUsers": {"users": [{"name": "string",
"role": "string",
"type": "string"
}
]
},
"ssoConfiguration": "Unknown"
}
}

Override Repository Owner

The HTTP POST request to the /configuration/overrideOwnership endpoint allows you to override the owner for the backup repositories with the specified IDs to the current backup appliance. To be able to override the owner for a backup repository, you must first add this repository to the current backup appliance by sending the HTTP POST request to the Add Backup Repository endpoint.

NOTE
As soon as you override a repository owner, backup policies configured on the backup appliance to which the repository previously belonged will start failing.

SecurityBearer

Request

Request Body schema: application/json

repositoryIds

Array of strings <uuid>

Specifies repositories for which you want to override the owner.

Responses

202

Accepted

400

Bad Request

401

Unauthorized

post/api/v8/configuration/overrideOwnership

Request samples

Payload
curl

application/json

{"repositoryIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

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": {"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"policyName": "string",
"policyType": "VirtualMachines",
"protectedInstancesCount": 0,
"policyRemoved": true
},
"healthCheckJobInfo": {"policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
"policyName": "string",
"checkedInstancesCount": 0,
"policyRemoved": true
},
"restoreJobInfo": {"reason": "string",
"backupPolicyDisplayName": "string"
},
"fileLevelRestoreJobInfo": {"initiator": "string",
"reason": "string",
"flrLink": {"url": "string",
"thumbprint": "string"
},
"vmId": "string",
"vmName": "string",
"backupPolicyDisplayName": "string",
"restorePointCreatedDateUtc": "2019-08-24T14:15:22Z",
"isFlrSessionReady": true
},
"fileShareFileLevelRestoreJobInfo": {"initiator": "string",
"reason": "string",
"flrLink": {"url": "string",
"thumbprint": "string"
},
"fileShareId": "string",
"fileShareName": "string",
"backupPolicyDisplayName": "string",
"restorePointCreatedDateUtc": "2019-08-24T14:15:22Z"
},
"repositoryJobInfo": {"repositoryId": "string",
"repositoryName": "string",
"repositoryRemoved": true
},
"restorePointDataRetrievalJobInfo": {"restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
"sqlRestorePointId": "859c4224-81c0-43b0-8c6a-f09eb203fa33",
"cosmosDbRestorePointId": "10233446-f8f4-4379-8a69-f08231b4f7b6",
"initiator": "string",
"instanceName": "string",
"daysToKeep": 0,
"dataRetrievalPriority": "Normal"
},
"retentionJobInfo": {"deletedRestorePointsCount": 0
},
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}
]