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

(DELETE) /cloud/tenants/{ID}/subtenants/{ID}

Deletes a subtenant account with the specified ID for the tenant account with the specified ID.

Request

To remove a subtenant account, you need to send the DELETE HTTP request to the URL of the /cloud/tenants/{ID}/subtenants/{ID} resource.

HTTP Request

DELETE http://<Enterprise-Manager>:9399/api/cloud/tenants/{ID}/subtenants/{ID}

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

False

Identifies the format of the response. Possible values:

application/xml — the client can sent this value in the header to accept response in the XML format.
application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 202 Accepted.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

application/xml
application/json

Response Body

None.

Example

The example below removes a subtenant account that has ID 0eb0c130-d91a-4e05-9403-ac2ded0fc1ea.

Request:

DELETE http://localhost:9399/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

202 Accepted

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
<Links>
<Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
</Links>
<TaskId>task-1</TaskId>
<State>Running</State>
<Operation>DeleteCloudSubtenant</Operation>
</Task>

To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

Request:

GET http://localhost:9399/api/tasks/task-1

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 Success

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
<Links>
<Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
</Links>
<TaskId>task-1</TaskId>
<State>Finished</State>
<Operation>DeleteCloudSubtenant</Operation>
<Result Success="true">
<Message>Ok</Message>
</Result>
</Task>