This is an archive version of the document. To get the most up-to-date information, see the current version.Validate S3 Endpoint
You can check whether an S3 endpoint is configured for the subnet of an amazon connection with the specified ID.
Request
To check whether an S3 endpoint is configured, send the HTTP GET request to the /amazonConnections/{amazonConnectionId}/validateS3endpoint endpoint. {amazonConnectionId} is a system ID assigned to the amazon connection in the Veeam Backup for AWS REST API.
The subnetId parameter must be sent as part of the URL. Use the question mark (?) to separate the parameter from the endpoint. {subnetId} is an AWS ID of the selected subnet.
HTTP Request
GET https://<hostname>:<port>/api/v1/amazonConnections/{amazonConnectionId}/validateS3endpoint?subnetId={subnetId} |
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 the isValid parameter. The true value of the parameter signifies the S3 endpoint is configured for the subnet. The false value signifies the S3 endpoint for selected subnet is not configured.
Example
The following request verifies whether an S3 endpoint is configured for the subnet-0b23920a483b0ce42 subnet in an amazon connection with the ID 5cb4509e-ded8-41e6-812f-d0cc217a7d62.
|