status
Download SpecResponse
Microservice status OK
{
"version": "string",
"api_version": "string",
"status": "RUNNING",
"status_message": "string",
"issues": [
{
"severity": "NOTICE",
"code": "string",
"message": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
],
"status_details": [
{
"k": "string",
"v": "string"
}
],
"app_id": "5bf77342-221c-11ee-be56-0242ac120002",
"start_time": "2023-06-07T17:32:28Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Microservice status is erroneous
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveversion
string
required
The version number of the microservice. Scheme major.minor.patch (build number).
api_version
string
Newest supported API version (v1, v2, ..)
status
string
- Enum
-
- RUNNING
- WARNING
- ERROR
- PENDING
status_message
string
Describes the pending or running state of the microservice.
issues
array[object]
A list of active issues, which can represent warnings, errors or informational notices.
object
Describes a persistent issue
severity
string
required
- Enum
-
- NOTICE
- WARNING
- ERROR
code
string
required
message
string
required
created
string
date-time
When the issue was first logged
updated
string
date-time
When the issue was previously logged
status_details
array[object]
A key-value list of relevant status values for the microservice, calls per second, last import etc.
object
A status key-value pair
k
string
The key
v
string
The value
app_id
string
uuid
Unique UUID for the microservice, generated at startup
start_time
string
date-time
The datetime when the status was issued
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
Get Ueba microservice status
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between 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
Microservice status OK
{
"version": "string",
"api_version": "string",
"status": "RUNNING",
"status_message": "string",
"issues": [
{
"severity": "NOTICE",
"code": "string",
"message": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
],
"status_details": [
{
"k": "string",
"v": "string"
}
],
"app_id": "5bf77342-221c-11ee-be56-0242ac120002",
"start_time": "2023-06-07T17:32:28Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveversion
string
required
The version number of the microservice. Scheme major.minor.patch (build number).
api_version
string
Newest supported API version (v1, v2, ..)
status
string
- Enum
-
- RUNNING
- WARNING
- ERROR
- PENDING
status_message
string
Describes the pending or running state of the microservice.
issues
array[object]
A list of active issues, which can represent warnings, errors or informational notices.
object
Describes a persistent issue
severity
string
required
- Enum
-
- NOTICE
- WARNING
- ERROR
code
string
required
message
string
required
created
string
date-time
When the issue was first logged
updated
string
date-time
When the issue was previously logged
status_details
array[object]
A key-value list of relevant status values for the microservice, calls per second, last import etc.
object
A status key-value pair
k
string
The key
v
string
The value
app_id
string
uuid
Unique UUID for the microservice, generated at startup
start_time
string
date-time
The datetime when the status was issued
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
Get Ueba microservice internal status
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between 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
Ueba microservice detailed status
{
"training_status": "MODELS_MISSING",
"inference_status": "RUNNING",
"dataset_id": "5bf77342-221c-11ee-be56-0242ac120002",
"model_instance_status": [
{
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"feature_config_name": "string",
"status": "RUNNING",
"created": "2023-06-07T17:32:28Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursivetraining_status
string
required
- Enum
-
- MODELS_MISSING
- MODELS_AVAILABLE
- TRAINING
- RETRAINING
inference_status
string
required
- Enum
-
- RUNNING
- STOPPING
- STOPPED
dataset_id
string
uuid
model_instance_status
array[object]
The state of the latest training result for each available feature config name
object
id
string
uuid
feature_config_name
string
status
string
- Enum
-
- RUNNING
- DOWN
created
string
date-time
when training entry in ueba server created
Was this page helpful?