NSX-T Data Center REST API
Associated URIs:
| API Description | API Path |
|---|---|
List All alarms in the systemPaginated list of all alarms. |
GET /policy/api/v1/infra/realized-state/alarms
|
List Enforcement PointsPaginated list of all enforcement points. Returns the populated enforcement points. |
GET /policy/api/v1/infra/realized-state/enforcement-points
(Experimental)
|
Read Enforcement PointRead a Enforcement Point and the complete tree underneath. Returns the populated enforcement point object. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}
(Experimental)
|
List Firewall SectionsPaginated list of all Firewalls. Returns populated Firewalls. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/firewalls/firewall-sections
(Experimental)
(Deprecated)
|
Read FirewallRead a Firewall and the complete tree underneath. Returns the populated Firewall object. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/firewalls/firewall-sections/{firewall-section-id}
(Experimental)
(Deprecated)
|
List NS GroupsPaginated list of all NSGroups. Returns populated NSGroups. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/nsgroups
(Experimental)
(Deprecated)
|
Read GroupRead a NSGroup and the complete tree underneath. Returns the populated NSgroup object. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/nsgroups/{nsgroup-name}
(Experimental)
(Deprecated)
|
List Security GroupsPaginated list of all Security Groups. Returns populated Security Groups. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/securitygroups
(Experimental)
(Deprecated)
|
Read GroupRead a Security Group and the complete tree underneath. Returns the populated Security Group object. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/groups/securitygroups/{securitygroup-name}
(Experimental)
(Deprecated)
|
List IPSetsPaginated list of all Realized IPSets |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/ip-sets/ip-sets-nsxt
(Experimental)
(Deprecated)
|
Read IPSet Realized stateRead an IPSet |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/ip-sets/ip-sets-nsxt/{ip-set-name}
(Experimental)
(Deprecated)
|
List MACSetsPaginated list of all Realized MACSets |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/mac-sets/mac-sets-nsxt
(Experimental)
(Deprecated)
|
Read MACSet Realized stateRead an MACSet |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/mac-sets/mac-sets-nsxt/{mac-set-name}
(Experimental)
(Deprecated)
|
List Realized NSServicesPaginated list of all Realized NSService. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/services/nsservices
(Experimental)
(Deprecated)
|
Read NSServiceRead a NSService. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/services/nsservices/{nsservice-name}
(Experimental)
(Deprecated)
|
Listing of VIFs on the NSX ManagerThis API lists VIFs from the specified NSX Manager. |
GET /policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/vifs
|
Get list of realized objects associated with intent objectGet list of realized entities associated with intent object, specified by path in query parameter |
GET /policy/api/v1/infra/realized-state/realized-entities
GET /policy/api/v1/global-infra/realized-state/realized-entities GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/realized-state/realized-entities |
Get realized entity uniquely identified by realized pathGet realized entity uniquely identified by realized path, specified by query parameter |
GET /policy/api/v1/infra/realized-state/realized-entity
|
Refresh all realized entities associated with the intent-pathRefresh the status and statistics of all realized entities associated with given intent path synchronously. The vmw-async: True HTTP header cannot be used with this API. |
POST /policy/api/v1/infra/realized-state/realized-entity?action=refresh
POST /policy/api/v1/global-infra/realized-state/realized-entity?action=refresh POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/realized-state/realized-entity?action=refresh |
Get consolidated status of an intent objectGet Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - <intent_path>: the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - <intent_path, include_enforced_status>: the request is evaluated on all enforcement points for the given intent with enforcement point specific details. |
GET /policy/api/v1/infra/realized-state/status
GET /policy/api/v1/global-infra/realized-state/status GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/realized-state/status |