• Monitor Service

components

get/monitor-service/api/v1/components

List component status

Get all the deployed privx components status

Responses

Response examples

Get all components status OK

{
  "instance_name_1": [
    {
      "component_name": "string",
      "component_type": "MICROSERVICE",
      "hostname": "localhost",
      "status_uri": "/monitor-service/api/v1/status",
      "created": "2017-01-01T15:05:05Z",
      "status": {
        "error_code": "GENERAL_ERROR",
        "error_message": "string",
        "property": "string",
        "details": [
          {
            "error_code": "GENERAL_ERROR",
            "error_message": "string",
            "property": "string"
          }
        ]
      }
    }
  ],
  "instance_name_2": [
    {
      "component_name": "string",
      "component_type": "MICROSERVICE",
      "hostname": "localhost",
      "status_uri": "/monitor-service/api/v1/status",
      "created": "2017-01-01T15:05:05Z",
      "status": {
        "error_code": "GENERAL_ERROR",
        "error_message": "string",
        "property": "string",
        "details": [
          {
            "error_code": "GENERAL_ERROR",
            "error_message": "string",
            "property": "string"
          }
        ]
      }
    }
  ]
}
get/monitor-service/api/v1/components/{hostname}

Get component status for hostname

Get component status object by hostname.

hostnamestring

required

Hostname

Responses

Response examples

Successful response, returns a component if found

{
  "privx1": [
    {
      "component_name": "string",
      "component_type": "MICROSERVICE",
      "hostname": "localhost",
      "status_uri": "/monitor-service/api/v1/status",
      "created": "2017-01-01T15:05:05Z",
      "status": {
        "error_code": "GENERAL_ERROR",
        "error_message": "string",
        "property": "string",
        "details": [
          {
            "error_code": "GENERAL_ERROR",
            "error_message": "string",
            "property": "string"
          }
        ]
      }
    }
  ]
}

Was this page helpful?