Catchpoint Systems Folder API
The Folder API from Catchpoint Systems — 3 operation(s) for folder.
Catchpoint Systems Folder 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 Folder. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 3 paths, and defines 78 schemas. It is described by OpenAPI 3.0.1, at version 2.0.
Requests are made against a single base URL, /api.
4 operations
3 paths
78 schemas
2 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Catchpoint Systems Folder API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Folder 4
GET
/v2/folders/{folderIds}
Return properties of one or more folders based on folder IDs.
GET
/v2/folders
Return folders per the parameters.
POST
/v2/folders
Create a new folder per the request body.
PATCH
/v2/folders/{folderId}
Update a property of an existing folder.
Schemas 78
The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are 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), Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemAPIModel (13 properties). Each schema is shown below with its type and property counts.
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertTriggerAPIModel
object
24 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.Response.v2_0.Node.NodeGroupItemApiModel
object
5 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.Enums.Test.InsightContentType
integer
Catchpoint.Symphony.Enums.Alerts.ReminderFrequency
integer
Catchpoint.Symphony.Enums.ObjectType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleApiModel
object
9 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]
object
6 properties
Catchpoint.Symphony.Enums.Test.AuthenticationMethodType
integer
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.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]
object
6 properties
Catchpoint.Symphony.Enums.Test.BandwidthThrottling
integer
Catchpoint.Symphony.Enums.Test.NodeDistribution
integer
Catchpoint.Symphony.Enums.Alerts.ReportAlertType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse
object
4 properties
Catchpoint.Symphony.ViewModels.LabelKeyModel
object
6 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.Enums.Alerts.DnsTraceType
integer
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.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
Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse
object
5 properties
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.Int32]
object
2 properties
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.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.Alerts.AlertHistoricalTimeThreshold
integer
Catchpoint.Symphony.ViewModels.CertificateModel
object
23 properties
2 required
Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemAPIModel
object
13 properties
3 required
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
Catchpoint.Symphony.Enums.TestFolderType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel
object
13 properties
3 required
System.DayOfWeek
integer
Catchpoint.Symphony.Enums.Test.APIInsightType
integer
Catchpoint.Symphony.Enums.Orchestra.TestReportMetricDataType
integer
Catchpoint.Symphony.ViewModels.CertificateContactGroupModel
object
8 properties
2 required
Catchpoint.Symphony.Enums.Test.InsightSourceType
integer
Catchpoint.Symphony.Enums.PasswordStatusType
integer
Catchpoint.Symphony.Enums.Alerts.ReportAlertSubtype
integer
Catchpoint.Symphony.Enums.Test.DisplayMonitorType
integer
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 Insights API
Catchpoint Systems Instances API
#Folder