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

Remove IAM Role

You can remove an IAM role with the specified ID from the Veeam Backup for AWS configuration database.

Note

Before you remove an IAM role from the configuration database, make sure that the role is not used by Veeam Backup for AWS. For more information on how to check whether the IAM role can be removed, see Validate Removing of IAM Role.

Request

To remove an IAM role, send the HTTP DELETE request to the /accounts/amazon/{amazonAccountId} endpoint. {amazonAccountId} is a system ID assigned to the IAM role in the Veeam Backup for AWS REST API.

HTTP Request

DELETE https://<hostname>:<port>/api/v1/accounts/amazon/{amazonAccountId}

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 204 (No Content).

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.

Remove IAM RoleExample

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

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

204