NSX-T Data Center REST API

Associated URIs:

API Description API Path

Returns the compliance status


Returns the compliance status and details of non compliant configuration
GET /policy/api/v1/compliance/status

For each type of entity what are the attributes owned by policy.


This API provides field names of attributes in NSX types that are owned by
Policy, as opposed to those owned by the enforcement point. For any type on NSX,
some of the attributes of that type may be owned and set by Policy when realizing
the intent, while some others may be owned and set by the enforcement point itself.
This information can be used to deactivate updates to Policy owned attributes by the
advanced networking UI, while allowing tweaking to the attributes owned by the
management plane.
GET /policy/api/v1/fine-tuning/resources

List AntreaTraceflowConfig for infra


Paginated list of all AntreaTraceflowConfig for infra.
GET /policy/api/v1/infra/antrea/traceflows

Delete Antrea traceflow config


Delete Antrea traceflow config with id traceflow-id
DELETE /policy/api/v1/infra/antrea/traceflows/{traceflow-id}

Read Antrea traceflow config


Read Antrea traceflow config with id traceflow-id
GET /policy/api/v1/infra/antrea/traceflows/{traceflow-id}

Create an Antrea traceflow config


If an Antrea traceflow config with the traceflow-id is not
already present, create a new traceflow config.
PATCH /policy/api/v1/infra/antrea/traceflows/{traceflow-id}

Restart Antrea traceflow with same set of parameters used during create traceflow


This will retrace even if current traceflow has observations. Current
observations will be lost. Traceflow configuration will be cleaned up
by the system after two hours of inactivity.
POST /policy/api/v1/infra/antrea/traceflows/{traceflow-id}

Create an Antrea traceflow config


If an Antrea traceflow config with the traceflow-id is not
already present, create a new traceflow config.
PUT /policy/api/v1/infra/antrea/traceflows/{traceflow-id}

Read Antrea traceflow observations


Read Antrea traceflow observations for id traceflow-id
GET /policy/api/v1/infra/antrea/traceflows/{traceflow-id}/observations

Read Antrea traceflow status


Read Antrea traceflow status with id traceflow-id
GET /policy/api/v1/infra/antrea/traceflows/{traceflow-id}/status

Returns capacity usage data for NSX objects


GET /policy/api/v1/infra/capacity/dashboard/usage

Returns warning threshold(s) set for NSX Objects.


Returns warning threshold(s) set for NSX Objects.
GET /policy/api/v1/infra/capacity/threshold

Updates the thresholds for specified NSX Objects.


Updates the warning threshold(s) for NSX Objects specified, does not modify
thresholds for any other objects. Threshold type NUMBER_OF_GATEWAY_POLICY is deprecated instead use NUMBER_OF_GATEWAY_FIREWALL_RULES.
PATCH /policy/api/v1/infra/capacity/threshold

Updates the warning threshold(s) for NSX Objects.


Updates the warning threshold(s) for NSX Objects specified, and returns
new threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT
threshold_type which represents global thresholds. Threshold type NUMBER_OF_GATEWAY_POLICY is deprecated instead use NUMBER_OF_GATEWAY_FIREWALL_RULES.
PUT /policy/api/v1/infra/capacity/threshold

Returns capacity usage data for NSX objects


GET /policy/api/v1/infra/capacity/usage (Deprecated)

List IPFIX Collector profiles.


API will provide list of all IPFIX dfw collector profiles and
their details.
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles

Delete IPFIX dfw Collector profile


API deletes IPFIX dfw collector profile. Flow forwarding to
collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-dfw-collector-profiles/{ipfix-dfw-collector-profile-id}

Get IPFIX dfw Collector profile


API will return details of IPFIX dfw collector profile. If profile
does not exist, it will return 404.
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles/{ipfix-dfw-collector-profile-id}

IPFIX dfw collector profile id


Create a new IPFIX dfw collector profile if the IPFIX dfw collector profile with
given id does not already exist. If the IPFIX dfw collector profile with the
given id already exists, patch with the existing IPFIX dfw collector profile.
PATCH /policy/api/v1/infra/ipfix-dfw-collector-profiles/{ipfix-dfw-collector-profile-id}

Create or Replace IPFIX dfw collector profile


Create or Replace IPFIX dfw collector profile. IPFIX data will be sent to IPFIX
collector port.
PUT /policy/api/v1/infra/ipfix-dfw-collector-profiles/{ipfix-dfw-collector-profile-id}

List IPFIX DFW Profile


API provides list IPFIX DFW profiles available on
selected logical DFW.
GET /policy/api/v1/infra/ipfix-dfw-profiles

Delete IPFIX DFW Profile


