/mgmt/status/default/ServicesStatus GET

Use the HTTP GET method with the /mgmt/status/default/ServicesStatus resource to view information about active services on the appliance.

Resource URL

https://host:port/mgmt/status/default/ServicesStatus
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about active services on the appliance. Each object contains the following fields:
LocalIP
String.
The IP address being used by this service.
LocalPort
Integer.
The port being used by this service.
ServiceClass
String.
Type of service.
ServiceName
String.
Name of the service.

Examples

The following example requests information about active services on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/ServicesStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/ServicesStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/ServicesStatus"
    }
  },
  "ServicesStatus": [
    {
      "LocalIP": "0.0.0.0",
      "LocalPort": 5554,
      "ServiceClass": "MultiProtocolGateway",
      "ServiceName": "rest-mgmt"
    },
    {
      "LocalIP": "0.0.0.0",
      "LocalPort": 9090,
      "ServiceClass": "WebGUI",
      "ServiceName": "web-mgmt"
    }
  ]
}