This is an archive version of the document. To get the most up-to-date information, see the current version.Get Amazon Connection Security Groups
You can get a list of all security groups of an amazon connection with the specified ID.
Request
To retrieve a representation of a collection of security groups of a specific amazon connection, send the HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudSecurityGroups endpoint. {amazonConnectionId} is a system ID assigned to the amazon connection in the Veeam Backup for AWS REST API.
HTTP Request
GET https://<hostname>:<port>/api/v1/amazonConnections/{amazonConnectionId}/cloudSecurityGroups |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
cloudNetworkId | string | Returns only security groups that belongs to an Amazon VPC with the specified AWS ID. For more information, see Filter Parameters. |
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 |
| 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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns a list of security groups of the amazon connection with the specified ID. The CloudSecurityGroup schema is used for the collection representation.
Example
The following request returns a full list of security groups of an amazon connection with the ID 2c7eb8fb-40e3-4495-9dc9-30f969277917.
|