Veeam Backup & Replication 13
REST API Reference
Related documents

Active Directory Domains

The Active Directory Domains section defines paths and operations for managing Active Directory domains.

Get Active Directory Domains

The HTTP GET request to the /api/v1/adDomains path allows you to get an array of Active Directory domains that are added to the backup server.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of Active Directory domains to skip.

limit
integer <int32>
Default: 200

Maximum number of Active Directory domains to return.

orderColumn
string (EADDomainFiltersOrderColumn)

Sorts Active Directory domains by one of the parameters.

Value: "Name"
orderAsc
boolean

Sorts Active Directory domains in the ascending order by the orderColumn parameter.

nameFilter
string

Filters Active Directory domains by the nameFilter pattern. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.

header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/adDomains
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Active Directory Domain
The HTTP POST request to the /api/v1/adDomains path allows you to add an Active Directory domain to the backup server. 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
serverName
required
string
DNS name or IP address of Active Directory server.


 
credentialsId
required
string <uuid> 
Credentials ID.


 
port
integer <int32> 
Used port.


 
Responses 
201
The Active Directory domain has been added to the backup server.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/adDomains
Request samples 
application/json
{
  • "serverName": "tech.local",
  • "port": 389,
  • "credentialsId": "2b36ca59-3a3f-48f7-b50a-029705c39f05"
}
Response samples 
application/json
{
  • "id": "90f6d1b9-5ce0-4a09-906a-dea8ef4ed140",
  • "name": "tech.local",
  • "serverName": "tech.local",
  • "port": 389,
  • "credentialsId": "2b36ca59-3a3f-48f7-b50a-029705c39f05"
}
Get Active Directory Domain
The HTTP GET request to the /api/v1/adDomains/{id} path allows you to get Active Directory domain that has the specified id. 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Active Directory domain. To get the ID, run the Get Active Directory Domains request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/adDomains/{id}
Request samples 
Response samples 
application/json
{
  • "id": "90f6d1b9-5ce0-4a09-906a-dea8ef4ed140",
  • "name": "tech.local",
  • "serverName": "tech.local",
  • "port": 389,
  • "credentialsId": "2b36ca59-3a3f-48f7-b50a-029705c39f05"
}
Remove Active Directory Domain
The HTTP DELETE request to the /api/v1/adDomains/{id} path allows you to remove Active Directory domain that has the specified id from the backup server. 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Active Directory domain. To get the ID, run the Get Active Directory Domains request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
204
Active Directory domain has been removed.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


delete/api/v1/adDomains/{id}
Request samples 
Response samples 
application/json
{ }