Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Accounts

The /Accounts resource collection represents cloud credentials that you use to access cloud storage services.

Get Accounts

Returns a list of existing cloud credentials.

SecurityBearer
Request
query Parameters
name
string

Specifies a cloud account name. To filter objects, you can use * and ? wildcard characters.

accountType
string

Specifies a cloud account type.

Enum: "azureBlobAccount" "amazonS3Account" "amazonS3CompatibleAccount"
organizationId
string <uuid>

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

Responses
200

OK

default

Operation failure response.

get/v8/Accounts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Account
Adds a new cloud credentials.


x-codegen-request-body-name:  account
SecurityBearer 
Request 
Request Body schema: application/json
required
accountType
string or null
Specifies a cloud account type.


 Enum: "azureBlobAccount" "amazonS3Account" "amazonS3CompatibleAccount"  
userName
string
Specifies a cloud account user name. Must contain only lowercase characters.


 
password
string <password>  (SecureString) 
Specifies a password.


 
id
string or null <uuid> 
Specifies a cloud account ID.


 
description
string
Specifies a cloud account description.


 
organizationId
string or null <uuid> 
Backed-up organization ID.


 
object (RESTLinkHALDictionary) 
Related resources.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Accounts
Request samples 
application/json
{
  • "accountType": "azureBlobAccount",
  • "userName": "string",
  • "password": "pa$$word",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "description": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "_links": {
    }
}
Response samples 
application/json
{
  • "accountType": "azureBlobAccount",
  • "userName": "string",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "description": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "_links": {
    }
}
Get Account Properties by Account ID
Returns a list of properties for the specified account.


SecurityBearer 
Request 
path Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Accounts/{accountId}
Request samples 
Response samples 
application/json
{
  • "accountType": "azureBlobAccount",
  • "userName": "string",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "description": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "_links": {
    }
}
Edit Account
Modifies cloud credentials with the specified ID.


x-codegen-request-body-name:  account
SecurityBearer 
Request 
path Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
Request Body schema: application/json
required
accountType
string or null
Specifies a cloud account type.


 Enum: "azureBlobAccount" "amazonS3Account" "amazonS3CompatibleAccount"  
userName
string
Specifies a cloud account user name. Must contain only lowercase characters.


 
password
string <password>  (SecureString) 
Specifies a password.


 
id
string or null <uuid> 
Specifies a cloud account ID.


 
description
string
Specifies a cloud account description.


 
organizationId
string or null <uuid> 
Backed-up organization ID.


 
object (RESTLinkHALDictionary) 
Related resources.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Accounts/{accountId}
Request samples 
application/json
{
  • "accountType": "azureBlobAccount",
  • "userName": "string",
  • "password": "pa$$word",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "description": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "_links": {
    }
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Account
Removes cloud credentials with the specified ID from the Veeam Backup for Microsoft 365 database. Consider that you cannot remove an account that is in use.


SecurityBearer 
Request 
path Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/Accounts/{accountId}
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