System Administration > Configuration > Directory Service > LDAP Servers

Associated URIs:

API Description API Path

List all configured domain LDAP servers


GET /api/v1/directory/domains/<domain-id>/ldap-servers

Create a LDAP server for directory domain


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.
POST /api/v1/directory/domains/<domain-id>/ldap-servers

Delete a LDAP server for directory domain


DELETE /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id>

Get a specific LDAP server for a given directory domain


GET /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id>

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 /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id>

Update a LDAP server for directory domain


PUT /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id>

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 /api/v1/directory/ldap-server