This is an archive version of the document. To get the most up-to-date information, see the current version.Get IAM Role Used to Launch Worker Instances
You can get an IAM role used by Veeam Backup for AWS to launch worker instances.
Note |
By default, Veeam Backup for AWS uses the Default Backup Restore IAM role to launch worker instances. The role is preconfigured and has necessary permissions to launch worker instances within the initial AWS account. |
Request
To retrieve a representation of an IAM role used to launch worker instances, send the HTTP GET request to the /settings/serviceAccount endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v1/settings/serviceAccount |
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 representation of the IAM role. The ServiceAccountSettings schema is used for the representation.
Example
The following request returns an IAM role used by Veeam Backup for AWS to launch worker instances.
|