Amazon S3 Buckets

The /buckets resource collection represents all Amazon S3 buckets to which IAM roles added to the Veeam Backup for AWS configuration database have permissions.

Get Collection of Amazon S3 Buckets

The HTTP GET request to the /cloudInfrastructure/buckets endpoint retrieves a list of all Amazon S3 buckets available to Veeam Backup for AWS.

SecurityBearer

Request

query Parameters

IAMRoleId	string <uuid> Returns only Amazon S3 buckets to which an IAM role with the specified ID has permissions. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Filter Parameter.
SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
Sort	Array of strings (BucketsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "nameAsc" "nameDesc"

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/cloudInfrastructure/buckets

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/buckets?IAMRoleId=497f6eca-6276-4993-bfeb-53cbbbba6f08&SearchPattern=string&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"results": [{"id": "02741a4e-34d4-4809-8e99-560cfeb7f6d7",
"name": "abor-frankfurt",
"location": {"id": "b7ec414c-dff8-467a-8dd9-fa52e5d684f8",
"name": "EU (Frankfurt) (eu-central-1)"
},
"immutabilityConfig": {"versioningState": "Enabled",
"s3ObjectLockMode": "Enabled",
"defaultLockPeriodState": "Disabled",
"canUseForImmutability": true
},
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/buckets/02741a4e-34d4-4809-8e99-560cfeb7f6d7"
},
{"method": "GET",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/b7ec414c-dff8-467a-8dd9-fa52e5d684f8"
}
]
},
{"id": "42f47353-26d1-4051-943b-713599213681",
"name": "zdbucketcoldbedeleted",
"location": {"id": "457658a7-3b87-4d1e-9734-1839937b54fc",
"name": "EU (Paris) (eu-west-3)"
},
"immutabilityConfig": {"versioningState": "Disabled",
"s3ObjectLockMode": "Disabled",
"defaultLockPeriodState": "Disabled",
"canUseForImmutability": false
},
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/buckets/42f47353-26d1-4051-943b-713599213681"
},
{"method": "GET",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/457658a7-3b87-4d1e-9734-1839937b54fc"
}
]
}
],
"totalCount": 2,
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/buckets"
}
]
}

Get Amazon S3 Bucket Data

The HTTP GET request to the the /cloudInfrastructure/buckets/{bucketId} endpoint retrieves information on an Amazon S3 bucket with the specified ID.

SecurityBearer

Request

path Parameters

bucketId

required

string <uuid>

Specifies the system ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.

Example: 02741a4e-34d4-4809-8e99-560cfeb7f6d7

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/cloudInfrastructure/buckets/{bucketId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/buckets/{bucketId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"id": "02741a4e-34d4-4809-8e99-560cfeb7f6d7",
"name": "abor-frankfurt",
"location": {"id": "b7ec414c-dff8-467a-8dd9-fa52e5d684f8",
"name": "EU (Frankfurt) (eu-central-1)"
},
"immutabilityConfig": {"versioningState": "Enabled",
"s3ObjectLockMode": "Enabled",
"defaultLockPeriodState": "Disabled",
"canUseForImmutability": true
},
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/buckets/02741a4e-34d4-4809-8e99-560cfeb7f6d7"
},
{"method": "GET",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/b7ec414c-dff8-467a-8dd9-fa52e5d684f8"
}
]
}

Perform Infrastructure Rescan for Amazon S3 Buckets

The HTTP POST request to the /cloudInfrastructure/buckets/rescan/{identityId} endpoint runs the infrastructure rescanning of Amazon S3 buckets operation for an IAM role with the specified ID.

SecurityBearer

Request

path Parameters

identityId

required

string <uuid>

System ID assigned to the IAM role in the Veeam Backup for AWS REST API.

Example: eca01dcc-d324-4017-92cb-04ec240aaf0a

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

202

Accepted

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/cloudInfrastructure/buckets/rescan/{identityId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/buckets/rescan/{identityId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Get Amazon S3 Bucket Folders

The HTTP GET request to the /cloudInfrastructure/buckets/{bucketId}/folders endpoint retrieves a list of all folders existing in an Amazon S3 bucket with the specified ID.

SecurityBearer

Request

path Parameters

bucketId

required

string <uuid>

Specifies the system ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API.

Example: 02741a4e-34d4-4809-8e99-560cfeb7f6d7

query Parameters

Offset	integer <int32> Excludes from a response the first N items of a resource collection.
Limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
Sort	Array of strings (BucketFoldersFiltersOrderColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "NameAsc" "NameDesc"

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/cloudInfrastructure/buckets/{bucketId}/folders

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/buckets/{bucketId}/folders?Offset=0&Limit=0&Sort=NameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 3,
"results": [{"name": "aws_le",
"folderId": "4e3ebf05-797b-417c-b9e9-b7db181b033d"
},
{"name": "usdept05-repository",
"folderId": "f719a75b-369b-48d9-a29b-20d4de05d2e0"
},
{"name": "usdept02_",
"folderId": "e7f1a4c7-d6b3-4e83-8799-ebecf0a38c56"
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/buckets/folders"
}
]
}

Get Amazon S3 Bucket Folder Data

The HTTP GET request to the /cloudInfrastructure/buckets/{bucketId}/folders/{folderName} endpoint retrieves information on an Amazon S3 bucket folder with the specified name.

SecurityBearer

Request

path Parameters

bucketId required	string <uuid> Specifies the system ID assigned to an Amazon S3 bucket in the Veeam Backup for AWS REST API. Example: 02741a4e-34d4-4809-8e99-560cfeb7f6d7
folderName required	string Name of a folder in the Amazon S3 bucket. Example: usdept05-repository

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/cloudInfrastructure/buckets/{bucketId}/folders/{folderName}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/cloudInfrastructure/buckets/{bucketId}/folders/{folderName}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"name": "usdept05-repository",
"folderId": "f719a75b-369b-48d9-a29b-20d4de05d2e0"
}