Index

get /trail-index/api/v1/index/{connection_id}/status

Get indexing status of the connection

connection_id

string

uuid

required

Response

ExamplesSchema

Connection successfully found

{
  "connection_id": "string",
  "status": "SCHEDULED"
}

post /trail-index/api/v1/index/status

Gets the statuses of the specified connections

array[string]

List of connection Ids

Content Type: application/json

Request

[
  "string"
]

Response

ExamplesSchema

Successful request

[
  {
    "connection_id": "string",
    "status": "SCHEDULED"
  }
]

post /trail-index/api/v1/index/start

Starts indexing of the specified connections

array[string]

List of connection Ids

Content Type: application/json

Request

[
  "string"
]

Response

ExamplesSchema

Successful request

[
  {
    "connection_id": "string",
    "status": "SCHEDULED"
  }
]

post /trail-index/api/v1/index/search

Search for the content based on the search parameters defined

keywords

string

Comma or space-separated strings to search across all connection attributes. The leading and trailing wildcards for the keywords are implicit.

protocol

string

Enum: SSH
RDP

connection_id

string

defines the connection id to be searched for

channel_id

string

defines the channel id to be searched for

start_time

string

date-time

defines the start time for search - abosulte timestamp in the connection

Example: "2017-01-01T15:05:05Z"

end_time

string

date-time

defines the end time for search - absolute timestamp in the connection

Example: "2017-01-01T15:05:05Z"

start_position

int

specifies the start position to search for in milliseconds - relative to the start of connection

Example: 10

end_position

int

specifies the end position to search for in milliseconds - relative to the start of connection

Example: 100

Request

{
  "keywords": "string",
  "protocol": "SSH",
  "connection_id": "string",
  "channel_id": "string",
  "start_time": "2017-01-01T15:05:05Z",
  "end_time": "2017-01-01T15:05:05Z",
  "start_position": 10,
  "end_position": 100
}

Response

ExamplesSchema

Successful request, respond with a list of connections

{
  "count": 123,
  "items": [
    {
      "connnection_id": "string",
      "channel_id": "string",
      "protocol": "SSH",
      "timestamp": "2017-01-01T15:05:05Z",
      "position": 123,
      "content": "ls -ltr"
    }
  ]
}