API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop
receiving flows.
DELETE /policy/api/v1/infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}

Get IPFIX DFW Profile


API will return details of IPFIX DFW profile.
GET /policy/api/v1/infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}

Patch IPFIX DFW profile


Create a new IPFIX DFW profile if the IPFIX DFW profile
with given id does not already exist. If the IPFIX DFW
profile with the given id already exists, patch with
the existing IPFIX DFW profile.
PATCH /policy/api/v1/infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}

Create or Replace IPFIX DFW collection Config.


Create or replace IPFIX DFW profile. Config will start
forwarding data to provided IPFIX DFW collector.
PUT /policy/api/v1/infra/ipfix-dfw-profiles/{ipfix-dfw-profile-id}

List IPFIX Collector profiles.


API will provide list of all IPFIX collector profiles and their details.
GET /policy/api/v1/infra/ipfix-l2-collector-profiles

Delete IPFIX Collector profile


API deletes IPFIX collector profile. Flow forwarding to
collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}

Get IPFIX Collector profile


API will return details of IPFIX collector profile.
GET /policy/api/v1/infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}

Patch IPFIX collector profile


Create a new IPFIX collector profile if the IPFIX collector profile with
given id does not already exist. If the IPFIX collector profile with the
given id already exists, patch with the existing IPFIX collector profile.
PATCH /policy/api/v1/infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}

Create or Replace IPFIX collector profile


Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX
collector.
PUT /policy/api/v1/infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}

List IPFIX L2 Profiles


API provides list IPFIX L2 Profiles available on
selected logical l2.
GET /policy/api/v1/infra/ipfix-l2-profiles

Delete IPFIX L2 Profile


API deletes IPFIX L2 Profile. Flow forwarding to
selected collector will be stopped.
DELETE /policy/api/v1/infra/ipfix-l2-profiles/{ipfix-l2-profile-id}

Get IPFIX L2 Profile


API will return details of IPFIX L2 profile.
GET /policy/api/v1/infra/ipfix-l2-profiles/{ipfix-l2-profile-id}

Patch IPFIX L2profile


Create a new IPFIX L2 profile if the IPFIX L2 profile
with given id does not already exist. If the IPFIX L2 profile
with the given id already exists, patch with the existing IPFIX L2
profile.
PATCH /policy/api/v1/infra/ipfix-l2-profiles/{ipfix-l2-profile-id}

Create or Replace IPFIX L2 profile


Create or replace IPFIX L2 Profile. Profile is reusable entity. Single
profile can attached multiple bindings e.g group, segment and port.
PUT /policy/api/v1/infra/ipfix-l2-profiles/{ipfix-l2-profile-id}

List latency profiles


GET /policy/api/v1/infra/latency-profiles

Delete latency profile


Delete an existing latency profile
DELETE /policy/api/v1/infra/latency-profiles/{profile-id}

Read latency profile


Read latency profile.
GET /policy/api/v1/infra/latency-profiles/{profile-id}

Patch latency profile


Patch latency profile.
PATCH /policy/api/v1/infra/latency-profiles/{profile-id}

Create or Replace latency profile


Create or Replace latency profile.
PUT /policy/api/v1/infra/latency-profiles/{profile-id}

List livetrace config entities


Get a paginated list of all livetrace config entities.
GET /policy/api/v1/infra/livetraces

Delete a livetrace config


Delete livetrace config with the specified identifier.
DELETE /policy/api/v1/infra/livetraces/{livetrace-id}

Read a livetrace config


Read livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/{livetrace-id}

Create or update a livetrace config


If a livetrace config with the specified identifier is not present, then
create a new livetrace config. If it already exists, update the livetrace
config with a full replacement.
PATCH /policy/api/v1/infra/livetraces/{livetrace-id}

Restart a livetrace session


Restart a livetrace session with the same set of parameters used in creating or updating of a livetrace config.
POST /policy/api/v1/infra/livetraces/{livetrace-id}

Create or update a livetrace config


If a livetrace config with the specified identifier is not present, then
create a new livetrace config. If it already exists, update the livetrace
config with a full replacement.
PUT /policy/api/v1/infra/livetraces/{livetrace-id}

Get forward packet capture file for the specified livetrace session


You must provide the request header
"Accept:application/octet-stream" when calling this API.
The capture file can only be found in MP which receives the capture request.
GET /policy/api/v1/infra/livetraces/{livetrace-id}/forward/capturefile

Read livetrace result


Read result for a livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/{livetrace-id}/result

Get reverse packet capture file for the specified livetrace session


