System Administration > Configuration > Directory Service > LDAP Servers

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.

Request:

Method:
POST
URI Path(s):
/api/v1/directory/domains/<domain-id>/ldap-servers/<server-id>
Request Headers:
n/a
Query Parameters:
DirectoryLdapServerTestParameters+
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/directory/domains/756c3f9f-c03a-43fc-9414-400a1891a239/ldap-servers/01ad13c6-23c1-4175-ad3f-881eac8e45ef?action=CONNECTIVITY

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
n/a

Required Permissions:

crud

Feature:

directory_service

Additional Errors: