System

Get a service configuration and state

Changed on
get/system/services/{servicename}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /system/services/{servicename}
  • Auth: none declared

Path parameters

servicenamestring required

Response

Service Info

hostidstring

The unique id of the host on which the service is executing

servicenamestring

Registered service name

base_urlstring

The url to reach the service, including port as needed

status_messagestring

A state indicating the condition of the service. Normal operation is 'registered'

statusboolean
versionstring

The version of the service as reported by the service implementation on registration

Example response

[
  {
    "status_message": "status_message",
    "base_url": "base_url",
    "hostid": "hostid",
    "servicename": "servicename",
    "service_detail": {
      "db_version": "db_version",
      "busy": true,
      "available": true,
      "up": true,
      "detail": "{}",
      "message": "message",
      "version": "version"
    },
    "version": "version",
    "status": true
  }
]

Changes