This is an archive version of the document. To get the most up-to-date information, see the current version.Validate IAM Role Name
You can check whether a name you plan to specify for an IAM role in Veeam Backup for AWS is unique.
Request
To validate an IAM role name, send the HTTP POST request to the /accounts/amazon/validateName endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/accounts/amazon/validateName |
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 check whether the IAM role name is unique, send the following parameter in the request body.
Parameter | Type | Description |
|---|---|---|
name | string | Specifies an IAM role name. |
Set the parameter value in the following format:
{ "name": "string" } |
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
If the IAM role name is unique, Veeam Backup for AWS does not return a response body, in other cases Veeam Backup for AWS returns the severity level and the error message.
Example
The following request checks whether the Backup Policy Role name is not used as an IAM role name in Veeam Backup for AWS.
|