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

(DELETE) /cloud/gateways/{ID}

In this article

    Deletes a cloud gateway having the specified ID from the Veeam backup server connected to Veeam Backup Enterprise Manager.

    Request

    To remove a cloud gateway, you need to send the DELETE HTTP request to the URL of the /cloud/gateways/{ID} resource.

    HTTP Request

    DELETE http://<Enterprise-Manager>:9399/api/cloud/gateways/{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.

    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: application/xml.

    Response Body

    None.

    Example

    The example below removes a cloud gateway having ID b5025a7b-5e13-41e2-a17e-9d9af985ecfd.

    Request:

    DELETE http://localhost:9399/api/cloud/gateways/b5025a7b-5e13-41e2-a17e-9d9af985ecfd

     

    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>DeleteCloudGateway</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>DeleteCloudGateway</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>