Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Catchpoint

Catchpoint InstantTest API

The InstantTest API from Catchpoint — 4 operation(s) for instanttest.

Documentation Provider Profile APIs.io OpenAPI GitHub

Catchpoint InstantTest API is one of 31 APIs that Catchpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 148 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

4 operations 4 paths 148 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint InstantTest API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 4

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

InstantTest 4
POST
/v2/instanttests
Runs a new instant test based on the POST data.
1 param body → 200
GET
/v2/instanttests/configuration/{instantTestId}
Returns properties of one instant test based on instant test ID.
1 param → 200
GET
/v2/instanttests/{instantTestId}
Return instant test results performance data based on an instant test ID and node ID.
3 params → 200
POST
/v2/instanttests/{testId}
Runs an instant test by ID.
2 params body → 200

Schemas 148

The contract defines 148 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebRecordItem (38 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestAPIModel (37 properties), Catchpoint.Symphony.Response.NetworkGraphEdge (33 properties), Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSslData (31 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.Enums.Test.WebRequestPostDataFormat
integer
Catchpoint.Symphony.ViewModels.CertificateContactModel
object
8 properties 2 required
TestFlag
integer
Catchpoint.Symphony.Enums.MobilePlaybackSourceType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordWebDataAPIModel
object
12 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ContentTagAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Metrics.RecordMetric
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordMqttData
object
4 properties
Catchpoint.Symphony.Enums.Test.TestAction
integer
Catchpoint.Symphony.Enums.Dimension.BreakdownDimension
integer
Catchpoint.Symphony.Enums.Metrics.AnalyticsMetric
integer
Catchpoint.Symphony.ViewModels.InternetServiceTypeModel
object
9 properties
Catchpoint.Symphony.ViewModels.AssociatedCertificateModel
object
11 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordTransactionStepAPIModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestGetResponse
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestPostResponse
object
5 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestGetResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ZoneAPIModel
object
2 properties
Catchpoint.Symphony.Response.ErrorCode
object
5 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebErrorCodeItem
object
3 properties
Catchpoint.Symphony.Response.TraceRouteIpAddressLookup
object
8 properties
Catchpoint.Symphony.Enums.Test.InsightSourceType
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestPostResponse]
object
6 properties
Catchpoint.Symphony.Enums.Test.DisplayTestType
integer
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebRecordItem
object
38 properties
Microsoft.AspNetCore.Mvc.ActionResult
object
Catchpoint.Symphony.ViewModels.CountryModel
object
5 properties
Catchpoint.Symphony.ViewModels.UriSlim
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordPageSpeedItem
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.HostDataAPIModel
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItemResponse
object
6 properties
Catchpoint.Symphony.Enums.WinHttp.WinHttpMethod
integer
Catchpoint.Symphony.Response.NetworkIspOutageSummaryData
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordTransactionDataAPIModel
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWebSocketItem
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItems
object
1 property
Catchpoint.Symphony.REST.Common.Requests.v2_0.InstantTestPostRequest
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordContentTagAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Test.WifiModeType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordResponseAPIModel
object
28 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItem
object
8 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RequestSettingsAPIModel
object
6 properties
Catchpoint.Symphony.Enums.Test.ApiTransactionScriptType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSshData
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.Enums.WinHttp.HttpVersionType
integer
Catchpoint.Symphony.ViewModels.InternetServiceDetailsModel
object
8 properties
Catchpoint.Symphony.Response.NetworkGraphTooltipOverrideSummaryData
object
7 properties
Catchpoint.Symphony.Orchestra.Response.PingProbeData
object
2 properties
Catchpoint.Symphony.Enums.ApplicationVersionType
integer
Catchpoint.Symphony.Response.NetworkGraphPathMtuData
object
1 property
Catchpoint.Symphony.Response.NetworkIspOutageData
object
1 property
Catchpoint.Symphony.Orchestra.Response.ECNSummaryData
object
2 properties
Catchpoint.Symphony.Orchestra.Response.RecordMetricItem
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordContentZone
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWebSocketData
object
9 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSslData
object
31 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSmtpData
object
5 properties
Catchpoint.Symphony.ViewModels.InternetServiceStackMapDataAssociationModel
object
7 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTransactionStep
object
10 properties
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNodeReturnCodeGroup
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordHeader
object
2 properties
Catchpoint.Symphony.ViewModels.CertificateModel
object
23 properties 2 required
Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestAPIModel
object
37 properties
Catchpoint.Symphony.Orchestra.Response.RecordScriptErrorItem
object
5 properties
Catchpoint.Symphony.ViewModels.SonarPointsPerDay
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphEdge
object
33 properties
Catchpoint.Symphony.Response.MplsHopSummaryData
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordNtpData
object
4 properties
Catchpoint.Symphony.Orchestra.Response.PingData
object
25 properties
Catchpoint.Symphony.Enums.Test.DisplayInstantTestType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordAdditionalMonitorData
object
5 properties
Catchpoint.Symphony.Enums.Test.WebRequestHeaderType
integer
Catchpoint.Symphony.ViewModels.CustomFieldModel
object
4 properties
Catchpoint.Symphony.Enums.PlaybackSourceType
integer
Catchpoint.Symphony.ViewModels.LabelValueModel
object
6 properties
Catchpoint.Symphony.Enums.PasswordStatusType
integer
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.ImageDataItem
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestNodeModel
object
6 properties
Catchpoint.Symphony.ViewModels.AssociatedLabelValueModel
object
11 properties 1 required
Catchpoint.Symphony.Enums.Sonar.GraphVertexType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordMetricItemAPIModel
object
5 properties
Catchpoint.Symphony.Enums.WebTagType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceData
object
10 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphPathMtuSummaryData
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordFtpData
object
4 properties
Catchpoint.Symphony.ViewModels.InternetServiceModel
object
26 properties 2 required
Catchpoint.Symphony.Enums.SettingsType
integer
Catchpoint.Symphony.ViewModels.RegionModel
object
4 properties
Catchpoint.Symphony.Response.NetworkGraphTooltipOverrideData
object
1 property
Catchpoint.Symphony.Orchestra.Response.DebugProbeData
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordStreamingData
object
13 properties
Catchpoint.Symphony.Orchestra.Response.RecordDnsSecItem
object
2 properties
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel
object
5 properties
Microsoft.AspNetCore.Mvc.ActionResult`1[Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestGetResponse]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.WebRecordAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Test.DnsQueryType
integer
Catchpoint.Symphony.Enums.MtuIndexType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RequestAuthenticationAPIModel
object
6 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTcpData
object
5 properties
Catchpoint.Symphony.Response.EcnSummaryData
object
2 properties
Catchpoint.Symphony.Enums.InternetServiceCategoryType
integer
Catchpoint.Symphony.ViewModels.LookupModel
object
6 properties
Catchpoint.Symphony.Orchestra.Response.TraceRouteData
object
16 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.InstantTest.InstantTestAuthenticationAPIModel
object
3 properties
Catchpoint.Symphony.Response.GraphPath
object
11 properties
Catchpoint.Symphony.Enums.Test.PageSpeedRuleType
integer
Catchpoint.Symphony.Enums.Test.WebSocketTransferType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.HttpErrorCodeItem
object
3 properties
Catchpoint.Symphony.Enums.Test.DisplayMonitorType
integer
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.ViewModels.CertificateContactGroupModel
object
8 properties 2 required
Catchpoint.Symphony.ViewModels.ApdexThresholdModel
object
9 properties
Catchpoint.Symphony.Response.DscpSummaryData
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphResponse
object
12 properties
Catchpoint.Symphony.Enums.InternetServiceIdentityType
integer
Catchpoint.Symphony.Enums.UserAgentType
integer
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.Orchestra.Response.IndicatorData
object
2 properties
Catchpoint.Symphony.Enums.Test.InsightContentType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.MetricModel
object
2 properties
Catchpoint.Symphony.Enums.Test.APIInsightType
integer
Catchpoint.Symphony.Orchestra.Response.TracepointData
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordHostDataAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Test.AuthenticationMethodType
integer
Catchpoint.Symphony.Enums.Test.WifiSecurityType
integer
Catchpoint.Symphony.Enums.ObjectType
integer
Catchpoint.Symphony.Enums.WinHttpErrorCode
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWifiData
object
10 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EmailMessageFieldsAPIModel
object
7 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.HttpRequestHeaderAPIModel
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordImapData
object
5 properties
Catchpoint.Symphony.Enums.RecordWebItemRequestType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.HeaderItem
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTransactionData
object
2 properties
Catchpoint.Symphony.ViewModels.LabelKeyModel
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel
object
12 properties
Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.Response.NetworkGraphSummary
object
14 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItemQuery
object
11 properties
Catchpoint.Symphony.Response.FallbackReason
object
3 properties
Catchpoint.Symphony.Response.NetworkGraphVertex
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-instanttest-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

Catchpoint Account API
AE Profile APIs.io
Catchpoint Alerts API
AE Profile APIs.io
Catchpoint ASNs API
AE Profile APIs.io
Catchpoint Assertions API
AE Profile APIs.io
Catchpoint CommandControl API
AE Profile APIs.io
Catchpoint Contacts API
AE Profile APIs.io
Catchpoint Credentials API
AE Profile APIs.io
Catchpoint Divisions API
AE Profile APIs.io
Catchpoint EndpointDevice API
AE Profile APIs.io
Catchpoint EndpointDevicePerformance API
AE Profile APIs.io
Catchpoint Folder API
AE Profile APIs.io
Catchpoint Insights API
AE Profile APIs.io
#InstantTest
← Back to C APIs
API Details
ID
catchpoint:catchpoint-instanttest-api
Base URL
https://io.catchpoint.com/api
Docs
https://docs.catchpoint.com/docs/rest-api-v2-guide
Provider
Catchpoint
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network