Delete IP Set

Delete IP Set

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
URI
DELETE
https://nsxmanager.your.domain/api/v1/ip-sets/{ip-set-id}
COPY
Path Parameters
string
ip-set-id
Required

IPSet Id

Query Parameters
boolean
force
Optional

Force delete the resource even if it is being used somewhere

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

409

Conflict

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Grouping Objects Operations
POST
Add MAC Address
POST
Add Or Remove NS Group Expression
POST
Create IP Set
POST
Create MAC Set
POST
Create NS Group
POST
Create NS Service
POST
Create NS Service Group
DELETE
Delete IP Set
DELETE
Delete MAC Set
DELETE
Delete NS Group
DELETE
Delete NS Service
DELETE
Delete NS Service Group
GET
Get Effective IP Address Members
GET
Get Effective Logical Port Members
GET
Get Effective Logical Switch Members
GET
Get Effective Virtual Machine Members
GET
Get MAC Addresses
GET
Get Member Types
GET
Get Service Associations
GET
Get Unassociated Virtual Machines
GET
List IP Sets
GET
List MAC Sets
GET
List NS Groups
GET
List NS Service Groups
GET
List NS Services
GET
Read IP Set
GET
Read MAC Set
GET
Read NS Group
GET
Read NS Service
GET
Read NS Service Group
DELETE
Remove MAC Address
PUT
Update IP Set
PUT
Update MAC Set
PUT
Update NS Group
PUT
Update NS Service
PUT
Update NS Service Group