This is an archive version of the document. To get the most up-to-date information, see the current version.Add IAM Role
You can add an IAM role to the Veeam Backup for AWS configuration database.
Request
To add an IAM role, send the HTTP POST request to the /accounts/amazon endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/accounts/amazon |
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 add the IAM role, send the following parameters in the request body.
Parameter | Type | Description |
|---|---|---|
name | string | Specifies an IAM role name in Veeam Backup for AWS. |
description | string | Specifies a n IAM role description. |
accessKeys | [Applies only if the role is added using the Create a new IAM Role mode] Specifies parameters for the IAM role. | |
IAMRole | [Applies only if the role is added using the IAM Role from current account mode] Specifies parameters for the IAM role. | |
IAMRoleFromAnotherAccount | [Applies only if the role is added using the IAM Role from another account mode] Specifies parameters for the IAM role. |
Note |
Before you add an IAM role, you can check whether a name you plan to specify as an IAM role name in Veeam Backup for AWS is unique. For more information, see Validate IAM Role Name. |
AmazonAccountAccessKeyCreateSpec
AmazonAccountIAMRoleCreateSpec
AmazonAccountIAMRoleFromAnotherAccountCreateSpec
Set the parameter values in the following format:
{ "name": "string", "description": "string", "accessKeys": { "accessKey": "string", "secretKey": "string", "defaultRegionType": "Global" }, "IAMRole": { "roleName": "string" }, "IAMRoleFromAnotherAccount": { "accountId": "string", "roleName": "string", "externalId": "string" } } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 201 (Created).
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 added IAM role. The AmazonAccount schema is used for the resource representation.
Example
The following request adds an IAM role from another account to the Veeam Backup for AWS configuration database.
|