Veeam Service Provider Console 9.1
REST API Reference
Related documents

Public Cloud AWS

This resource collection represents AWS entities connected to Veeam Service Provider Console.

Create AWS Account

Creates an AWS account in a Veeam Cloud Connect site with the specified UID.

Request
path Parameters
siteUid
required
string <uuid>

Veeam Cloud Connect site UID.

query Parameters
Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Request Body schema: application/json
required
accessKey
required
string [ 1 .. 255 ] characters

AWS access key.

secretKey
required
string <password> [ 1 .. 1024 ] characters

AWS access secret key.

description
string or null <= 250 characters

Description of an account.

Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

post/infrastructure/sites/{siteUid}/publicCloud/aws/accounts
Request samples
application/json
{
  • "accessKey": "AKIAIOSYFWMCY6EPFODNN",
  • "secretKey": "IARGqk4zm1W0CILr3BMu2y9ylvtI6OkGq7Vc9jVw",
  • "description": "Created by Veeam Service Provider Console. My Company: BM-1\\Administrator"
}
Response samples
application/json
{
  • "data": {
    }
}

Get All AWS Accounts

Returns a collection resource representation of all AWS accounts managed by a Veeam Cloud Connect site with the specified UID.

Request
path Parameters
siteUid
required
string <uuid>

Veeam Cloud Connect site UID.

query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/infrastructure/sites/{siteUid}/publicCloud/aws/accounts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get AWS Account
Returns a resource representation of an AWS account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
AWS account UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify AWS Account
Modifies an AWS account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
AWS account UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete AWS Account
Delete an AWS account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
AWS account UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Grant Permissions to Update Veeam Backup for AWS Appliance
Grants permissions necessary to update an Veeam Backup for AWS appliance to an account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
AWS account UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
accessKey
required
string
AWS access key.


 
secretKey
required
string <password> 
AWS access secret key.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}/grantPermissionsForMigration
Request samples 
application/json
{
  • "accessKey": "AKIAIOSYFWMCY6EPFODNN",
  • "secretKey": "IARGqk4zm1W0CILr3BMu2y9ylvtI6OkGq7Vc9jVw"
}
Response samples 
application/json
{
  • "data": {
    }
}
Validate Veeam Backup for AWS Appliance Credentials
Verifies that account used to access a backup device with the specified UID has permissions to install backup device update.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
AWS account UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}/validateCloudCredentialsForMigration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get AWS Datacenters
Returns a collection resource representation of all AWS datacenters registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
regionId
required
string
AWS region ID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/dataCenters
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Add Amazon Connection
Adds Amazon connection in a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
AWS account UID.


 
dataCenterId
required
string
AWS datacenter ID.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/connection
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Amazon Connection
Deletes Amazon connection with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
connectionUid
required
string <uuid> 
Amazon connection UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/sites/{siteUid}/publicCloud/aws/connection/{connectionUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All AWS VMs
Returns a collection resource representation of all AWS VMs registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
dataCenterId
required
string
AWS datacenter ID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/virtualMachines
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All AWS Regions
Returns a collection resource representation of all AWS regions.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/regions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All AWS Networks
Returns a collection resource representation of all AWS networks registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/networks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All AWS Subnets
Returns a collection resource representation of all AWS subnets registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
networkId
required
string
AWS network ID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/subnets
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get AWS Elastic IP Addresses
Returns a collection resource representation of all Elastic IP addresses available to AWS accounts registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/ipAddresses
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Cloud Connect Site IP Adresses
Returns a collection resource representation of IP addresses assigned in AWS to a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/backupServerIpAddresses
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Amazon Encryption Keys
Returns a collection resource representation of all Amazon encryption keys.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/keys
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Amazon Encryption Key
Creates an Amazon encryption key.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
connectionUid
required
string <uuid> 
UID assigned to an Amazon connection.


 
name
required
string
Name of an EC2 key pair.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/keys
Request samples 
application/json
{
  • "connectionUid": "f854a9fc-df97-40c9-8c32-c5fab9ad13d5",
  • "name": "[PortalAdministrator]_keyPair"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All AWS Security Groups
Returns a collection resource representation of all AWS security groups registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
connectionUid
required
string <uuid> 
Amazon connection UID.


 
networkId
required
string
Network ID.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/securityGroups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Veeam Backup for AWS Appliance
Creates a new Veeam Backup for AWS appliance registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
required
object
 
object or null
Veeam Backup for Public Clouds appliance network resources.




If you send the null value, all required resources will be created automatically.'




 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/deploy
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": {
    },
  • "ipAddress": {
    },
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Connect Veeam Backup for AWS Appliance
Connects an existing Veeam Backup for AWS appliance registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
object or null
 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/connect
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": null,
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Validate Veeam Backup for AWS Appliance
Validates an existing Veeam Backup for AWS appliance connection registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
object or null
 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/validate
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": null,
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup for AWS Appliance
Returns a resource representation of an Veeam Backup for AWS appliance with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
applianceUid
required
string <uuid> 
Veeam Backup for AWS appliance UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Backup for AWS Appliance
Modifies an Veeam Backup for AWS appliance with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
applianceUid
required
string <uuid> 
Veeam Backup for AWS appliance UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/{applianceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345