[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Delete Group

Description

Delete Group

Request

Request

URL

URL


delete
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}
Copy

Path Parameters

Path Parameters

string
domain-id Required

Domain ID


string
group-id Required

Group ID


Query Parameters

Query Parameters

boolean
fail_if_subtree_exists Optional

Do not delete if the group subtree has any entities


boolean
force Optional

Force delete the resource even if it is being used somewhere


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

Errors

Errors

ApiError
400

Bad Request


ApiError
403

Forbidden


ApiError
404

Not Found


ApiError
412

Precondition Failed


ApiError
500

Internal Server Error


ApiError
503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-DeleteGroup -domainId "MydomainId" -groupId "MygroupId" -failIfSubtreeExists $true -force $true

cURL Command

curl -X DELETE https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete-group
x-vmw-nsx-module: Policy


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Feedback

Was this page helpful?