This is an archive version of the document. To get the most up-to-date information, see the current version.

Get Collection of S3 Repositories

You can get a list of all S3 repositories added to the Veeam Backup for AWS configuration database.

Request

To retrieve a representation of a collection of S3 repositories, send the HTTP GET request to the /repositories endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v1/repositories

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

Query Parameter

Value

Description

Sort

  • nameAsc
  • nameDesc
  • descriptionAsc
  • descriptionDesc
  • amazonAccountNameAsc
  • amazonAccountNameDesc
  • amazonBucketAsc
  • amazonBucketDesc
  • amazonStorageFolderAsc
  • amazonStorageFolderDesc
  • regionAsc
  • regionDesc
  • encryptionAsc
  • encryptionDesc

Specifies the order of items in the response. For more information, see Sort Parameter.

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

x-api-version

Required

1.0-rev0

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

Accept

Optional

  • application/json
  • application/problem+json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns a representation of the /repositories collection. The Repository schema is used for the collection representation.

Get Collection of S3 RepositoriesExample

The following request returns a full list of S3 repositories added to the Veeam Backup for AWS configuration database.

Request:

GET https://135.169.170.192:11005/api/v1/repositories

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "totalCount": 2,

 "results": [

   {

     "id": "a7bcabe6-91f7-40ca-ad73-915d43a8e86b",

     "name": "Repository 01",

     "description": "Repository for Dept-01",

     "amazonAccountId": "757efdd7-128e-470c-90b6-1b274dbf502f",

     "amazonStorageFolder": "dept-1-rs",

     "amazonBucketId": "0dab1d93-ac17-482b-88a7-a56bebbb2b2e",

     "hint": "775",

     "enableEncryption": true,

     "_embedded": {

       "amazonAccount": "S3 Access Role",

       "amazonAccountLink": {

         "method": "GET",

         "rel": "AmazonAccount",

         "href": "https://135.169.170.192:11005/api/v1/accounts/amazon/757efdd7-128e-470c-90b6-1b274dbf502f"

       },

       "region": "us-east-1",

       "regionLink": {

         "method": "GET",

         "rel": "Region",

         "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/regions/a78f0156-7e78-4585-86ec-5cc590409def"

       },

       "bucket": "dept-1-1",

       "bucketLink": {

         "method": "GET",

         "rel": "Bucket",

         "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/buckets/0dab1d93-ac17-482b-88a7-a56bebbb2b2e"

       }

     },

     "_links": [

       {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b"

       },

       {

         "method": "PUT",

         "rel": "update",

         "href": "https://135.169.170.192:11005/api/v1/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b"

       },

       {

         "method": "DELETE",

         "rel": "delete",

         "href": "https://135.169.170.192:11005/api/v1/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b"

       },

       {

         "method": "POST",

         "rel": "rescan",

         "href": "https://135.169.170.192:11005/api/v1/repositories/a7bcabe6-91f7-40ca-ad73-915d43a8e86b/rescan"

       }

     ]

   },

   {

     "id": "34ea638c-242f-4c8f-8015-f6f7824cbdc3",

     "name": "Repository 02",

     "description": "Repository for Dept-01",

     "amazonAccountId": "757efdd7-128e-470c-90b6-1b274dbf502f",

     "amazonStorageFolder": "dept-1-js",

     "amazonBucketId": "0dab1d93-ac17-482b-88a7-a56bebbb2b2e",

     "enableEncryption": false,

     "_embedded": {

       "amazonAccount": "S3 Access Role",

       "amazonAccountLink": {

         "method": "GET",

         "rel": "AmazonAccount",

         "href": "https://135.169.170.192:11005/api/v1/accounts/amazon/757efdd7-128e-470c-90b6-1b274dbf502f"

       },

       "region": "us-east-1",

       "regionLink": {

         "method": "GET",

         "rel": "Region",

         "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/regions/a78f0156-7e78-4585-86ec-5cc590409def"

       },

       "bucket": "dept-1-1",

       "bucketLink": {

         "method": "GET",

         "rel": "Bucket",

         "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/buckets/0dab1d93-ac17-482b-88a7-a56bebbb2b2e"

       }

     },

     "_links": [

       {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/repositories/34ea638c-242f-4c8f-8015-f6f7824cbdc3"

       },

       {

         "method": "PUT",

         "rel": "update",

         "href": "https://135.169.170.192:11005/api/v1/repositories/34ea638c-242f-4c8f-8015-f6f7824cbdc3"

       },

       {

         "method": "DELETE",

         "rel": "delete",

         "href": "https://135.169.170.192:11005/api/v1/repositories/34ea638c-242f-4c8f-8015-f6f7824cbdc3"

       },

       {

         "method": "POST",

         "rel": "rescan",

         "href": "https://135.169.170.192:11005/api/v1/repositories/34ea638c-242f-4c8f-8015-f6f7824cbdc3/rescan"

       }

     ]

   }

 ],

 "_links": [

   {

     "method": "POST",

     "rel": "create",

     "href": "https://135.169.170.192:11005/api/v1/repositories"

   },

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/repositories"

   }

 ]

}