You must provide the request header
"Accept:application/octet-stream" when calling this API.
The capture file can only be found in MP which receives the capture request.
GET /policy/api/v1/infra/livetraces/{livetrace-id}/reverse/capturefile

Read livetrace status


Read status for a livetrace config with the specified identifier.
GET /policy/api/v1/infra/livetraces/{livetrace-id}/status

List livetrace status entities


Get a list of all livetrace status entities.
GET /policy/api/v1/infra/livetraces/statuses

List Port Mirroring Profiles


API will list all port mirroring profiles group.
GET /policy/api/v1/infra/port-mirroring-profiles

Delete Port Mirroring Profile


API will delete port mirroring profile. Mirroring from source to destination
ports will be stopped.
DELETE /policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}

Details of Port Mirroring Profile


API will return details of port mirroring profile.
GET /policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}

Patch Port Mirroring Profile.


Create a new Port Mirroring Profile if the Port Mirroring Profile with
given id does not already exist. If the Port Mirroring Profile with the
given id already exists, patch with the existing Port Mirroring Profile.
Realized entities of this API can be found using the path of monitoring
profile binding map that is used to apply this profile.
PATCH /policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}

Create or Replace Port Mirroring Profile.


Create or Replace port mirroring profile. Packets will be mirrored from
source group, segment, port to destination group.
Realized entities of this API can be found using the path of monitoring
profile binding map that is used to apply this profile.
PUT /policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}

Get the details of latency status in given appliance.


GET /policy/api/v1/infra/sha/appliances/{appliance-id}/latency/status

Get the details of process status in given appliance.


GET /policy/api/v1/infra/sha/appliances/{appliance-id}/process/status

Get the details of latency status for all appliances


GET /policy/api/v1/infra/sha/appliances/latency/status

Get the list of process status for all appliances.


GET /policy/api/v1/infra/sha/appliances/process/status

API will provide list of Sha Dynamic plugins.


API will provide list of Sha Dynamic plugins.
GET /policy/api/v1/infra/sha/dynamic-plugins
GET /policy/api/v1/global-infra/sha/dynamic-plugins

Delete Sha dynamic plugin


Delete Sha dynamic plugin.
DELETE /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}

Read Sha dynamic plugin


Read Sha dynamic plugin.
GET /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}
GET /policy/api/v1/global-infra/sha/dynamic-plugins/{plugin-id}

Create or Replace Sha dynamic plugin


Create or Replace Sha dynamic plugin.
PATCH /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}

Create Sha dynamic plugin


Create Sha dynamic plugin.
PUT /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}

Upload Sha dynamic plugin


Upload Sha dynamic plugin content.
POST /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}/files/{file-name}

List Dynamic Runbook Instances


List Online Diagnostic System Dynamic Runbooks Instances.
GET /policy/api/v1/infra/sha/dynamic-runbook-instances

Delete the Dynamic Runbook Instance


DELETE /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Read a Dynamic Runbook Instance


Read Online Diagnostic System Dynamic Runbook Instance.
GET /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Create or update a Dynamic Runbook Instance


Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier
if not existed, or update an existing Online Diagnostic System Dynamic Runbook Instance
otherwise.
PATCH /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Create a Dynamic Runbook Instance


Create an Online Diagnostic System Dynamic Runbook Instance with the specified identifier
POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}

Uninstall the Dynamic Runbook package from the instance


DELETE /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file

Install the Dynamic Runbook package. Please specify the header "Content-Type: application/octet-stream" in the http request.


POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file

Remedy the Dynamic Runbook installation


POST /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/file/action/remedy

Read a Dynamic Runbook Instance state


Read Online Diagnostic System Dynamic Runbook Instance state
GET /policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/state

List Dynamic Runbooks


List Online Diagnostic System Dynamic Runbooks.
GET /policy/api/v1/infra/sha/dynamic-runbooks

Read a Dynamic Runbook


Read Online Diagnostic System Dynamic Runbook.
GET /policy/api/v1/infra/sha/dynamic-runbooks/{runbook-id}

Read help information of a Dynamic Runbook


Read help information of an Online Diagnostic System Dynamic Runbook.
GET /policy/api/v1/infra/sha/dynamic-runbooks/{runbook-id}/help

Read SHA existing monitor list.


Read SHA existing monitor list.
GET /policy/api/v1/infra/sha/monitors

List the status of SHA monitors


List the status of SHA monitors on certain transport node.
GET /policy/api/v1/infra/sha/monitors-status

Read certain SHA monitor.


Read certain SHA monitor.
GET /policy/api/v1/infra/sha/monitors/{monitor-id}

List SHA monitor profile


List SHA monitor profile.
GET /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles

Delete a SHA monitor profile


