Monitor Service

auditevents

Download Spec

post/monitor-service/api/v1/auditevents/search

Search for audit events

keywordsstring

Example: "privx,service"

user_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

connection_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

host_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

source_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

session_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

access_group_idstring

Example: "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93"

start_timestring

Format: date-time
Example: "2017-01-01T15:05:05Z"

end_timestring

Format: date-time
Example: "2017-01-01T15:05:05Z"

Responses

Request examples

{
  "keywords": "privx,service",
  "user_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "connection_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "host_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "source_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "session_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "access_group_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
  "start_time": "2017-01-01T15:05:05Z",
  "end_time": "2017-01-01T15:05:05Z"
}

Response examples

Successful request, respond with a list of event details

{
  "count": 123,
  "items": [
    {
      "service_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
      "service_name": "MONITOR-SERVICE",
      "event_id": "123",
      "event_name": "Service-starting",
      "message": {},
      "created": "string"
    }
  ]
}

get/monitor-service/api/v1/auditevents

Get all audit events

offsetint

Offset from which to start fetching objects

Default: 0

limitint

Maximum number of objects to return

Default: 50
Max: 1000

sortkeystring

Sort by specific object property

Default: "created"
Enum: created

sortdirstring

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

fuzzycountboolean

If keyword is present the queries will return a fuzzy total count instead of exact total count

Responses

Response examples

Successful request, respond with a list of event details

{
  "count": 123,
  "items": [
    {
      "service_id": "21ca9e5d-617c-4c9b-8a1c-8a49d9998f93",
      "service_name": "MONITOR-SERVICE",
      "event_id": "123",
      "event_name": "Service-starting",
      "message": {},
      "created": "string"
    }
  ]
}

get/monitor-service/api/v1/auditevents/codes

Get audit event codes.

Authorizationstring

required

OAuth2 token

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

Responses

Response examples

Successful request, respond with event codes

{
  "key": 123,
  "value": {
    "event_id": "string",
    "event_name": "string",
    "event_desc": "string"
  }
}

Was this page helpful?