connections

Download Spec

get /connection-manager/api/v1/connections

Get connections

offset

int

Offset from which to start fetching objects

Default
0

limit

int

Maximum number of objects to return

Default
50

sortkey

string

Sort by specific object property

Default
"id"

sortdir

string

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC

fuzzycount

boolean

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

Response

ExamplesSchema

Successful request, respond with a list of connections

{
  "count": 123,
  "items": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "type": "SSH",
      "authentication_method": [
        "CERT"
      ],
      "user_data": {
        "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "display_name": "user@domain.com"
      },
      "user_roles": [
        {
          "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
          "name": "example-admins"
        }
      ],
      "target_host_data": {
        "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "common_name": "linux-host"
      },
      "target_host_address": "123.123.123.123",
      "target_host_account": "dbuser",
      "target_host_roles": [
        {
          "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
          "name": "example-admins"
        }
      ],
      "remote_address": "123.123.123.123",
      "connected": "2017-01-01T15:05:05Z",
      "disconnected": "2017-01-01T15:05:05Z",
      "duration": "PT00:15:38",
      "status": "CONNECTED",
      "last_activity": "2017-01-01T15:05:05Z",
      "bytes_in": 123456,
      "bytes_out": 12345678,
      "force_disconnect": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "audit_enabled": true,
      "access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "trail": {
        "connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "protocol": "string",
        "channels": [
          {
            "id": "string",
            "type": "string",
            "bytes_client_to_server": 123,
            "bytes_server_to_client": 123,
            "protocol_file": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "offset": 123,
              "direction": 123,
              "open_time": "2023-06-07T17:32:28Z",
              "close_time": "2023-06-07T17:32:28Z",
              "payload_size": 123,
              "closed": true,
              "status": "OK"
            },
            "transferred_files": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string",
                "offset": 123,
                "direction": 123,
                "open_time": "2023-06-07T17:32:28Z",
                "close_time": "2023-06-07T17:32:28Z",
                "payload_size": 123,
                "closed": true,
                "status": "OK"
              }
            ]
          }
        ]
      },
      "index_status": "NOT_INDEXED",
      "access_roles": [
        {
          "added": "2023-06-07T17:32:28Z",
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

post /connection-manager/api/v1/connections/search

Search for connections.

keywords

string

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

id

array[string]

proxy_id

array[string]

type

array[string]

authentication_method

array[string]

user_id

array[string]

user_display_name

array[string]

user_roles

array[string]

The role ids.

target_host_id

array[string]

target_host_address

array[string]

target_host_account

array[string]

target_host_roles

array[string]

The role ids.

remote_address

array[string]

connected

object (connected)

disconnected

object (disconnected)

status

array[string]

last_activity

object (last_activity)

force_disconnect

string

access_roles

array[string]

tags

array[string]

has_access_roles

boolean

mode

array[string]

Request

{
  "keywords": "string",
  "id": [
    "string"
  ],
  "proxy_id": [
    "string"
  ],
  "type": [
    "SSH"
  ],
  "authentication_method": [
    "CERT"
  ],
  "user_id": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "user_display_name": [
    "string"
  ],
  "user_roles": [
    "string"
  ],
  "target_host_id": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "target_host_address": [
    "string"
  ],
  "target_host_account": [
    "string"
  ],
  "target_host_roles": [
    "string"
  ],
  "remote_address": [
    "string"
  ],
  "connected": {
    "start": "string",
    "end": "string"
  },
  "disconnected": {
    "start": "string",
    "end": "string"
  },
  "status": [
    "CONNECTED"
  ],
  "last_activity": {
    "start": "string",
    "end": "string"
  },
  "force_disconnect": "string",
  "access_roles": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "tags": [
    "string"
  ],
  "has_access_roles": true,
  "mode": [
    "MITM"
  ]
}

Response

ExamplesSchema

Successful request, respond with a list of connections

{
  "count": 123,
  "items": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "type": "SSH",
      "authentication_method": [
        "CERT"
      ],
      "user_data": {
        "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "display_name": "user@domain.com"
      },
      "user_roles": [
        {
          "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
          "name": "example-admins"
        }
      ],
      "target_host_data": {
        "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "common_name": "linux-host"
      },
      "target_host_address": "123.123.123.123",
      "target_host_account": "dbuser",
      "target_host_roles": [
        {
          "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
          "name": "example-admins"
        }
      ],
      "remote_address": "123.123.123.123",
      "connected": "2017-01-01T15:05:05Z",
      "disconnected": "2017-01-01T15:05:05Z",
      "duration": "PT00:15:38",
      "status": "CONNECTED",
      "last_activity": "2017-01-01T15:05:05Z",
      "bytes_in": 123456,
      "bytes_out": 12345678,
      "force_disconnect": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "audit_enabled": true,
      "access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "trail": {
        "connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "protocol": "string",
        "channels": [
          {
            "id": "string",
            "type": "string",
            "bytes_client_to_server": 123,
            "bytes_server_to_client": 123,
            "protocol_file": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "offset": 123,
              "direction": 123,
              "open_time": "2023-06-07T17:32:28Z",
              "close_time": "2023-06-07T17:32:28Z",
              "payload_size": 123,
              "closed": true,
              "status": "OK"
            },
            "transferred_files": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string",
                "offset": 123,
                "direction": 123,
                "open_time": "2023-06-07T17:32:28Z",
                "close_time": "2023-06-07T17:32:28Z",
                "payload_size": 123,
                "closed": true,
                "status": "OK"
              }
            ]
          }
        ]
      },
      "index_status": "NOT_INDEXED",
      "access_roles": [
        {
          "added": "2023-06-07T17:32:28Z",
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

get /connection-manager/api/v1/connections/{connection_id}

Get a single connection.

connection_id

string

uuid

required

Response

ExamplesSchema

Connection successfully found

{
  "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "type": "SSH",
  "authentication_method": [
    "CERT"
  ],
  "user_data": {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "display_name": "user@domain.com"
  },
  "user_roles": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "name": "example-admins"
    }
  ],
  "target_host_data": {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "common_name": "linux-host"
  },
  "target_host_address": "123.123.123.123",
  "target_host_account": "dbuser",
  "target_host_roles": [
    {
      "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "name": "example-admins"
    }
  ],
  "remote_address": "123.123.123.123",
  "connected": "2017-01-01T15:05:05Z",
  "disconnected": "2017-01-01T15:05:05Z",
  "duration": "PT00:15:38",
  "status": "CONNECTED",
  "last_activity": "2017-01-01T15:05:05Z",
  "bytes_in": 123456,
  "bytes_out": 12345678,
  "force_disconnect": "2017-01-01T15:05:05Z",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "audit_enabled": true,
  "access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "trail": {
    "connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "protocol": "string",
    "channels": [
      {
        "id": "string",
        "type": "string",
        "bytes_client_to_server": 123,
        "bytes_server_to_client": 123,
        "protocol_file": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "offset": 123,
          "direction": 123,
          "open_time": "2023-06-07T17:32:28Z",
          "close_time": "2023-06-07T17:32:28Z",
          "payload_size": 123,
          "closed": true,
          "status": "OK"
        },
        "transferred_files": [
          {
            "id": "5bf77342-221c-11ee-be56-0242ac120002",
            "name": "string",
            "offset": 123,
            "direction": 123,
            "open_time": "2023-06-07T17:32:28Z",
            "close_time": "2023-06-07T17:32:28Z",
            "payload_size": 123,
            "closed": true,
            "status": "OK"
          }
        ]
      }
    ]
  },
  "index_status": "NOT_INDEXED",
  "access_roles": [
    {
      "added": "2023-06-07T17:32:28Z",
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

post /connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/file/{file_id}

Create session ID for trail stored file download.

connection_id

string

uuid

required

channel_id

string

required

file_id

string

uuid

required

Response

ExamplesSchema

Session ID created

{
  "session_id": "5bf77342-221c-11ee-be56-0242ac120002"
}

get /connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/file/{file_id}/{session_id}

Download trail stored file transferred within audited connection channel.

connection_id

string

uuid

required

channel_id

string

required

file_id

string

uuid

required

session_id

string

uuid

required

Response

ExamplesSchema

File found, download ok

Empty response

post /connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/log

Create session ID for trail log download.

connection_id

string

uuid

required

channel_id

string

required

Response

ExamplesSchema

Session ID created

{
  "session_id": "5bf77342-221c-11ee-be56-0242ac120002"
}

get /connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/log/{session_id}

Download trail log of audited connection channel.

format

string

Trail log format, jsonl or hex

Default
"hex"

filter

string

Trail log event filter, comma separated list of event types. For SSH the options are: stdin, stdout, stderr, forward-request, reverse-request, forward-reply, reverse-reply, forward-global-request, reverse-global-request, forward-new-channel-request, reverse-new-channel-request, forward-global-reply, reverse-global-reply, forward-new-channel-reply, reverse-new-channel-reply"

Response

ExamplesSchema

Trail log found, download ok

Empty response