The identity and technical contract details declared by the specification.
AlertConditionGroupTraceroute
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
ErrorCode.Forbidden
number
AlertTerminalRuleWebTransactions
object
A single alert condition that evaluates a test result property.
3 properties
Alert
object
22 properties
AlertConditionObjectCitrix
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionObjectAvd
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionObjectTeams
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertTerminalRuleCitrixCloud
object
A single alert condition that evaluates a test result property.
3 properties
HttpStatusCode.NOT_FOUND
number
AlertDetails
Detailed information about an alert policy for a Scout.
AlertTriggerSettings
object
Settings that control when and how alerts are triggered.
5 properties
AlertConditionObjectCitrixStorefront
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionGroupAzureAd
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
ErrorResponseBody_ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized__
object
2 properties
2 required
ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound_
object
4 properties
3 required
PaginatedResponseMetadata
object
5 properties
5 required
SubType
object
1 property
AlertConditionGroupCitrix
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError_
object
4 properties
3 required
AlertConditionGroupCitrixStorefront
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertTerminalRuleTraceroute
object
A single alert condition that evaluates a test result property.
3 properties
ErrorMessage.Unauthorized
string
AlertConditionObjectDns
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionObjectVmware
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertTerminalRuleAvd
object
A single alert condition that evaluates a test result property.
3 properties
ErrorMessage.InternalServerError
string
AlertTerminalRuleExchange
object
A single alert condition that evaluates a test result property.
3 properties
HttpStatusCode.FORBIDDEN
number
AlertConditionGroupDns
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
ErrorResponseBody_ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes__
object
2 properties
2 required
HttpStatusCode.BAD_REQUEST
number
UUID
string
Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)
MarshmallowError
object
1 property
AlertTerminalRuleDns
object
A single alert condition that evaluates a test result property.
3 properties
AlertNotification
Notifications sent when the Scout triggers the alert. If no notifications are selected, you can still view each time the alert has triggered using the API endp…
AlertConditions
Defines the test results that trigger an alert. Select your Scout type to see how to create conditions for that Scout type.
AlertTerminalRulePing
object
A single alert condition that evaluates a test result property.
3 properties
AlertTerminalRuleShell
object
A single alert condition that evaluates a test result property.
3 properties
AlertTerminalRuleHttp
object
A single alert condition that evaluates a test result property.
3 properties
ErrorResponseBody_ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden__
object
2 properties
2 required
AlertConditionObjectPing
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
JsonApiError
object
Error object
6 properties
4 required
AlertTerminalRuleResponse
object
A single alert condition that evaluates a test result property.
3 properties
AlertConditionObjectSiteload
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertIntegrationNotification
object
2 properties
2 required
AlertConditionGroupCitrixCloud
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertConditionGroupWebTransactions
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertConditionObjectCitrixCloud
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
ErrorResponseMetadata
object
4 properties
4 required
ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes_
object
4 properties
3 required
AlertConditionObjectHttp
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionObjectExchange
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized_
object
4 properties
3 required
ErrorCode.Unauthorized
number
AlertConditionObjectTraceroute
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
BaseError
object
1 property
1 required
AlertConditionGroupVmware
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertConditionObjectWebTransactions
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertTerminalRuleSiteload
object
A single alert condition that evaluates a test result property.
3 properties
AlertConditionGroupExchange
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertConditionGroupTeams
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
HttpStatusCode.UNAUTHORIZED
number
AlertSummary
object
Summary information about an alert policy for a Scout.
5 properties
4 required
AlertConditionGroupSiteload
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertCreateRequest
object
Request schema for creating a new alert for a Scout
3 properties
1 required
ErrorResponseBody_ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError__
object
2 properties
2 required
AlertItem
Details of the Scout's alert configuration and each time the alert was triggered.
BadRequestErrorCodes
number
AlertConditionObjectShell
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
AlertConditionGroupAvd
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
ErrorCode.NotFound
number
ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden_
object
4 properties
3 required
ErrorMessage.Forbidden
string
AlertConditionGroupShell
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
APIResponse_AlertMetadataDTO-Array_
object
1 property
1 required
AlertConditionGroupPing
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
AlertTerminalRuleAzureAd
object
A single alert condition that evaluates a test result property.
3 properties
AlertTerminalRuleVmware
object
A single alert condition that evaluates a test result property.
3 properties
AlertConditionGroupHttp
object
Group of conditions or condition groups with AND/OR operators. Supports nesting up to 5 levels deep.
2 properties
2 required
APIPaginatedResponse_AlertMetadataDTO-Array_
BadRequestErrorMessages
string
AlertConditionObjectAzureAd
To create an Alert policy based on a single condition (for example, status == 'failure'), select Condition. To create an Alert policy based on multiple conditi…
ErrorCode.InternalServerError
number
AlertTerminalRuleTeams
object
A single alert condition that evaluates a test result property.
3 properties
AlertWebhookNotification
object
5 properties
2 required
HttpStatusCode.INTERNAL_SERVER_ERROR
number
ErrorResponseBody_ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound__
object
2 properties
2 required
ErrorMessage.NotFound
string
AlertTerminalRuleCitrix
object
A single alert condition that evaluates a test result property.
3 properties
AlertConfigBaseDTO
object
5 properties
4 required
AlertUpdateRequest
object
Request schema for updating an alert for a Scout
4 properties
AlertTerminalRuleCitrixStorefront
object
A single alert condition that evaluates a test result property.
3 properties
AlertEmailNotification
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ControlUp publishes across the network.
