Monitor Service

instance

Download Spec

get/monitor-service/api/v1/instance/status

Get instance status

Status of the whole instance.

Responses

Response examples

Get the status of PrivX instance OK

[
  {
    "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"
        }
      ]
    }
  }
]

post/monitor-service/api/v1/instance/exit

Terminate instance

Terminate PrivX instances.

OAuth2 oauth

Required Scopes:

adminsettingsManage

Terminate PrivX instances.

All Scopes

admin · Admin scope - used for built-in PrivX admin account
logsView · Admin with "logs-view" permissions
service · Microservice scope - used for communication between PrivX microservices
settingsManage · User with "settings-manage" permission
user · Normal user

Flow Type:: authorization_code

Auth URL:: https://api.example.com/auth/api/v1/oauth/authorize

Token URL:: https://api.example.com/auth/api/v1/oauth/token

Responses

Response examples

Terminated PrivX instances

{}

Was this page helpful?