This is an archive version of the document. To get the most up-to-date information, see the current version.

Validate Removing of IAM Role

You can check whether the IAM role with the specified ID is not used by Veeam Backup for AWS and can be removed from the configuration database.

Request

To check whether an IAM role can be removed, send the HTTP POST request to the /accounts/amazon/{amazonAccountId}/validateDelete 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}/validateDelete

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

  • application/json
  • application/problem+json

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

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

If the IAM role can be removed, 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.

Validate Removing of IAM RoleExample

The following request checks whether an IAM role with the ID d98f4d37-7874-4be1-9702-770078f5c9cd can be removed from the Veeam Backup for AWS database.

Request:

POST https://135.169.170.192:11005/api/v1/accounts/amazon/d98f4d37-7874-4be1-9702-770078f5c9cd/validateDelete

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200