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

Get Collection of Credentials Records

You can get a list of all SMTP server credentials records added to the Veeam Backup for AWS configuration database.

Request

To retrieve a representation of a collection of credentials records, send the HTTP GET request to the /accounts/standard endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v1/accounts/standard

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

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 /accounts/standard collection. The StandardAccount schema is used for the collection representation.

Get Collection of Credentials RecordsExample

The following request returns a full list of SMTP server credentials records added to the Veeam Backup for AWS configuration database.

Request:

GET https://135.169.170.192:11005/api/v1/accounts/standard

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "results": [

   {

     "id": "a71a58c5-3221-4965-ad6b-19465a0580e9",

     "name": "SMTP Mail",

     "username": "john.smith@company.com",

     "description": "Current SMTP server",

     "_links": [

       {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/a71a58c5-3221-4965-ad6b-19465a0580e9"

       },

       {

         "method": "PUT",

         "rel": "update",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/a71a58c5-3221-4965-ad6b-19465a0580e9"

       },

       {

         "method": "DELETE",

         "rel": "delete",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/a71a58c5-3221-4965-ad6b-19465a0580e9"

       }

     ]

   },

   {

     "id": "d8ae5f45-e421-4595-bca1-c94029e6abee",

     "name": "SMTP Standby",

     "username": "sara.baker@company.com",

     "description": "Standby SMTP server",

     "_links": [

       {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/d8ae5f45-e421-4595-bca1-c94029e6abee"

       },

       {

         "method": "PUT",

         "rel": "update",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/d8ae5f45-e421-4595-bca1-c94029e6abee"

       },

       {

         "method": "DELETE",

         "rel": "delete",

         "href": "https://135.169.170.192:11005/api/v1/accounts/standard/d8ae5f45-e421-4595-bca1-c94029e6abee"

       }

     ]

   }

 ],

 "totalCount": 2,

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/accounts/standard"

   }

 ]

}