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

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

Search for connections.

Query Params

offset

integer

Defaults to 0

Offset from which to start fetching objects

limit

integer

Defaults to 50

Maximum number of objects to return

sortkey

string

Defaults to id

Sort by specific object property

sortdir

string

Defaults to ASC

Sort direction, asc or desc

fuzzycount

boolean

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

Body Params

keywords

string

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

array of strings

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

force_disconnect

string

access_roles

array of uuids

access_roles

tags

has_access_roles

boolean

mode

array of strings

mode

Headers

Authorization

string

required

Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://example.com/connection-manager/api/v1/connections/search?offset=0&limit=50&sortkey=id&sortdir=ASC' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful request, respond with a list of connections

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error