Get a list of the server service statuses

Prev Next
Get
/v{version}/System/Services
Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Responses
200

OK

Array of object
object

Service information of a specific system

HostName
string

Host name of the service

LastHeartBeatDate
string (date-time)

Last heartbeat date of the service in UTC

Name
string

Name of the service

Path
string

Path to the service

ExampleC:\path\to\service.exe
StartupDate
string (date-time)

Startup date of the service in UTC

Status
string

Status of service

Valid values[ "Unknown", "Stopped", "Running" ]
StoppedDate
string (date-time)

Stopped date of the service in UTC

Type
string

Type of the service

Version
string

Version of the service

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Forbidden

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties