VMware Cloud Director API - DELETE-EdgeGateway

DELETE /admin/edgeGateway/{id}

Operation:

Description:

Delete an edge gateway. Can only be used for Edge Gateways owned by an Organization vDC.

Since:

5.1

Input parameters

Consume media type(s):: None
Input type:: None

Query parameters

Parameter: force
Documentation
Parameter: recursive
Documentation

Output parameters

TaskType

This operation is asynchronous and returns a task that you can monitor to track the progress of the request.

Produce media type(s):: application/vnd.vmware.vcloud.task+xml
application/vnd.vmware.vcloud.task+json
Output type:: TaskType

Examples

Request: HTTP 1.1
DELETE /api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1

Headers:
x-vcloud-authorization: XRNaH2F+r/YvHG81NXAC/2N+smYdsJBcnFdgNt2ATbg=

Body:
Response: HTTP/1.1 202 Accepted

Headers:
Content-Length: 1354
Content-Type: application/vnd.vmware.vcloud.task+xml;version=5.5
Location: https://vcloud.example.com/api/task/f60c9703-61a2-4396-8fb1-c9f060d095fc
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><Task
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    cancelRequested="false"
    expiryTime="2013-05-14T19:28:20.098+03:00"
    href="https://vcloud.example.com/api/task/f60c9703-61a2-4396-8fb1-c9f060d095fc"
    id="urn:vcloud:task:f60c9703-61a2-4396-8fb1-c9f060d095fc"
    name="task"
    operation="Deleting EdgeGateway gateway(a5262305-d51d-4664-b380-827137a321f1)"
    operationName="networkEdgeGatewayDelete"
    serviceNamespace="com.vmware.vcloud"
    startTime="2013-02-13T19:28:20.098+02:00"
    status="running"
    type="application/vnd.vmware.vcloud.task+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
    <Link
        href="https://vcloud.example.com/api/task/f60c9703-61a2-4396-8fb1-c9f060d095fc/action/cancel"
        rel="task:cancel"/>
    <Owner
        href="https://vcloud.example.com/api/admin/edgeGateway/a5262305-d51d-4664-b380-827137a321f1"
        name="gateway"
        type="application/vnd.vmware.admin.edgeGateway+xml"/>
    <User
        href="https://vcloud.example.com/api/admin/user/1260efee-6915-494c-8afa-84e7e6d8a310"
        name="system"
        type="application/vnd.vmware.admin.user+xml"/>
    <Organization
        href="https://vcloud.example.com/api/org/7b832bc5-3d65-45a2-8d35-da28388ab80a"
        name="Default"
        type="application/vnd.vmware.vcloud.org+xml"/>
    <Details/>
</Task>