Get information about a specific service

GET

/system/dashboard/services/{unit}

curl --request GET \
  --url https://example.com/api/v1/system/dashboard/services/example \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

unit

required

string

Name of the unit to signal

Responses

200

Information about service returned

Media typeapplication/json

object

state

string

substate

string

description

string

nullable

autostart

State of the unit file

string

since

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

name

Name of the service

string

unit

Name of the systemd unit. Required for action endpoints.

string

Example^generated

{
  "state": "example",
  "substate": "example",
  "description": "example",
  "autostart": "example",
  "since": "example",
  "name": "example",
  "unit": "example"
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}