API Reference
Log In
API Reference
These docs are for v22. Click to read the latest docs for v33.

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

post
https://example.com/connection-manager/api/v1/connections/search

Search for connections.

Query Params
integer
Defaults to 0

Offset from which to start fetching objects

integer
Defaults to 50

Maximum number of objects to return

string
Defaults to id

Sort by specific object property

string
enum
Defaults to ASC

Sort direction, asc or desc

Allowed:
Body Params
string

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

id
array of strings
id
proxy_id
array of strings
proxy_id
type
array of strings
type
authentication_method
array of strings
authentication_method
user_id
array of uuids
user_id
user_display_name
array of strings
user_display_name
user_roles
array of strings

The role ids.

user_roles
target_host_id
array of uuids
target_host_id
target_host_address
array of strings
target_host_address
target_host_account
array of strings
target_host_account
target_host_roles
array of strings

The role ids.

target_host_roles
remote_address
array of strings
remote_address
connected
object
disconnected
object
status
array of strings
status
last_activity
object
string
access_roles
array of uuids
access_roles
boolean
mode
array of strings
mode
Headers
string
required
Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Updated over 4 years ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 4 years ago