Catchpoint Systems Test API
The Test API from Catchpoint Systems — 7 operation(s) for test.
Catchpoint Systems Test API is one of 31 APIs that Catchpoint Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Test. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 9 operations across 7 paths, and defines 107 schemas. It is described by OpenAPI 3.0.1, at version 2.0.
Requests are made against a single base URL, /api.
9 operations
7 paths
107 schemas
1 DELETE4 GET2 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Catchpoint Systems Test API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Test 9
GET
/v2/tests/{testIds}
Returns properties of one or more tests based on test IDs.
DELETE
/v2/tests/{testIds}
Delete tests based on the specified list of IDs.
POST
/v2/tests
Create a new test per the request body.
GET
/v2/tests
Returns tests that match all included parameters.
GET
/v2/tests/alert/state/{testIds}
Return the alert state of one or more tests based on test IDs.
PATCH
/v2/tests/alert/state
Pause or unpause alerts for the specified test IDs.
PATCH
/v2/tests/{testId}
Update a property of an existing test.
GET
/v2/tests/enumeration
Returns the enumeration to help automate test creation.
POST
/v2/tests/scriptconvert
Convert a script to a specified language. Only Selenium (1) to Playwright (3) is currently supported.
Schemas 107
The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Test.TestAPIModel (59 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertTriggerAPIModel (24 properties), Catchpoint.Symphony.ViewModels.CertificateModel (23 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.AdvancedSettingsAPIModel (16 properties). Each schema is shown below with its type and property counts.
Catchpoint.Symphony.ViewModels.CustomFieldModel
object
4 properties
Catchpoint.Symphony.Enums.Test.DisplayTestType
integer
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertTriggerAPIModel
object
24 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.ApdexThresholdAPIModel
object
8 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.ViewModels.LabelValueModel
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.AdvancedSettingsAPIModel
object
16 properties
Catchpoint.Symphony.ViewModels.CertificateContactModel
object
8 properties
2 required
Catchpoint.Symphony.REST.Common.Requests.v2_0.ScriptConvertRestRequest
object
1 property
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeGroupItemApiModel
object
5 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EmailMessageFieldsAPIModel
object
7 properties
Catchpoint.Symphony.Enums.Test.TestAction
integer
Catchpoint.Symphony.Enums.Test.InsightContentType
integer
Catchpoint.Symphony.Enums.Alerts.ReminderFrequency
integer
Catchpoint.Symphony.Enums.ObjectType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.TestPostResponse
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleApiModel
object
9 properties
Catchpoint.Symphony.Enums.Test.AuthenticationMethodType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.TestGetResponse
object
4 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RequestAuthenticationAPIModel
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ScheduleSettingsAPIModel
object
13 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertInstructionsAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel
object
12 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.TestAPIModel
object
59 properties
7 required
Catchpoint.Symphony.Enums.Test.BandwidthThrottling
integer
Catchpoint.Symphony.Enums.Test.NodeDistribution
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertStatusResponse
object
4 properties
Catchpoint.Symphony.Enums.Alerts.ReportAlertType
integer
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.ViewModels.LabelKeyModel
object
6 properties
Catchpoint.Symphony.Enums.Alerts.DnsTraceType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationDetailResponse
object
2 properties
Catchpoint.Symphony.Enums.Test.WebRequestHeaderType
integer
Catchpoint.Symphony.Enums.Alerts.NodeThresholdType
integer
Catchpoint.Symphony.Enums.Alerts.AlertTriggerType
integer
Catchpoint.Symphony.Enums.Test.DisplayTestFrequency
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecipientAPIModel
object
6 properties
Catchpoint.Symphony.Enums.Alerts.AlertInstructionType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse]
object
6 properties
Catchpoint.Symphony.Enums.Metrics.AnalyticsMetric
integer
Catchpoint.Symphony.Enums.Alerts.NotificationType
integer
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightsAPIModel
object
3 properties
Catchpoint.Symphony.Enums.Alerts.AlertGroupItemFilterType
integer
TestFlag
integer
Catchpoint.Symphony.Enums.Alerts.AlertTimeThresholdInterval
integer
Catchpoint.Symphony.ViewModels.AssociatedCertificateModel
object
11 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.OneTimeScheduleItemApiModel
object
5 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Nullable`1[System.Int32]]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ScriptConvertResponse
object
4 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.TestDeleteResponse
object
4 properties
Catchpoint.Symphony.Enums.Test.WebRequestPostDataFormat
integer
Catchpoint.Symphony.Enums.WinHttp.WinHttpMethod
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestPostResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse
object
4 properties
Catchpoint.Symphony.Enums.Alerts.AlertStateType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.NotificationGroupAPIModel
object
7 properties
2 required
Catchpoint.Symphony.Enums.Alerts.RecipientType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.AlertWebhookAPIModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Label.LabelAPIModel
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ScriptConvertResponse]
object
6 properties
Catchpoint.Symphony.Enums.Test.SelfZoneMatchingOptions
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.RecurringScheduleItemApiModel
object
6 properties
Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertNodeThresholdAPIModel
object
10 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.Enums.DateTimes.WeekOfMonth
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleIntervalApiModel
object
2 properties
Catchpoint.Symphony.Enums.Alerts.OperatorType
integer
Catchpoint.Symphony.ViewModels.AssociatedLabelValueModel
object
11 properties
1 required
Catchpoint.Symphony.REST.Common.Response.v2_0.RequestSettingsAPIModel
object
6 properties
Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.HttpRequestHeaderAPIModel
object
4 properties
Catchpoint.Symphony.Enums.Test.ApiTransactionScriptType
integer
Catchpoint.Symphony.Enums.Alerts.AlertHistoricalTimeThreshold
integer
Catchpoint.Symphony.ViewModels.CertificateModel
object
23 properties
2 required
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestGetResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemAPIModel
object
13 properties
3 required
Catchpoint.Symphony.Enums.ApplicationVersionType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemFilterAPIModel
object
6 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel
object
9 properties
Catchpoint.Symphony.Enums.SettingsType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupAPIModel
object
4 properties
System.DayOfWeek
integer
Catchpoint.Symphony.Enums.Test.APIInsightType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.AlertStatusAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.ChromeMonitorVersionAPIModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.BenchmarkIndexAPIModel
object
5 properties
Catchpoint.Symphony.Enums.UserAgentType
integer
Catchpoint.Symphony.Enums.Orchestra.TestReportMetricDataType
integer
Catchpoint.Symphony.ViewModels.CertificateContactGroupModel
object
8 properties
2 required
Catchpoint.Symphony.Enums.Test.InsightSourceType
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertStatusResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestDeleteResponse]
object
6 properties
Catchpoint.Symphony.Enums.PasswordStatusType
integer
Catchpoint.Symphony.Enums.Test.DnsQueryType
integer
Catchpoint.Symphony.Enums.Alerts.ReportAlertSubtype
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.TestRequestDataAPIModel
object
13 properties
1 required
Catchpoint.Symphony.Enums.Test.DisplayMonitorType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Test.CertificateAPIModel
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Catchpoint Systems 12
Other APIs Catchpoint Systems publishes across the network.
Catchpoint Systems Account API
Catchpoint Systems Alerts API
Catchpoint Systems ASNs API
Catchpoint Systems Assertions API
Catchpoint Systems CommandControl API
Catchpoint Systems Contacts API
Catchpoint Systems Credentials API
Catchpoint Systems Divisions API
Catchpoint Systems EndpointDevice API
Catchpoint Systems EndpointDevicePerformance API
Catchpoint Systems Folder API
Catchpoint Systems Insights API
#Test