List all Scouts

get

https://api.controlup.com/synthetic-monitoring/v2/scouts

Returns a list of your Scouts.

📘
Updated URL and authentication
On February 11, we updated the Synthetic Monitoring API to align its URL and authentication with the rest of the ControlUp platform. Learn more.

Query Params

hiveId

array of int32s

Only return Scouts running from the Custom Hives specified by these hive IDs.

hiveId

cloudHive

array of int32s

Only return Scouts running from the Cloud Hives specified by these hive IDs.

cloudHive

scoutName

string

Filter by Scout name (partial match).

type

string

enum

Filter the list based on the Scout type.

Allowed:

subType

string

enum

Filter the list based on the Scout sub-type.

interval

integer

Filter the list based on the interval (in minutes) of how often a Scout runs.

disabled

boolean

enum

Defaults to 0

Use this parameter to only return disabled Scouts. By default, only enabled Scouts are returned.

Allowed:

username

string

Only return Scouts that use this username to access the resource. This only applies to EUC Scouts.

page

integer

The page of Scouts to be returned. Each page contains up to 100 Scouts. If your request returns more than 100 Scouts, then the response is paginated.

200A list of Scouts

401Missing or wrong api key

500Server errors