NSX-T Data Center REST API

Associated URIs:

API Description	API Path
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
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