NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List IPFIX Collector Profies Query IPFIX collector profiles with list parameters. List result can be filtered by profile type defined by IpfixCollectorUpmProfileType.	GET /api/v1/ipfix-collector-profiles (Deprecated)
Create a new IPFIX collector profile Create a new IPFIX collector profile with essential properties.	POST /api/v1/ipfix-collector-profiles (Deprecated)
Delete an existing IPFIX collector profile Delete an existing IPFIX collector profile by ID.	DELETE /api/v1/ipfix-collector-profiles/{ipfix-collector-profile-id} (Deprecated)
Get an existing IPFIX collector profile Get an existing IPFIX collector profile by profile ID.	GET /api/v1/ipfix-collector-profiles/{ipfix-collector-profile-id} (Deprecated)
Update an existing IPFIX collector profile Update an existing IPFIX collector profile with profile ID and modified properties.	PUT /api/v1/ipfix-collector-profiles/{ipfix-collector-profile-id} (Deprecated)
List IPFIX Profies Query IPFIX profiles with list parameters. List result can be filtered by profile type defined by IpfixUpmProfileType.	GET /api/v1/ipfix-profiles (Deprecated)
Create a new IPFIX profile Create a new IPFIX profile with essential properties.	POST /api/v1/ipfix-profiles (Deprecated)
Delete an existing IPFIX profile Delete an existing IPFIX profile by ID.	DELETE /api/v1/ipfix-profiles/{ipfix-profile-id} (Deprecated)
Get an existing IPFIX profile Get an existing IPFIX profile by profile ID.	GET /api/v1/ipfix-profiles/{ipfix-profile-id} (Deprecated)
Update an existing IPFIX profile Update an existing IPFIX profile with profile ID and modified properties.	PUT /api/v1/ipfix-profiles/{ipfix-profile-id} (Deprecated)
List IPFIX collector configurations	GET /api/v1/ipfix/collectorconfigs (Deprecated)
Create a new IPFIX collector configuration	POST /api/v1/ipfix/collectorconfigs (Deprecated)
Delete an existing IPFIX collector configuration	DELETE /api/v1/ipfix/collectorconfigs/{collector-config-id} (Deprecated)
Get an existing IPFIX collector configuration	GET /api/v1/ipfix/collectorconfigs/{collector-config-id} (Deprecated)
Update an existing IPFIX collector configuration	PUT /api/v1/ipfix/collectorconfigs/{collector-config-id} (Deprecated)
List IPFIX configuration	GET /api/v1/ipfix/configs (Deprecated)
Create a new IPFIX configuration	POST /api/v1/ipfix/configs (Deprecated)
Delete an existing IPFIX configuration	DELETE /api/v1/ipfix/configs/{config-id} (Deprecated)
Get an existing IPFIX configuration	GET /api/v1/ipfix/configs/{config-id} (Deprecated)
Update an existing IPFIX configuration	PUT /api/v1/ipfix/configs/{config-id} (Deprecated)
List all livetrace sessions	GET /api/v1/livetraces (Deprecated)
Create a livetrace session	POST /api/v1/livetraces (Deprecated)
Delete a livetrace session	DELETE /api/v1/livetraces/{livetrace-session-id} (Deprecated)
Get the status of a livetrace session	GET /api/v1/livetraces/{livetrace-session-id} (Deprecated)
Get forward packet capture file proxy 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 /api/v1/livetraces/{livetrace-session-id}/proxy/forward/capturefile (Deprecated)
Get reverse packet capture file proxy 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 /api/v1/livetraces/{livetrace-session-id}/proxy/reverse/capturefile (Deprecated)
Get the result of a livetrace session	GET /api/v1/livetraces/{livetrace-session-id}/results (Deprecated)
Get networking entities between two logical ports with VIF attachment	GET /api/v1/logical-ports/{lport-id}/forwarding-path (Deprecated)
List manual health checks Query manual health checks with list parameters.	GET /api/v1/manual-health-checks
Create a new manual health check request Create a new manual health check request with essential properties. It's disallowed to create new one until the count of in-progress manual health check is less than 50. A manual health check will be deleted automatically after finished for 24 hours.	POST /api/v1/manual-health-checks
Delete an existing manual health check Delete an existing manual health check by ID.	DELETE /api/v1/manual-health-checks/{manual-health-check-id}
Get an existing manual health check Get an existing manual health check by health check ID.	GET /api/v1/manual-health-checks/{manual-health-check-id}
List all mirror sessions	GET /api/v1/mirror-sessions (Deprecated)
Create a mirror session	POST /api/v1/mirror-sessions (Deprecated)
Delete the mirror session	DELETE /api/v1/mirror-sessions/{mirror-session-id} (Deprecated)
Get the mirror session	GET /api/v1/mirror-sessions/{mirror-session-id} (Deprecated)
Verify whether the mirror session is still valid Verify whether all participants are on the same transport node	POST /api/v1/mirror-sessions/{mirror-session-id}?action=verify (Deprecated)
Update the mirror session	PUT /api/v1/mirror-sessions/{mirror-session-id} (Deprecated)
Get the mirror stack status on given remote L3 mirror session	GET /api/v1/mirror-sessions/{mirror-session-id}/mirror-stack-status (Deprecated)
Create an new packet capture session Create an new packet capture session on given node with specified options	POST /api/v1/pktcap/session
Get the status of packet capture session Get the packet capture status information by session id.	GET /api/v1/pktcap/session/{session-id}
Restart the packet capture session Restart the packet capture session	POST /api/v1/pktcap/session/{session-id}?action=restart
Delete the packet capture session by session id. Before calling this method, terminate any running capture session.	POST /api/v1/pktcap/session/{session-id}?action=delete
Terminate the packet capture session by session id Terminate the packet capture session by session id.	POST /api/v1/pktcap/session/{session-id}?action=terminate
Get packet capture file 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 /api/v1/pktcap/session/{session-id}/capturefile
Get the information of all packet capture sessions Get the information of all packet capture sessions.	GET /api/v1/pktcap/sessions
Delete all the packet capture sessions Delete all the packet capture sessions.	POST /api/v1/pktcap/sessions?action=delete
List all Traceflow rounds List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.	GET /api/v1/traceflows (Deprecated)
Initiate a Traceflow Operation on the Specified Port	POST /api/v1/traceflows (Deprecated)
Delete the Traceflow round	DELETE /api/v1/traceflows/{traceflow-id} (Deprecated)
Get the Traceflow round status and result summary	GET /api/v1/traceflows/{traceflow-id} (Deprecated)
Get observations for the Traceflow round	GET /api/v1/traceflows/{traceflow-id}/observations (Deprecated)