Management Plane API >
Grouping Objects
>
NS Groups
Delete NSGroup
Deletes the specified NSGroup. By default, if the NSGroup is added to
another NSGroup, it won't be deleted. In such situations, pass
"force=true" as query param to force delete the NSGroup.
Request:
Method:
DELETE
URI Path(s):
/api/v1/ns-groups/<ns-group-id>
Request Headers:
n/a
Query Parameters:
NSGroupDeleteRequestParameters
+
NSGroupDeleteRequestParameters
(
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/ ns-groups/183e372b-854c-4fcc-a24e-05721ce89a60 DELETE https://<nsx-mgr>/api/v1/ ns-groups/183e372b-854c-4fcc-a24e-05721ce89a60?force=true
Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a
Required Permissions:
crud
Feature:
groups_groups
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable