• Connection Manager

ueba management

get/connection-manager/api/v1/ueba/configure

Get Ueba configurations

Authorizationstring

required

OAuth2 token

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

Responses

Response examples

Configuration file for UEBA install script

{
  "address": "string",
  "trust_anchors": "string"
}
post/connection-manager/api/v1/ueba/configure

Set Ueba configurations

addressstring
trust_anchorsstring

trust anchors for privx to trust customer created ueba server cert

Responses

Request examples

{
  "address": "string",
  "trust_anchors": "string"
}

Response examples

Successfully set given Ueba configurations

Empty response

get/connection-manager/api/v1/ueba/anomaly-settings

Anomaly settings

Authorizationstring

required

OAuth2 token

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

Responses

Response examples

Returns anomaly settings

{
  "action": "BLOCK",
  "threshold": 123.0
}
post/connection-manager/api/v1/ueba/anomaly-settings

Anomaly settings

actionstring

required

Enum
  • BLOCK
  • AUDIT
thresholdnumber

required

float between 0.0-1.0. Loose - Strict

Responses

Request examples

{
  "action": "BLOCK",
  "threshold": 123.0
}

Response examples

Anomaly settings saved

Empty response

post/connection-manager/api/v1/ueba/start-analyzing/{dataset_id}

Start analyzing connections with a saved dataset. Fails if training not done, has not finished or failed.

dataset_idstring

required

dataset_id to run

Format
uuid

Responses

Response examples

successful response

Empty response

post/connection-manager/api/v1/ueba/stop-analyzing

Stop analyzing connection anomalies

Authorizationstring

required

OAuth2 token

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

Responses

Response examples

anomaly analysis stopped

Empty response

Was this page helpful?