Delete a SHA monitor profile.
DELETE /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}

Read a SHA monitor profile


Read a SHA monitor profile.
GET /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}

Create or update a SHA monitor profile


Create or update a SHA monitor profile.
PATCH /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}

Create or update a SHA monitor profile


Create or update a SHA monitor profile.
PUT /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}

Read the SHA monitor status


Read the SHA monitor status on certain transport node.
GET /policy/api/v1/infra/sha/monitors/{monitor-id}/status

API will provide list of SHA profiles.


API will provide list of SHA profiles.
GET /policy/api/v1/infra/sha/plugin-profiles
GET /policy/api/v1/global-infra/sha/plugin-profiles

Delete SHA profile


Delete Sha profile.
DELETE /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}

API will return Sha profile


API will return Sha profile.
GET /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}
GET /policy/api/v1/global-infra/sha/plugin-profiles/{sha-profile-id}

Create or Replace SHA profile


Create or Replace Sha profile.
PATCH /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}

Create or Replace Sha profile


Create or Replace Sha profile.
PUT /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}

Show the plugins status on given node.


Show all the installed system health plugins on given node
GET /policy/api/v1/infra/sha/plugin-status/{node-id}
GET /policy/api/v1/global-infra/sha/plugin-status/{node-id}

API will provide list of Sha pre-defined list.


API will provide list of Sha pre-defined plugins.
GET /policy/api/v1/infra/sha/pre-defined-plugins
GET /policy/api/v1/global-infra/sha/pre-defined-plugins

Read Sha pre-defined plugin


Read SHA pre-defined plugin.
GET /policy/api/v1/infra/sha/pre-defined-plugins/{plugin-id}
GET /policy/api/v1/global-infra/sha/pre-defined-plugins/{plugin-id}

List Predefined Runbooks


List Online Diagnostic System Predefined Runbooks.
GET /policy/api/v1/infra/sha/pre-defined-runbooks

Read a Predefined Runbook


Read Online Diagnostic System Predefined Runbook.
GET /policy/api/v1/infra/sha/pre-defined-runbooks/{runbook-id}

Read help information of a Predefined Runbook


Read help information of an Online Diagnostic System Predefined runbook.
GET /policy/api/v1/infra/sha/pre-defined-runbooks/{runbook-id}/help

List runbook invocation artifacts


Get a paginated list of Online Diagnostic System Runbook invocation artifacts.
GET /policy/api/v1/infra/sha/runbook-artifacts

Delete a runbook invocation artifact batch request


Delete an Online Diagnostic System Runbook invocation batch request.
DELETE /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Read the status of a runbook invocation batch request


Read the status of a runbook invocation batch request.
GET /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Create request to collect artifacts generated by an Online Diagnostic System runbook invocations


Create request to collect the artifacts generated by Online Diagnostic System runbook invocations in a batch.
PATCH /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Create request to collect artifacts generated by an Online Diagnostic System runbook invocations


Create request to collect the artifacts generated by Online Diagnostic System runbook invocations in a batch.
PUT /policy/api/v1/infra/sha/runbook-artifacts/{request-id}

Download the collection of artifacts generated by an Online Diagnostic System runbook invocations


Download the collection of artifacts generated by an Online Diagnostic System runbook invocations.
Please add the below header in the http request, if it is not present
Accept application/octet-stream
GET /policy/api/v1/infra/sha/runbook-artifacts/{request-id}/artifact

List runbook invocations


Get a paginated list of Online Diagnostic System Runbook invocation entities.
GET /policy/api/v1/infra/sha/runbook-invocations

Delete a runbook invocation


Delete an Online Diagnostic System Runbook invocation with the specified identifier.
DELETE /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Read a runbook invocation


Read an Online Diagnostic System Runbook invocation with the specified identifier.
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Create a runbook invocation


Create an Online Diagnostic System Runbook invocation. If an invocation with
already exists, throw an exception. Otherwise, create a new
runbook invocation.
A runbook invocation along with its report and status will be deleted automatically
after 2 hours, if it is not deleted by delete API.
POST /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}

Download the artifacts generated by an Online Diagnostic System Runbook invocation


Download the artifacts generated by an Online Diagnostic System Runbook invocation.
Please add the below header in the http request, if it is not present
"Accept: application/octet-stream"
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}/artifact

Read the report of a runbook invocation


Read the report of an Online Diagnostic System Runbook invocation.
GET /policy/api/v1/infra/sha/runbook-invocations/{invocation-id}/report

List runbook settings


Get a paginated list of Online Diagnostic System Runbook setting entities.
GET /policy/api/v1/infra/sha/runbook-settings

Delete a runbook setting


