How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ControlUp Scouts API

Scouts are the proactive tests that you configure to monitor the availability and health of various resources. There are different types of Scouts, depending on the type of resource you want to test. Within each type, there are sub-types which determine which test is performed and the available test configuration options.Scouts are initiated from Hives, which are either hosted in the cloud (Cloud Hives), or installed on-premises (Custom Hives).

ControlUp Scouts API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 64 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.controlup.com/synthetic-monitoring/v2/.

6 operations 3 paths 64 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.controlup.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

ControlUp Scouts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Scouts 6

Scouts are the proactive tests that you configure to monitor the availability and health of various resources. There are different types of Scouts, depending on the type of resour…

GET
/scouts
List all Scouts
app.get_scouts 10 params → 200401500
POST
/scouts
Create a Scout
app.create_scout body → 201400401500
GET
/scouts/{scoutId}
Get Scout info
app.get_scout_by_id 3 params → 200401500
PUT
/scouts/{scoutId}
Edit Scout
app.edit_scout 1 param body → 204400401500
DELETE
/scouts/{scoutId}
Delete Scout
app.delete_scout 1 param → 204400401500
POST
/scouts/{scoutId}/disabled
Enable/disable Scout
app.disable_scout 1 param body → 204400401500

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are ScoutItemEuc (10 properties), HttpExtras (10 properties), ScoutEditEuc (7 properties), ShellExtras (7 properties). Each schema is shown below with its type and property counts.

MarshmallowError
object
1 property
ScoutEditShell
ScoutEditEntraId
EucExtras
object
Additional options.
3 properties
TracerouteExtras
object
Additional options.
4 properties
ScoutSummary
object
Statistics about the Scout's test results.
5 properties
EntraIdExtras
object
Additional options for the Entra ID (Azure AD) Scout.
4 properties 1 required
ScoutCreateWebTransactions
Drives a real browser through a list of steps and reports timing and navigation metrics for each step.
CloudOrCustomHive
ScoutEditEuc
object
7 properties
ScoutCreateAvd
ProtocolICMP
object
2 properties
ScoutCreatePing
ScoutItem
object
Details about the Scout.
7 properties
ScoutCreateVmware
ScoutCreateCitrixCloud
Hives
object
1 property
HostnameAndIp
object
1 property
ScoutItemNet
Network properties
ScoutEditMsExchange
ScoutEditMail
ScoutCreateShell
Runs an executable from a Custom Hive. Shell Scouts can only run from Custom Hives.
ShellExtras
object
Additional options for the Shell Scout. The Scout runs the executable named in address on the host where its Custom Hive is installed.
7 properties
BaseError
object
1 property 1 required
ScoutCreateEucDomain
object
1 property 1 required
ScoutEditWebTransactions
WebTransactionsExtras
object
Additional options for the Web Transactions Scout.
5 properties
ScoutEditTraceroute
ScoutCreateVmwareSecServer
ScoutCreateEntraId
Tests connectivity and authentication against a Microsoft Entra ID (Azure AD) tenant.
MailExtras
object
Additional options for the Mail Scout. Mail authenticates exclusively via the user-delegated OAuth flow against Microsoft Entra ID — pass the delegated access…
3 properties 2 required
ScoutCreateApp
4 required
DNSExtras
object
Additional options.
4 properties
OTP
One-time password (OTP) information for the Scout. MFA is supported for all EUC Scout platforms except Citrix Storefront. Visit [Multi-Factor Authentication](h…
HttpAuth
ScoutCreateHttp
ScoutEditNet
ScoutCreateCitrix
MsTeamsExtras
object
Additional options for the Microsoft Teams Scout.
4 properties
ScoutCreateDNS
ScoutEditApp
ScoutEditSiteload
ScoutCreateMsTeams
ScoutCreateVmwareWsOne
Protocols
object
3 properties 1 required
ScoutCreateNet
5 required
ScoutCreateTraceroute
ScoutItemApp
Application properties
ScoutEditHttp
ScoutItemEuc
object
10 properties
ScoutEditMsTeams
ScoutCreateSiteload
Loads the target page in a real browser and measures key page-load metrics.
ScoutCreateMail
End-to-end mail-flow probe. Sends a message from one mailbox to another and measures delivery duration across each hop in the path.
HttpExtras
object
Additional options.
10 properties
PingExtras
object
Additional options.
4 properties
ScoutCreateEuc
object
7 properties 10 required
ScoutEditDNS
ScoutCreateMsExchange
Parent Scout that aggregates probes against the Exchange mail infrastructure. The actual probes are child Scouts of netping sub-type that the backend creates a…
ScoutEditPing
HttpProxy
Proxy information. A proxy server is only available if the Scout is running from a Custom Hive.
ScoutCreateStorefront
object
2 properties
Hostname
object
1 property
WebTransactionFlow
object
A single step in the Web Transactions flow. Each step has an actionType that dictates which of locator and extras you must supply, and what shape they take: |…
5 properties 2 required
SiteloadExtras
object
Additional options for the Siteload Scout.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-scouts-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
ControlUp Alerts API
ControlUp Alerts - Devices API
ControlUp Applications API
ControlUp Audit Log API
ControlUp Cloud providers API
ControlUp Dal API
ControlUp Data API
ControlUp Devices API
ControlUp Dynamic Query API API
ControlUp Events API
ControlUp Features API
Where this information came from

This is an independent, third-party profile of ControlUp Scouts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.