REST API  14
REST API for Luna Network HSMs
GET /api/lunasa/services/{serviceid}

GET /api/lunasa/services/{serviceid}

Gets specific information about the service.

User Privileges

Users with the following role privileges can perform this command:

  • admin
  • operator
  • monitor

Parameters

serviceid

The identifier of the service of interest. Valid Values: cbs, lsta, network, ntls, ntp, syslog, snmp, ssh, stc, sysstat, webserver, cluster, ismigration, ctc, clusteradmin.

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 12
   pattern: '^[a-z]*$'

Responses

200

The information about the service.

JSON Schema: Service

400

APPLIANCE_FAILED_TO_GET_SERVICE_INFO

Unexpected error

404

APPLIANCE_SERVICE_DOES_NOT_EXIST

Service does not exist

Example Request

   GET
   https://1.2.3.4:8443/api/lunasa/services/stc

Example Result

{
    "actions": "/api/lunasa/services/stc/actions",
    "onBoot": true,
    "status": "running"
}

Notes

For 'ctc' and 'network' services, if any of the network interface is active, the status will be shown as running and if all the interfaces are down or not configured, it will be shown as stopped.