Delete an Online Diagnostic System Runbook setting with the specified identifier.
DELETE /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Read a runbook setting


Read an Online Diagnostic System Runbook setting with the specified identifier.
GET /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Create or update a runbook setting


Create an Online Diagnostic System Runbook setting with the specified identifier
if not existed, update an existing Online Diagnostic System runbook profile otherwise.
PATCH /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Create a runbook setting


Create an Online Diagnostic System Runbook setting with the specified identifier
PUT /policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}

Get all the container cluster status


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster-ncpstatus

Create container cluster status


POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster-ncpstatus

Delete container cluster status


DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster/{cluster-id}/ncpstatus

Get the container cluster status by given id


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster/{cluster-id}/ncpstatus

Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes-aggstatus

Read status of all the transport nodes


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes-status

Get the container hyperbus status on given node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/hyperbus-status

List LLDP Neighbor Properties of given Node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/lldp/interfaces

Read LLDP Neighbor Properties of transport node by Interface Name


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/lldp/interfaces/{interface-name}

Get the container status on given node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/node-agent-status

Get high-level summary of a transport node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/pnic-bond-status

Read status of all transport nodes with tunnel connections to transport node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/remote-transport-node-status

Read status of a transport node


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/status

List of tunnels


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/tunnels

Tunnel properties


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/tunnels/{tunnel-name}

Creates a status report of transport nodes of all the transport zones


You must provide the request header "Accept:application/octet-stream" when calling this API.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-node-status-report

Creates a status json report of transport nodes of all the transport zones


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-node-status-report-json

Get high-level summary of all transport zone status. The service layer does not support source = realtime or cached.


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones-aggstatus

Get high-level summary of a transport zone


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/status

Read status of transport nodes in a transport zone


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status

Creates a status report of transport nodes in a transport zone


You must provide the request header "Accept:application/octet-stream" when calling this API.
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status-report

Creates a status json report of transport nodes in a transport zone


GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status-report-json

List TraceflowConfig for infra


Paginated list of all TraceflowConfig for infra.
GET /policy/api/v1/infra/traceflows
GET /policy/api/v1/global-infra/traceflows
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows

Delete traceflow config


Delete traceflow config with id traceflow-id
DELETE /policy/api/v1/infra/traceflows/{traceflow-id}
DELETE /policy/api/v1/global-infra/traceflows/{traceflow-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id}

Read traceflow config


Read traceflow config with id traceflow-id. This configuration
will be cleaned up by the system after two hours of inactivity.
GET /policy/api/v1/infra/traceflows/{traceflow-id}
GET /policy/api/v1/global-infra/traceflows/{traceflow-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id}

Create or update a traceflow config


If a traceflow config with the traceflow-id is not
already present, create a new traceflow config. If it already exists,
update the traceflow config. This is a full replace. This configuration
will be cleaned up by the system after two hours of inactivity.
To start traceflow on a DHCP port in a custom project, enforcement point path is required.
PATCH /policy/api/v1/infra/traceflows/{traceflow-id} (Deprecated)
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id} (Deprecated)

Restart traceflow with same set of parameters used during create/update traceflow


This will retrace even if current traceflow has observations. Current
observations will be lost. Traceflow configuration will be cleaned up
by the system after two hours of inactivity.
POST /policy/api/v1/infra/traceflows/{traceflow-id} (Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id} (Deprecated)

Create or update a traceflow config


If a traceflow config with the traceflow-id is not
already present, create a new traceflow config. If it already exists,
update the traceflow config. This is a full replace. This
configuration will be cleaned up by the system after two hours of inactivity.
To start traceflow on a DHCP port in a custom project, enforcement point path is required.
User needs to update the in-band network telemetry (INT) configuration to specify the DSCP
bit/value for traceflow crafted packet, if the source port of traceflow is on VLAN logical network.
The INT configuration is under global operations configuration so please refer NSX-T API document
Policy > Networking > Networking Profiles > Global Gateway Configuration to check how to set the
DSCP bit/value via global operations configuration related API.
PUT /policy/api/v1/infra/traceflows/{traceflow-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id}

Read traceflow observations


Read traceflow observations for id traceflow-id. Traceflow configuration will be cleaned up by the system after two hours of inactivity. Enforcement Path is optional parameter.
GET /policy/api/v1/infra/traceflows/{traceflow-id}/observations
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id}/observations

Read traceflow status


Read traceflow status with id traceflow-id.
Traceflow configuration will be cleaned up by the system after
two hours of inactivity. Enforcement Path is optional parameter.
GET /policy/api/v1/infra/traceflows/{traceflow-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/traceflows/{traceflow-id}/status