[{"label":"Latest (1.0.0)","version":"latest"}]
vrs-appliance-config-api

Get All Services

Description

Get information about all services.

Request

Request

URL

URL


get
https://{api_host}//services
Copy

Query Parameters

Query Parameters

array of string
filter Optional

The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2


string
filter_property Optional

The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1


string
limit Optional

Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property ‘defaultResponsePageSize’ in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.

limit example
"10"

string
offset Optional

The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10

offset example
"10"

string
order_by Optional

Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.


string
sort_by Optional

Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.

sort_by example
"name"

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ServiceInfoDrResponseList of type application/json

A list of all services this virtual appliance has configured.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		],
		"limit": 0,
		"links": {
			"next": {
				"href": "string"
			},
			"previous": {
				"href": "string"
			},
			"self": {
				"href": "string"
			}
		},
		"offset": 0,
		"total": 0
	},
	"list": [
		{
			"description": "string",
			"id": "ui-service",
			"is_running": false,
			"name": "ui-service",
			"startup_type": "AUTOMATIC"
		}
	]
}
_meta Optional

List metadata


array of ServiceInfo
list Optional

Detailed information about a service

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/services


[{"label":"Latest (1.0.0)","version":"latest"}]
vrs-appliance-config-api
Feedback

Was this page helpful?