List All Infra Segments
Paginated list of all segments under infra.
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/segments
COPY
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
boolean
include_mark_for_delete_objects
Optional
Include objects that are marked for deletion in results
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns SegmentListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineSegmentListResult1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"advanced_config": {
"address_pool_paths": [
"string"
],
"hybrid": false,
"local_egress": false
},
"connectivity_path": "string",
"domain_name": "string",
"l2_extension": {
"l2vpn_path": "string",
"l2vpn_paths": [
"string"
],
"tunnel_id": 0
},
"ls_id": "string",
"overlay_id": 0,
"subnets": [
{
"dhcp_ranges": [
"string"
],
"gateway_address": "string",
"network": "string"
}
],
"transport_zone_path": "string",
"type": "string",
"vlan_ids": [
"string"
]
}
]
}
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
Infrastructure Infra Operations
PUT
Create Or Replace Infra Segment
PUT
Create Or Replace Infra Segment Port
PUT
Create Or Update Infra Segment Port Security Profile Binding
PUT
Create Or Update Infra Segment Security Profile Binding
PUT
Create Service Segment
DELETE
Delete Infra Port Discovery Binding
DELETE
Delete Infra Port Monitoring Binding
DELETE
Delete Infra Port Qo S Binding
DELETE
Delete Infra Segment
DELETE
Delete Infra Segment Discovery Binding
DELETE
Delete Infra Segment Monitoring Binding
DELETE
Delete Infra Segment Port
DELETE
Delete Infra Segment Port Security Profile Binding
DELETE
Delete Infra Segment Qo S Binding
DELETE
Delete Infra Segment Security Profile Binding
DELETE
Delete Service Segment
DELETE
Force Delete Infra Segment True
GET
Get Infra Port Discovery Binding
GET
Get Infra Port Monitoring Binding
GET
Get Infra Port Qo S Binding
GET
Get Infra Segment Discovery Binding
GET
Get Infra Segment Monitoring Binding
GET
Get Infra Segment Port
GET
Get Infra Segment Port Security Profile Binding
GET
Get Infra Segment Port Statistics
GET
Get Infra Segment Qo S Binding
GET
Get Infra Segment Security Profile Binding
GET
Get Infra Segment Statistics
GET
List All Infra Segments
GET
List Infra Port Discovery Bindings
GET
List Infra Port Monitoring Bindings
GET
List Infra Port Qo S Bindings
GET
List Infra Segment Discovery Bindings
GET
List Infra Segment Monitoring Bindings
GET
List Infra Segment Ports
GET
List Infra Segment Port Security Profile Bindings
GET
List Infra Segment Qo S Bindings
GET
List Infra Segment Security Profile Bindings
GET
List Service Segments
PATCH
Patch Infra Port Discovery Binding
PATCH
Patch Infra Port Monitoring Binding
PATCH
Patch Infra Port Qo S Binding
PATCH
Patch Infra Segment
PATCH
Patch Infra Segment Discovery Binding
PATCH
Patch Infra Segment Monitoring Binding
PATCH
Patch Infra Segment Port
PATCH
Patch Infra Segment Port Security Profile Binding
PATCH
Patch Infra Segment Qo S Binding
PATCH
Patch Infra Segment Security Profile Binding
PATCH
Patch Service Segment
GET
Read Infra Segment
GET
Read Service Segment
PUT
Update Infra Port Discovery Binding
PUT
Update Infra Port Monitoring Binding
PUT
Update Infra Port Qo S Binding
PUT
Update Infra Segment Discovery Binding
PUT
Update Infra Segment Monitoring Binding
PUT
Update Infra Segment Qo S Binding