Get Active Directory Configuration
Gets AD configuration.
Note
In case NAKIVO Backup & Replication was installed in Multi-tenant mode, the use of API is possible only for the Master tenant.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example

curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header ""content-type: application/json"" \
--cookie @cookies.txt \
--data {
"action": "ADDomainManagement",
"method": "getADConfiguration",
"data": null,
"type": ""rpc"",
"tid": 1 }"
Request Fields
Field |
Type |
Value(s) |
---|---|---|
|
string |
|
|
string |
|
|
null |
|
|
string |
|
|
integer |
|
Response Sample

{
"action": "ADDomainManagement",
"method": "getADConfiguration",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": { "domainName": "adtestvn.local", "preferredDc": "10.30.30.1", "username": "administrator", "password": null, "integratedGroups": "users,domain users", "refreshInMinutes": 60, "changeExistingPreferredDc": true, "locked": false }
}
Data
Field |
Value |
Description |
---|---|---|
|
string |
AD domain |
|
string |
Preferred DC/Host (optional) |
|
string |
Username |
password
|
string | Password |
|
string |
List of integrated groups |
|
number |
number in minutes in which system will fetch data from AD |
changeExistingPreferredDc
|
boolean |
Allows deleting old data from old existing configuration. It is relevant only if you change value of 'preferred DC' but keep value in 'domain name'. |
locked
|
boolean | Checks if the item is locked by some task |