NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
Test a directory domain event log server connectivity This API tests a event log server connectivity before the actual domain or event log server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 200 and a corresponding error message will be returned. Note - Query param 'enforcement_point_path' would be honoured only in case of Global manager.	POST /global-manager/api/v1/global-infra/firewall-identity-store-event-log-servers/status
Test a directory domain LDAP server connectivity This API tests a LDAP server connectivity before the actual domain or LDAP server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.	POST /global-manager/api/v1/global-infra/firewall-identity-store-ldap-server
Fetch all organization units for a LDAP server.	POST /global-manager/api/v1/global-infra/firewall-identity-stores-org-units
Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.	POST /global-manager/api/v1/global-infra/firewall-identity-stores/{firewall-identity-store-id} (Deprecated)
Test a LDAP server connection for directory domain The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.	POST /global-manager/api/v1/global-infra/firewall-identity-stores/{firewall-identity-store-id}/ldap-servers/{ldap-server-id} (Deprecated)
Fetch all organization units for a Firewall Identity Store.	GET /global-manager/api/v1/global-infra/firewall-identity-stores/{firewall-identity-store-id}/org-units
Get Firewall identity store sync statistics for the given identifier	GET /global-manager/api/v1/global-infra/firewall-identity-stores/{firewall-identity-store-id}/sync-stats
List all firewall identity stores List all firewall identity stores	GET /global-manager/api/v1/global-infra/identity-firewall-stores
Delete firewall identity store If the firewall identity store is removed, it will stop the identity store synchronization. User will not be able to define new IDFW rules	DELETE /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}
Read firewall identity store Return a firewall identity store based on the store identifier	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}
Create or update a firewall identity store If a firewall identity store with the firewall-identity-store-id is not already present, create a new firewall identity store. If it already exists, update the firewall identity store with specified attributes.	PATCH /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}
Create or update a firewall identity store If a firewall identity store with the firewall-identity-store-id is not already present, create a new firewall identity store. If it already exists, replace the firewall identity store instance with the new object.	PUT /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}
Delete a Event Log server for Firewall Identity store	DELETE /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/event-log-servers/{event-log-server-id}
Get a specific Event Log server for a given Firewall Identity store	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/event-log-servers/{event-log-server-id}
Create a Event Log server for Firewall Identity store More than one Event Log server can be created and only one event log server is used to synchronize directory objects. If more than one Event Log server is configured, NSX will try all the servers until it is able to successfully connect to one.	PATCH /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/event-log-servers/{event-log-server-id}
Update a event log server for Firewall Identity store	PUT /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/event-log-servers/{event-log-server-id}
List all configured domain LDAP servers	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers
Delete a LDAP server for Firewall Identity store	DELETE /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers/{ldap-server-id}
Get a specific LDAP server for a given Firewall Identity store	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers/{ldap-server-id}
Create a LDAP server for Firewall Identity store More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.	PATCH /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers/{ldap-server-id}
Update a LDAP server for Firewall Identity store	PUT /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/ldap-servers/{ldap-server-id}
List All site to ELS server mapping for given identity firewall store Paginated list of ELS servers associated with an identity store for a site.	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-els-server-mappings
Delete Identity firewall store to ELS server mapping. Delete ELS servers associated with an identity store for a site.	DELETE /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-els-server-mappings/{site-mapping-id}
Get Identity firewall store to ELS server mapping. Get ELS servers associated with an identity store for a site.	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-els-server-mappings/{site-mapping-id}
Patch Identity firewall store to ELS server mapping. Patch ELS servers associated with an identity store for a site.	PATCH /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-els-server-mappings/{site-mapping-id}
Create or update Identity firewall store to ELS server mapping. Create or update ELS servers associated with an identity store for a site.	PUT /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-els-server-mappings/{site-mapping-id}
List all site to LDAP server mapping for given identity firewall store Paginated list of LDAP servers associated with an identity store for a site.	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-ldap-server-mappings
Delete Identity firewall store to LDAP server mapping. Delete LDAP servers associated with an identity store for a site.	DELETE /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-ldap-server-mappings/{site-mapping-id}
Get Identity firewall store to LDAP server mapping. Get ordered list of LDAP servers associated with an identity store for a site.	GET /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-ldap-server-mappings/{site-mapping-id}
Patch Identity firewall store to LDAP server mapping. Patch ordered list of LDAP servers associated with an identity store for a site.	PATCH /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-ldap-server-mappings/{site-mapping-id}
Create or Update Identity firewall store to LDAP server mapping. Create or update ordered list of LDAP servers associated with an identity store for a site.	PUT /global-manager/api/v1/global-infra/identity-firewall-stores/{identity-firewall-store-id}/site-to-ldap-server-mappings/{site-mapping-id}
Initiate Delta Sync on Identity Firewall Store. Initiates a delta synchronization on the Identity Firewall Store. The objects that have changed since the last sync will be retrieved from the AD server and synchronized with NSX.	POST /global-manager/api/v1/global-infra/identity-firewall-stores/action/delta-sync
Initiate Full Sync on Identity Firewall Store. Initiates a full synchronization on the Identity Firewall Store. All the objects will be retrieved from the AD server and synchronized with NSX.	POST /global-manager/api/v1/global-infra/identity-firewall-stores/action/full-sync
Initiate Stop Sync on Identity Firewall Store. Stops the synchronization process on the Identity Firewall Store.	POST /global-manager/api/v1/global-infra/identity-firewall-stores/action/stop-sync
Test LDAP Server connectivity for an Identity Firewall Store. Tests the LDAP server connectivity for an existing Identity Firewall Store.	POST /global-manager/api/v1/global-infra/identity-firewall-stores/ldap-servers/action/connectivity-check
Get global identity firewall configuration applied to the sites Get global identity firewall configuration applied to the sites	GET /global-manager/api/v1/global-infra/settings/firewall/idfw/global-config-setting
Update global identity firewall configuration settings applied to the sites. This API is used to create or update global identity firewall configuration settings applied to the sites. This API is not available on the UI.	PATCH /global-manager/api/v1/global-infra/settings/firewall/idfw/global-config-setting
Create or Update global identity firewall configuration settings applied to the sites. This API is used to create or update global identity firewall configuration settings applied to the sites. This API is not available on the UI.	PUT /global-manager/api/v1/global-infra/settings/firewall/idfw/global-config-setting
Get all IDFW Group VM details for a given Group Get all Identity Firewall Group VM details for a given Group.	GET /global-manager/api/v1/global-infra/settings/firewall/idfw/group-vm-details
Get IDFW system statistics data It will get IDFW system statistics data.	GET /global-manager/api/v1/global-infra/settings/firewall/idfw/system-stats
Get user session data It will get user session data.	GET /global-manager/api/v1/global-infra/settings/firewall/idfw/user-session-data
Get IDFW user login events for a given VM It will get IDFW user login events for a given VM (all active plus up to 5 most recent archived entries).	GET /global-manager/api/v1/global-infra/settings/firewall/idfw/vm-stats/{vm-id}