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 disable 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.	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.	PUT /policy/api/v1/infra/capacity/threshold
Returns capacity usage data for NSX objects	GET /policy/api/v1/infra/capacity/usage
List IPFIX Collector profiles. API will provide list of all IPFIX dfw collector profiles and their details.	GET /policy/api/v1/global-infra/ipfix-dfw-collector-profiles 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> DELETE /policy/api/v1/global-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> GET /policy/api/v1/global-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> PATCH /policy/api/v1/global-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> PUT /policy/api/v1/global-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 GET /policy/api/v1/global-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> DELETE /policy/api/v1/global-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> GET /policy/api/v1/global-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> PATCH /policy/api/v1/global-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> PUT /policy/api/v1/global-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 GET /policy/api/v1/global-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/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id> 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/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id> 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/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id> 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/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id> 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 GET /policy/api/v1/global-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> DELETE /policy/api/v1/global-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> GET /policy/api/v1/global-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> PATCH /policy/api/v1/global-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> PUT /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
List latency profiles	GET /policy/api/v1/infra/latency-profiles
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>
Read livetrace result Read result for a livetrace config with the specified identifier.	GET /policy/api/v1/infra/livetraces/<livetrace-id>/result
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/global-infra/port-mirroring-profiles 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> DELETE /policy/api/v1/global-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> GET /policy/api/v1/global-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> PATCH /policy/api/v1/global-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> PUT /policy/api/v1/global-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 plugin list. 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
Read Sha dynamic plugin Read 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/global-infra/sha/dynamic-plugins/<plugin-id> GET /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>
Upload Sha dynamic plugin Upload Sha dynamic plugin content.	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>
API will provide list of SHA profile. API will provide list of SHA profile.	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/global-infra/sha/plugin-profiles/<sha-profile-id> GET /policy/api/v1/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 dynamic plugins.	GET /policy/api/v1/global-infra/sha/pre-defined-plugins GET /policy/api/v1/infra/sha/pre-defined-plugins
Read Sha pre-defined plugin Read SHA dynamic plugin.	GET /policy/api/v1/infra/sha/pre-defined-plugins/<plugin-id> GET /policy/api/v1/global-infra/sha/pre-defined-plugins/<plugin-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
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
List TraceflowConfig for infra Paginated list of all TraceflowConfig for infra.	GET /policy/api/v1/infra/traceflows
Delete traceflow config Delete traceflow config with id traceflow-id	DELETE /policy/api/v1/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>
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.	PATCH /policy/api/v1/infra/traceflows/<traceflow-id>
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>
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.	PUT /policy/api/v1/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.	GET /policy/api/v1/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.	GET /policy/api/v1/infra/traceflows/<traceflow-id>/status

Policy > Monitoring

Associated URIs:

Returns the compliance status

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

List AntreaTraceflowConfig for infra

Delete Antrea traceflow config

Read Antrea traceflow config

Create an Antrea traceflow config

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

Create an Antrea traceflow config

Read Antrea traceflow observations

Read Antrea traceflow status

Returns capacity usage data for NSX objects

Returns warning threshold(s) set for NSX Objects.

Updates the thresholds for specified NSX Objects.

Updates the warning threshold(s) for NSX Objects.

Returns capacity usage data for NSX objects

List IPFIX Collector profiles.

Delete IPFIX dfw Collector profile

Get IPFIX dfw Collector profile

IPFIX dfw collector profile id

Create or Replace IPFIX dfw collector profile

List IPFIX DFW Profile

Delete IPFIX DFW Profile

Get IPFIX DFW Profile

Patch IPFIX DFW profile

Create or Replace IPFIX DFW collection Config.

List IPFIX Collector profiles.

Delete IPFIX Collector profile

Get IPFIX Collector profile

Patch IPFIX collector profile

Create or Replace IPFIX collector profile

List IPFIX L2 Profiles

Delete IPFIX L2 Profile

Get IPFIX L2 Profile

Patch IPFIX L2profile

Create or Replace IPFIX L2 profile

List latency profiles

Delete an existing latency profile

Read latency profile

Patch latency profile

Create or Replace latency profile

List livetrace config entities

Delete a livetrace config

Read a livetrace config

Create or update a livetrace config

Restart a livetrace session

Create or update a livetrace config

Read livetrace result

Read livetrace status

List livetrace status entities

List Port Mirroring Profiles

Delete Port Mirroring Profile

Details of Port Mirroring Profile

Patch Port Mirroring Profile.

Create or Replace Port Mirroring Profile.

Get the details of latency status in given appliance.

Get the details of process status in given appliance.

Get the details of latency status for all appliances

Get the list of process status for all appliances.

API will provide list of Sha dynamic plugin list.

Read Sha dynamic plugin

Read Sha dynamic plugin

Upload Sha dynamic plugin

Create Sha dynamic plugin

Upload Sha dynamic plugin

API will provide list of SHA profile.

Delete SHA profile

API will return Sha profile

Create or Replace SHA profile

Create or Replace Sha profile

Show the plugins status on given node.

API will provide list of Sha pre-defined list.

Read Sha pre-defined plugin

Get all the container cluster status

Create container cluster status

Delete container cluster status

Get the container cluster status by given id

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

Read status of all the transport nodes