Skip to main content
Version: v41

connection_search

Search object for the search request. Attributes can be comma-separated strings (or in case of keyword, comma or space-separated). Individual attributes form a AND query and multiple values within an attribute form an OR query. E.g. search "dev 10.0" translates to WHERE (field1 like %dev% OR field2 like %dev%) AND (field1 like %10.0% OR field2 like %10.0%)

keywordsstring

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

idstring[]
proxy_idstring[]
typestring[]

Possible values: [SSH, RDP, VNC, WEB]

authentication_methodstring[]

Possible values: [CERT, PUBKEY, PASSPHRASE, PROMPTED_PASSPHRASE, UNKNOWN]

user_idstring<uuid>[]
user_display_namestring[]
user_rolesstring[]

The role ids.

target_host_idstring<uuid>[]
target_host_addressstring[]
target_host_accountstring[]
target_host_rolesstring[]

The role ids.

remote_addressstring[]
connected object
startstring
endstring
disconnected object
startstring
endstring
statusstring[]

Possible values: [CONNECTED, DISCONNECTED, TERMINATING, TERMINATED, CONNMGR_TIMEOUT, CONNMGR_CLIENT_LOST]

last_activity object
startstring
endstring
force_disconnectstring
access_rolesstring<uuid>[]
tagsstring[]
has_access_rolesboolean
modestring[]

Possible values: [MITM, UI, FORWARDED]

connection_search
{
"keywords": "string",
"id": [
"string"
],
"proxy_id": [
"string"
],
"type": [
"SSH"
],
"authentication_method": [
"CERT"
],
"user_id": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"user_display_name": [
"string"
],
"user_roles": [
"string"
],
"target_host_id": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"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": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"tags": [
"string"
],
"has_access_roles": true,
"mode": [
"MITM"
]
}