NSX-T Data Center REST API

Add a IP address to a IPSet

Add/Remove an individual IP address to an IPSet

Request:

Method:

POST

URI Path(s):

/api/v1/ip-sets/<ip-set-id>

Request Headers:

n/a

Query Parameters:

IPMemberAction+

IPMemberAction (schema)

Name	Description	Type	Notes
action	Specifies addition or removal action	string	Required Enum: add_ip, remove_ip

Request Body:

IPAddressElement+

IPAddressElement (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
ip_address		IPElement	Required

Example Request:

POST https://<nsx-mgr>/api/v1/ip-sets/183e372b-854c-4fcc-a24e-05721ce89a60?action=add_ip { "ip_address":"192.23.243.1" } example_response: | { "ip_address": "192.23.243.1", "_revision": 2 } POST https://<nsx-mgr>/api/v1/ip-sets/183e372b-854c-4fcc-a24e-05721ce89a60?action=remove_ip { "ip_address":"192.23.243.1" } example_response: | { "ip_address": "192.23.243.1", "_revision": 2 }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

IPAddressElement+

IPAddressElement (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
ip_address		IPElement	Required

Required Permissions:

crud

Feature:

groups_ip_sets

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