This is an archive version of the document. To get the most up-to-date information, see the current version.Infrastructure Rescan for IAM Role
You can run the infrastructure rescanning operation for an IAM role with the specified ID.
Request
To run infrastructure rescan, send the HTTP POST request to the /accounts/amazon/{amazonAccountId}/rescan endpoint. {amazonAccountId} is a system ID assigned to the IAM role in the Veeam Backup for AWS REST API.
HTTP Request
POST https://<hostname>:<port>/api/v1/accounts/amazon/{amazonAccountId}/rescan |
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. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
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. |
Request Body
To specify the exact AWS regions you want to synchronize for the IAM role, send the following parameter in the request body.
Parameter | Required/Optional | Type | Description |
|---|---|---|---|
regionIds | Optional | array[string] | Specifies system IDs assigned in the Veeam Backup for AWS REST API to AWS regions you want to rescan. By default, all available AWS regions and Availability Zones are synchronized. |
Set the parameter value in the following format:
{ "regionIds": [ "string", "string" ] } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 202 (Accepted).
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 session ID of the infrastructure rescanning operation. For the session log details, see Get Session Log Details.
Example
The following request runs rescan operation for an IAM role with the ID aa8bb04c-1e70-4ddf-9e35-7149e4920d1e in the AWS region with the ID 445b2c74-c89a-4bc0-aca0-3e4ad1553f01 .
|