NSX-T Data Center REST API

Delete Group

Delete Group This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

DELETE

URI Path(s):

/policy/api/v1/infra/domains/<domain-id>/groups/<group-id>

Request Headers:

n/a

Query Parameters:

GroupDeleteRequestParameters+

GroupDeleteRequestParameters (schema)

(Deprecated)

Name	Description	Type	Notes
fail_if_subtree_exists	Do not delete if the group subtree has any entities Check if the group sub-tree has any entities. These primarily include the binding maps that point to various profiles. If this flag is passed as true, the group delete fails if any binding maps exist in the group sub-tree. By default, this flag is false, which means that the group is deleted along with the group sub-tree.	boolean	Default: "False"
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://<policy-mgr>/policy/api/v1/infra/domains/vmc/groups/webgroup

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Required Permissions:

crud

Feature:

policy_grouping

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable