Management Plane API >
Grouping Objects
>
IP Sets
Delete IPSet
Deletes the specified IPSet. By default, if the IPSet is added to an
NSGroup, it won't be deleted. In such situations, pass "force=true" as
query param to force delete the IPSet.
Request:
Method:
DELETE
URI Path(s):
/api/v1/ip-sets/<ip-set-id>
Request Headers:
n/a
Query Parameters:
IPSetDeleteRequestParameters
+
IPSetDeleteRequestParameters
(
schema
)
Name
Description
Type
Notes
force
Force delete the resource even if it is being used somewhere
If true, deleting the resource succeeds even if it is being
referred as a resource reference.
boolean
Default: "False"
Request Body:
n/a
Example Request:
DELETE https://<nsx-mgr>/api/v1/ip-sets/22dc1d1a-adcb-4c58-874e-6e783df02790 DELETE https://<nsx-mgr>/api/v1/ip-sets/22dc1d1a-adcb-4c58-874e-6e783df02790 ?force=true
Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a
Required Permissions:
crud
Feature:
groups_ip_sets
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable