License

get /license-manager/api/v1/license

Gets PrivX license

Authorization

string

required

OAuth2 token

Default: "Bearer a-proper-token-goes-here"

Response

ExamplesSchema

Successful response, returns the license in JSON format

{
  "analytics_enabled": true,
  "audit_hosts_in_use": 123,
  "creation_date": "2019-06-09T16:33:21.602Z",
  "customer": "string",
  "expiry_date": "2020-06-04T16:33:21.512Z",
  "features": [
    "string"
  ],
  "hosts_in_use": 123,
  "isoffline": true,
  "last_refreshed_date": "2019-04-21T05:09:06.504Z",
  "license_code": "string",
  "license_message": "string",
  "license_status": "VALID",
  "max_audited_hosts": 123,
  "max_concurrent_https_conns": 123,
  "max_concurrent_rdp_conns": 123,
  "max_concurrent_ssh_conns": 123,
  "max_concurrent_vnc_conns": 123,
  "max_hosts": 123,
  "max_users": 123,
  "message": 123,
  "product": "PrivX",
  "serial_number": "555668327246377398",
  "status": 123,
  "type": 123,
  "users_in_use": 123
}

post /license-manager/api/v1/license

Post a new license to server

string

Response

ExamplesSchema

License received and activated

{
  "analytics_enabled": true,
  "audit_hosts_in_use": 123,
  "creation_date": "2019-06-09T16:33:21.602Z",
  "customer": "string",
  "expiry_date": "2020-06-04T16:33:21.512Z",
  "features": [
    "string"
  ],
  "hosts_in_use": 123,
  "isoffline": true,
  "last_refreshed_date": "2019-04-21T05:09:06.504Z",
  "license_code": "string",
  "license_message": "string",
  "license_status": "VALID",
  "max_audited_hosts": 123,
  "max_concurrent_https_conns": 123,
  "max_concurrent_rdp_conns": 123,
  "max_concurrent_ssh_conns": 123,
  "max_concurrent_vnc_conns": 123,
  "max_hosts": 123,
  "max_users": 123,
  "message": 123,
  "product": "PrivX",
  "serial_number": "555668327246377398",
  "status": 123,
  "type": 123,
  "users_in_use": 123
}

post /license-manager/api/v1/license/refresh

Refresh the license info.

OAuth2 oauth

Required Scopes:

adminservicelicensesManage

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
licensesManage · Clients with license manage scope
service · Microservice scope - used for communication between SSH PrivX microservices
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

License refreshed and activated

{
  "analytics_enabled": true,
  "audit_hosts_in_use": 123,
  "creation_date": "2019-06-09T16:33:21.602Z",
  "customer": "string",
  "expiry_date": "2020-06-04T16:33:21.512Z",
  "features": [
    "string"
  ],
  "hosts_in_use": 123,
  "isoffline": true,
  "last_refreshed_date": "2019-04-21T05:09:06.504Z",
  "license_code": "string",
  "license_message": "string",
  "license_status": "VALID",
  "max_audited_hosts": 123,
  "max_concurrent_https_conns": 123,
  "max_concurrent_rdp_conns": 123,
  "max_concurrent_ssh_conns": 123,
  "max_concurrent_vnc_conns": 123,
  "max_hosts": 123,
  "max_users": 123,
  "message": 123,
  "product": "PrivX",
  "serial_number": "555668327246377398",
  "status": 123,
  "type": 123,
  "users_in_use": 123
}

post /license-manager/api/v1/license/optin

Settings for SSH license statistics.

optin

boolean

Response

ExamplesSchema

Settings saved

Empty response

post /license-manager/api/v1/license/deactivate

Deactivate license.

OAuth2 oauth

Required Scopes:

adminservicelicensesManage

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
licensesManage · Clients with license manage scope
service · Microservice scope - used for communication between SSH PrivX microservices
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

License deactivated.

Empty response

get /license-manager/api/v1/license.js

Get PrivX license javascript snippet

Response

ExamplesSchema

Successful response, returns the license javascript

"string"