Services

The Services section defines a path and operation for retrieving information about associated backend services. You may need to connect to these services for integration with Veeam Backup & Replication.

Get Associated Services

The HTTP GET request to the /api/v1/services path allows you to get associated services for integration with Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

query Parameters

skip	integer <int32> Number of services to skip.
limit	integer <int32> Default: 200 Maximum number of services to return.
orderColumn	string (EServicesFiltersOrderColumn) Sorts services by one of the service parameters. Enum: "Name" "Port"
orderAsc	boolean If `true`, sorts services in the ascending order by the `orderColumn` parameter.
nameFilter	string Filters services by the `nameFilter` pattern. The pattern can match any service parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

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

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/services

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"name": "External Infrastructure DB Provider",
"port": 6172
},
{"name": "VM Backup API",
"port": 10006
}
],
"pagination": {"total": 2,
"count": 2,
"skip": 0,
"limit": 200
}
}