Check information about the specified service

  • Published on Jul 22, 2025
  • 1 minute(s) read
Prev Next
Get
/sys/v1/services/{name}

Returns the information regarding the status of the specified service.

Path parameters
name
stringRequired
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
2XX

Success result

Expand All
object
name
string
hostnames
object
property*
object additionalProperties
health_status
string
Valid values[ "Healthy", "Unhealthy" ]
last_health_check
object
initiated_at
string

The time the health check was initiated.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
finished_at
string

The time the health check finished (regardless of its outcome).

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
result
string

The result of the health check.