instance

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

Status of the whole instance.

Response

ExamplesSchema

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",
          "details": [
            null
          ]
        }
      ]
    }
  }
]

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

Terminate PrivX instances.

OAuth2 oauth

Required Scopes:

adminsettings-manage

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
settings-manage · Client with settings-manage permission
user · Normal users

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Response

ExamplesSchema

Terminated PrivX instances

{}