openapi: 3.0.1 info: title: Catchpoint REST API v2.0 Account Folder API version: '2.0' servers: - url: /api tags: - name: Folder paths: /v2/folders/{folderIds}: get: tags: - Folder summary: Return properties of one or more folders based on folder IDs. description: " Results include properties from all sections available in the UI: folder Properties, Advanced Settings, Requests, Insights, Targeting & Scheduling, and Alerts.\r\n\r\nAssigning “0” to Folder ID would return the payload to create a new product." parameters: - name: folderIds in: path description: Comma-separated list of folder IDs to look up required: true schema: type: string - name: showInheritedProperties in: query description: Flag to set to see inherited properties as part of the folder properties returned schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' text/plain: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' text/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' security: - bearer: [] order: 1 /v2/folders: get: tags: - Folder summary: Return folders per the parameters. description: 'All parameters are optional, and you may include any of them to customize the query. To pass multiple values for a parameter, provide a comma-separated list. If no parameters are passed, then details for all active folders are returned. Results include properties from all sections available in the UI: folder Properties, Advanced Settings, Requests, Insights, Targeting & Scheduling, and Alerts. The query returns 100 records per page; if there are more than 100 records then the response will have the “hasMore” property set to “true”.' parameters: - name: productIds in: query description: Comma-separated list of product IDs schema: type: string - name: parentFolderIds in: query description: Comma-separated list of folder IDs schema: type: string - name: name in: query description: Folder name schema: type: string - name: includeAdvanceSettings in: query description: Include advanced settings section of the folder in the response schema: type: boolean default: false - name: includeRequest in: query description: Include request settings sections of the folder in the response schema: type: boolean default: false - name: includeInsight in: query description: Include insights section of the folder in the response schema: type: boolean default: false - name: includeTargeting in: query description: Include targeting and scheduling section of the folder in the response schema: type: boolean default: false - name: includeAlerts in: query description: Include alerts section of the folder in the response schema: type: boolean default: false - name: pageNumber in: query description: Page number to return records from when the number of records exceeds pageSize schema: type: integer format: int32 default: 1 - name: pageSize in: query description: The number of records that can be returned per page. Maximum value is 100. schema: type: integer format: int32 default: 100 - name: showInheritedProperties in: query description: Represents if inherited properties should be shown schema: type: boolean default: false - name: credentialIds in: query description: Comma-separated list of Credential IDs schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' text/plain: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' text/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]' security: - bearer: [] order: 2 post: tags: - Folder summary: Create a new folder per the request body. description: "The request body must include all required folder properties and may include any optional properties as well. To get a sample payload to pass along with the request, refer to the InternalLink[Folder Details by ID Endpoint,operations-tag-Folder,operations-Folder-get_v2_folders__folderIds_]\r\n\r\nTo create a folder, only the required properties need to be passed in the request body. If no details are provided for sections like targeting and scheduling, alerts, etc. then those properties will be set as inherited." parameters: - name: objectDetails in: query description: Set to true to return the created object in the response body, otherwise the response body will only return the created object ID. schema: type: boolean requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' application/json-patch+json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' text/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' application/*+json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' text/plain: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' text/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' security: - bearer: [] order: 3 /v2/folders/{folderId}: patch: tags: - Folder summary: Update a property of an existing folder. description: "Only the property to be updated can be passed in the request body (do not pass the whole object.) The update request body requires a total of three keys to be filled with appropriate value as listed below:\r\n* **value** – The value property provides the new value.\r\n\r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n\r\n* **op** – The op property indicates the type of operation; we allow the following three operations:\r\n\r\n * **add** - Add a property or array element. For existing property: set value.\r\n \r\n * **Remove** - Remove a property or array element.\r\n \r\n * **replace** - Same as remove, followed by add at same location. \r\n\r\n* **from** - [Not Used]\r\n\r\n * **Explanation** - The \"from\" parameter represents the starting or current value of the resource that the operation intends to modify. The from parameter is included in the example value schema but is not utilized in this endpoint's functionality. It is reserved for potential future use or could be used in specific scenarios not covered by the current implementation." parameters: - name: folderId in: path description: Folder ID of the folder to be updated required: true schema: type: integer format: int32 - name: objectDetails in: query description: Set to true to return the updated object in the response body, otherwise the response body will only return the updated object ID. schema: type: boolean requestBody: description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation' application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation' text/json: schema: type: array items: $ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation' application/*+json: schema: type: array items: $ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' text/plain: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' text/json: schema: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]' security: - bearer: [] order: 4 components: schemas: Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertInstructionsAPIModel: type: object properties: instructions: type: string nullable: true id: type: integer format: int32 instructionType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.AlertInstructionType' additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertTriggerAPIModel: type: object properties: id: type: integer format: int64 readOnly: true expression: type: string nullable: true fileName: type: string nullable: true filterItems: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemFilterAPIModel' nullable: true warningReminderFrequency: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.ReminderFrequency' criticalReminderFrequency: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.ReminderFrequency' triggerType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.AlertTriggerType' operationType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.OperatorType' statisticalType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Orchestra.TestReportMetricDataType' filterType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.AlertGroupItemFilterType' dnsRecordType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.DnsTraceType' historicalInterval: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.AlertHistoricalTimeThreshold' thresholdInterval: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.AlertTimeThresholdInterval' fileHash: type: string nullable: true warningTrigger: type: number format: float nullable: true criticalTrigger: type: number format: float nullable: true filterValue: type: string nullable: true dnsTTL: type: integer format: int64 nullable: true dnsResolvedName: type: string nullable: true scheduleId: type: integer format: int32 nullable: true monitorTypeBitFlags: type: integer format: int64 monitor: type: string nullable: true readOnly: true customDataId: type: integer format: int32 nullable: true useIntervalRollingWindow: type: boolean nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.AlertWebhookAPIModel: type: object properties: id: type: integer format: int32 divisionId: type: integer format: int32 statusType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DomainStatus' name: type: string nullable: true url: type: string nullable: true additionalProperties: false Catchpoint.Symphony.ViewModels.CertificateContactModel: required: - certificateDataId - contactId type: object properties: certificateDataId: type: integer format: int32 contactId: type: integer format: int32 contactFullName: type: string nullable: true createContactId: type: integer format: int32 nullable: true createDate: type: string format: date-time id: type: integer format: int32 name: type: string nullable: true readOnly: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' additionalProperties: false TestFlag: enum: - id: 0 name: None - id: 1 name: Cache TLD Query Levels - id: 2 name: Verify Test on Failure - id: 3 name: Debug Primary Host on Failure - id: 4 name: Enable HTTP/2 - id: 5 name: PauseAlerts - id: 6 name: CustomReports - id: 7 name: Enable Cookie Collection - id: 8 name: Debug Referenced Hosts on Failure - id: 9 name: Capture HTTP Headers - id: 10 name: Capture HTTP headers on error - id: 11 name: Capture Response Content - id: 12 name: Capture Response Content - id: 13 name: Capture Filmstrip - id: 14 name: Capture Screenshot at Test End - id: 16 name: Calculate Page Speed Score - id: 17 name: Ignore SSL Failures - id: 18 name: Capture Screenshot on Error - id: 19 name: Dns Host Name lookup method; BIND.HOSTNAME - id: 20 name: Protocol - id: 21 name: Dns Host Name lookup method; NSID - id: 22 name: Disable Recursive Resolution - id: 23 name: Host Data Collection Enabled - id: 24 name: Zone Data Collection Enabled - id: 25 name: Stop Test on Document Complete - id: 26 name: On NS server failure retry next NS server on the same level - id: 27 name: Treat 40X or 50X HTTP Response as successful test run - id: 28 name: Capture HTTP headers on error page - id: 29 name: Response Content or Metadata Capture on Error Page - id: 30 name: Capture Screenshot on Error Page - id: 31 name: Favor NS Servers with lower Round Trip Time (RTT) - id: 32 name: Disable "Paris" Traceroute Mode - id: 33 name: 30x Redirects Do Not Follow - id: 34 name: Enable Adblock Extension - id: 35 name: StoreCaptureDataInCloud - id: 36 name: Enable Self Versus Third Party Zones - id: 37 name: Allow Test Download Limit Override - id: 38 name: Disable cross-origin Iframe access - id: 39 name: Stop Test on Dom Content Load - id: 40 name: InitiatedFromApi - id: 41 name: InstantTestCharged - id: 42 name: Certificate Revocation Disabled - id: 43 name: Enforce Certificate Pinning - id: 44 name: Enforce Public Key Pinning - id: 48 name: Enable DNSSEC - id: 50 name: Enable Path MTU Discovery - id: 51 name: Tracing - id: 52 name: Is Continous - id: 53 name: Enable ECN - id: 54 name: Enable DSCP - id: 55 name: Is Accurate ECN - id: 56 name: Enable query limits type: integer format: int32 Catchpoint.Symphony.Enums.Test.BandwidthThrottling: enum: - id: 1 name: GPRS - id: 2 name: Regular2G - id: 3 name: Good2G - id: 4 name: Regular3G - id: 5 name: Good3G - id: 6 name: Regular4G - id: 7 name: DSL - id: 8 name: WiFi - id: 9 name: Regular5G - id: 10 name: Fiber - id: 11 name: Cable - id: 12 name: LTE - id: 13 name: MobileEdge - id: 14 name: Dialup56K type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse]: type: object properties: data: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse' messages: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage' nullable: true errors: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel' nullable: true completed: type: boolean readOnly: true traceId: type: string nullable: true usageLimits: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics' additionalProperties: false Catchpoint.Symphony.ViewModels.AssociatedCertificateModel: type: object properties: certificateDataId: type: integer format: int32 divisionId: type: integer format: int32 id: type: integer format: int32 objectId: type: integer format: int64 nullable: true objectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' createDate: type: string format: date-time createContactId: type: integer format: int32 nullable: true objectName: type: string nullable: true objectStatus: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DomainStatus' name: type: string nullable: true readOnly: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' additionalProperties: false Catchpoint.Symphony.REST.Api.ConsumerStatistics: type: object properties: consumerId: type: integer format: int32 requestCount: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit' maxPerDay: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]: type: object properties: id: type: integer format: int32 name: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath: type: object properties: ops: type: string nullable: true path: type: string nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Test.InsightSourceType: enum: - id: 0 name: HttpHeader - id: 1 name: HttpContent - id: 2 name: PerformanceMark type: integer format: int32 Catchpoint.Symphony.REST.Api.DivisionUsageStatistics: type: object properties: divisionId: type: integer format: int32 consumerStatistics: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ConsumerStatistics' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.AlertHistoricalTimeThreshold: enum: - id: 5 name: Minutes5 - id: 10 name: Minutes10 - id: 15 name: Minutes15 - id: 30 name: Minutes30 - id: 60 name: Hour1 - id: 120 name: Hour2 - id: 360 name: Hour6 - id: 1440 name: Day1 - id: 10080 name: Week1 type: integer format: int32 Catchpoint.Symphony.Enums.DateTimes.WeekOfMonth: enum: - id: 0 name: First - id: 1 name: Second - id: 2 name: Third - id: 3 name: Fourth - id: 4 name: Fifth type: integer format: int32 Catchpoint.Symphony.Enums.Alerts.OperatorType: enum: - id: 0 name: NotEquals - id: 1 name: Equals - id: 2 name: GreaterThan - id: 3 name: GreaterThanOrEquals - id: 4 name: LessThan - id: 5 name: LessThanOrEquals - id: 6 name: NotBetween - id: 7 name: Between type: integer format: int32 Microsoft.AspNetCore.JsonPatch.Operations.Operation: type: object properties: value: nullable: true path: type: string nullable: true op: type: string nullable: true from: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.RequestSettingsAPIModel: type: object properties: requestSettingType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SettingsType' nonLibraryCertificate: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.CertificateModel' libraryCertificateIds: type: array items: type: integer format: int32 nullable: true tokenIds: type: array items: type: integer format: int32 nullable: true authentication: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.RequestAuthenticationAPIModel' httpHeaderRequests: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.HttpRequestHeaderAPIModel' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Test.DisplayTestFrequency: enum: - id: 0 name: None - id: 1 name: 1 Minute - id: 2 name: 5 Minutes - id: 3 name: 10 Minutes - id: 4 name: 15 Minutes - id: 5 name: 20 Minutes - id: 6 name: 30 Minutes - id: 7 name: 60 Minutes - id: 8 name: 2 Hours - id: 9 name: 3 Hours - id: 10 name: 4 Hours - id: 11 name: 6 Hours - id: 12 name: 8 Hours - id: 13 name: 12 Hours - id: 14 name: 24 Hours - id: 15 name: 4 Minutes - id: 16 name: 2 Minutes - id: 17 name: 3 Minutes - id: 18 name: Continuous - id: 19 name: 5 Seconds - id: 20 name: 10 Seconds - id: 21 name: 20 Seconds - id: 22 name: 30 Seconds type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse: type: object properties: folders: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' nullable: true hasMore: type: boolean nullable: true next: type: string nullable: true previous: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Models.InfoMessage: type: object properties: information: type: string nullable: true ignoredPath: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath' nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleIntervalApiModel: type: object properties: start: type: string nullable: true end: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.RecurringScheduleItemApiModel: type: object properties: scheduleIntervals: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleIntervalApiModel' nullable: true id: type: integer format: int32 scheduleId: type: integer format: int32 name: type: string nullable: true days: type: array items: $ref: '#/components/schemas/System.DayOfWeek' nullable: true weeks: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DateTimes.WeekOfMonth' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.ReportAlertType: enum: - id: 0 name: None - id: 1 name: Exits - id: 2 name: ByteLength - id: 3 name: ContentMatch - id: 4 name: HostFailure - id: 5 name: HttpHeaderMatch - id: 6 name: TagFailure - id: 7 name: ResponseTime - id: 8 name: Traffic - id: 9 name: PageFailure - id: 10 name: CustomTestData - id: 11 name: ScriptFailure - id: 12 name: Ping - id: 13 name: Requests - id: 14 name: ContentZone - id: 15 name: Availability - id: 16 name: Address - id: 17 name: Dns - id: 18 name: GlimpseCounter - id: 19 name: GlimpseRate - id: 20 name: Path - id: 21 name: Score - id: 22 name: Wifi - id: 23 name: Asn - id: 24 name: WebPageTest - id: 25 name: Endpoint - id: 26 name: ExperienceScore - id: 27 name: InternetWeather - id: 28 name: Ecn - id: 29 name: Tracing - id: 30 name: DivisionWide type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.FolderPostResponse: type: object properties: folder: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel' id: type: integer format: int32 nullable: true hasMore: type: boolean nullable: true next: type: string nullable: true previous: type: string nullable: true additionalProperties: false Catchpoint.Symphony.ViewModels.CertificateModel: required: - givenName - id type: object properties: id: type: integer format: int32 changeDate: type: string format: date-time description: type: string nullable: true divisionId: type: integer format: int32 objectId: type: integer format: int64 nullable: true objectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' name: type: string nullable: true statusType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DomainStatus' passphrase: type: string nullable: true passwordStatus: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.PasswordStatusType' file: type: string nullable: true base64File: type: string nullable: true givenName: minLength: 1 type: string isLibraryCertificate: type: boolean changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' contacts: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.CertificateContactModel' nullable: true contactGroups: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.CertificateContactGroupModel' nullable: true associatedCertificates: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.AssociatedCertificateModel' nullable: true restrictContactAccess: type: boolean access: type: string nullable: true readOnly: true passphraseUpdated: type: string nullable: true labels: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.LabelKeyModel' nullable: true labelsForChangeLog: type: array items: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemAPIModel: required: - alertType - nodeThreshold - trigger type: object properties: instruction: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertInstructionsAPIModel' nodeThreshold: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertNodeThresholdAPIModel' notificationGroups: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NotificationGroupAPIModel' nullable: true trigger: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertTriggerAPIModel' id: type: integer format: int32 alertGroupId: type: integer format: int32 notificationType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.NotificationType' alertType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.ReportAlertType' alertSubType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.ReportAlertSubtype' syntheticMetric: type: integer format: int32 nullable: true enforceTestFailure: type: boolean nullable: true omitScatterplot: type: boolean nullable: true matchAllRecords: type: boolean nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.ScheduleSettingsAPIModel: type: object properties: scheduleSettingType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SettingsType' frequency: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.DisplayTestFrequency' roundRobinAmount: type: integer format: int32 nullable: true runScheduleId: type: integer format: int32 nullable: true maintenanceScheduleId: type: integer format: int32 nullable: true testNodeDistribution: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.NodeDistribution' networkType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType' nodes: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel' nullable: true nodeGroups: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel' nullable: true runScheduleInfo: type: string nullable: true id: type: integer format: int64 nullable: true maintenanceScheduleInfo: type: string nullable: true maintenanceSchedule: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleApiModel' additionalProperties: false Catchpoint.Symphony.Enums.Test.WebRequestHeaderType: enum: - id: 0 name: None - id: 1 name: UserAgent - id: 2 name: Accept - id: 3 name: AcceptEncoding - id: 4 name: AcceptLanguage - id: 5 name: AcceptCharSet - id: 6 name: Cookie - id: 7 name: CacheControl - id: 8 name: Connection - id: 9 name: Pragma - id: 10 name: Referer - id: 11 name: Custom - id: 12 name: Host - id: 13 name: RequestOverride - id: 14 name: DnsOverride - id: 15 name: RequestBlock - id: 16 name: RequestDelay - id: 17 name: DnsResolverOverride type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.RecipientAPIModel: type: object properties: id: type: integer format: int32 firstName: type: string nullable: true lastName: type: string nullable: true email: type: string nullable: true recipientType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.RecipientType' name: type: string nullable: true readOnly: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.RecipientType: enum: - id: 0 name: Contact - id: 1 name: ContactGroup - id: 2 name: Email type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.NodeGroupAPIModel: type: object properties: id: type: integer format: int64 name: type: string nullable: true changeDate: type: string format: date-time description: type: string nullable: true syntheticNetworkType: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]' divisionId: type: integer format: int32 nullable: true nodesCount: type: integer format: int32 nullable: true nodes: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel' nullable: true nodeLocations: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeGroupItemApiModel' nullable: true additionalProperties: false Catchpoint.Symphony.ViewModels.LabelValueModel: type: object properties: id: type: integer format: int32 name: type: string nullable: true labelKeyId: type: integer format: int32 associatedLabelValues: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.AssociatedLabelValueModel' nullable: true labelName: type: string nullable: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' additionalProperties: false Catchpoint.Symphony.Enums.Alerts.NotificationType: enum: - id: 0 name: DefaultContacts - id: 1 name: DefaultAndAdditional - id: 2 name: DoNotNotify - id: 3 name: AdditionalContacts type: integer format: int32 Catchpoint.Symphony.Enums.PasswordStatusType: enum: - id: 0 name: None - id: 1 name: Set - id: 2 name: Update type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupAPIModel: type: object properties: alertSettingType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SettingsType' id: type: integer format: int32 nullable: true notificationGroup: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NotificationGroupAPIModel' alertGroupItems: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemAPIModel' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.ReminderFrequency: enum: - id: 0 name: None - id: 1 name: 1 Min - id: 5 name: 5 Min - id: 10 name: 10 Min - id: 15 name: 15 Min - id: 30 name: 30 Min - id: 60 name: 1 Hour - id: 1440 name: Daily type: integer format: int32 Catchpoint.Symphony.REST.Api.Limit: type: object properties: minute: type: integer format: int32 hour: type: integer format: int32 day: type: integer format: int32 additionalProperties: false Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse]: type: object properties: data: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.FolderGetResponse' messages: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage' nullable: true errors: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel' nullable: true completed: type: boolean readOnly: true traceId: type: string nullable: true usageLimits: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics' additionalProperties: false Catchpoint.Symphony.ViewModels.AssociatedLabelValueModel: required: - id type: object properties: id: type: integer format: int32 objectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' objectId: type: integer format: int64 nullable: true labelValueId: type: integer format: int32 labelKeyId: type: integer format: int32 changeDate: type: string format: date-time changeContactId: type: integer format: int32 nullable: true createDate: type: string format: date-time createContactId: type: integer format: int32 nullable: true name: type: string nullable: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' additionalProperties: false Catchpoint.Symphony.Enums.Alerts.AlertInstructionType: enum: - id: 0 name: None - id: 1 name: Custom - id: 2 name: Template type: integer format: int32 Catchpoint.Symphony.Enums.Alerts.AlertTimeThresholdInterval: enum: - id: 0 name: Default - id: 1 name: 1 Minute - id: 5 name: 5 Minutes - id: 10 name: 10 Minutes - id: 15 name: 15 Minutes - id: 20 name: 20 Minutes - id: 30 name: 30 Minutes - id: 45 name: 45 Minutes - id: 60 name: 60 Minutes - id: 120 name: 2 Hours - id: 360 name: 6 Hours - id: 720 name: 12 Hours type: integer format: int32 Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]: type: object properties: id: type: integer format: int32 name: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.ScheduleApiModel: type: object properties: id: type: integer format: int32 divisionId: type: integer format: int32 nullable: true divisionName: type: string nullable: true name: type: string nullable: true lastUpdated: type: string format: date-time status: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]' scheduleType: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]' oneTimeScheduleItems: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.OneTimeScheduleItemApiModel' nullable: true recurringScheduleItems: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.RecurringScheduleItemApiModel' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.SettingsType: enum: - id: 0 name: Inherit - id: 1 name: Override - id: 2 name: Inherit & Add - id: 3 name: No Settings type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeGroupItemApiModel: type: object properties: objectType: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]' nodesCount: type: integer format: int32 city: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]' country: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]' continent: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Utility.IdNameModel`1[System.Int32]' additionalProperties: false Catchpoint.Symphony.Enums.Orchestra.TestReportMetricDataType: enum: - id: 0 name: Counter - id: 1 name: Average - id: 2 name: Median - id: 3 name: StandardDeviation - id: 4 name: Min - id: 5 name: Max - id: 6 name: GeometricMean - id: 7 name: Percentile95 - id: 8 name: Percentile85 - id: 9 name: Histogram - id: 10 name: BoxPlot - id: 11 name: Apdex - id: 12 name: WeightedCounter - id: 13 name: WeightedAverage - id: 14 name: InterQuartileRange - id: 15 name: Percentile75 - id: 16 name: Percentile99 - id: 17 name: GeometricStandardDeviation - id: 18 name: PercentileCustom - id: 19 name: Percentile25 - id: 20 name: RateHistogram - id: 21 name: Total - id: 22 name: CumulativeDistributionFunction - id: 23 name: ApdexPercentileSatisfied - id: 24 name: ApdexPercentileTolerating - id: 25 name: ApdexPercentileFrustrated - id: 26 name: ApdexPercentileNotFrustrated - id: 27 name: TraceRouteGraph - id: 28 name: UniqueCounter - id: 29 name: ChangeDetection - id: 30 name: MostRecentValue - id: 31 name: Percentage - id: 32 name: LeastRecentValue type: integer format: int32 Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType: enum: - id: 0 name: Backbone - id: 1 name: LastMile - id: 2 name: Wireless - id: 3 name: Private - id: 4 name: Enterprise - id: 5 name: PublicCloud - id: 6 name: Any - id: 7 name: Bgp - id: 8 name: WebPageTest - id: 9 name: Enterprise Branch type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel: type: object properties: id: type: integer format: int64 name: type: string nullable: true networkType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType' status: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]' ipAddress: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertNodeThresholdAPIModel: type: object properties: id: type: integer format: int64 readOnly: true name: type: string nullable: true readOnly: true nodeThresholdType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Alerts.NodeThresholdType' numberOfFailingUnits: type: integer format: int64 nullable: true numberOfUnits: type: integer format: int64 nullable: true consecutiveRuns: type: integer format: int32 nullable: true consecutiveRunsEnabled: type: boolean utilizePerNodeHistoricalAverage: type: boolean percentageOfUnits: type: number format: float nullable: true singleNodeCellsCountDuringSingleRun: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Test.NodeDistribution: enum: - id: 0 name: Random - id: 1 name: Concurrent - id: 2 name: Even type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.RequestAuthenticationAPIModel: type: object properties: authenticationMethodType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.AuthenticationMethodType' passwordStatus: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.PasswordStatusType' userName: type: string nullable: true password: type: string nullable: true id: type: integer format: int64 passwordIds: type: array items: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightsAPIModel: type: object properties: insightSettingType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SettingsType' indicators: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel' nullable: true tracepoints: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel' nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.AlertTriggerType: enum: - id: 0 name: None - id: 1 name: SpecificValue - id: 2 name: TrailingValue - id: 3 name: TrendShift type: integer format: int32 Catchpoint.Symphony.Enums.Test.DisplayMonitorType: enum: - id: 0 name: IE - id: 1 name: RealUser - id: 2 name: HTTP - id: 3 name: Emulated - id: 5 name: Mqtt - id: 6 name: Imap - id: 7 name: Ntp - id: 8 name: Ping ICMP - id: 9 name: Traceroute ICMP - id: 10 name: DnsTrace - id: 11 name: PingTcp - id: 12 name: DnsExperience - id: 13 name: DnsDirect - id: 14 name: TraceRouteUdp - id: 15 name: Tcp - id: 16 name: Ftp - id: 17 name: ApiSummary - id: 18 name: Chrome - id: 19 name: Playback - id: 20 name: MobilePlayback - id: 21 name: Smtp - id: 22 name: TcpUdp - id: 23 name: PingUdp - id: 24 name: Streaming - id: 25 name: Api - id: 26 name: Mobile - id: 28 name: Ssh - id: 29 name: TraceRouteTcp - id: 30 name: WebSocket - id: 31 name: Ssl - id: 32 name: Wifi - id: 33 name: ShellScript - id: 34 name: Bgp - id: 35 name: TraceRouteSack - id: 36 name: M-Lab Bandwidth - id: 37 name: WebPageTest - id: 39 name: Edge - id: 40 name: Nprobe - id: 41 name: BgpBasic - id: 42 name: TracerouteQUIC - id: 43 name: NProbeRFactor type: integer format: int32 Catchpoint.Symphony.Enums.TestFolderType: enum: - id: 1 name: Synthetic - id: 2 name: WPT - id: 3 name: Big Query - id: 4 name: Cloud Spanner - id: 5 name: Cloud Storage - id: 6 name: Compute Engine type: integer format: int32 Catchpoint.Symphony.REST.Api.ApiUsageStatistics: type: object properties: clientId: type: integer format: int64 lastRequestTimestamp: type: string format: date-time limits: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit' runs: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit' exceededMessage: type: string nullable: true readOnly: true divisionUsageStatistics: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.DivisionUsageStatistics' nullable: true additionalProperties: false Catchpoint.Symphony.ViewModels.CertificateContactGroupModel: required: - certificateDataId - contactGroupId type: object properties: certificateDataId: type: integer format: int32 contactGroupId: type: integer format: int32 contactGroupName: type: string nullable: true createContactId: type: integer format: int32 nullable: true createDate: type: string format: date-time id: type: integer format: int32 name: type: string nullable: true readOnly: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' additionalProperties: false Catchpoint.Symphony.Enums.Alerts.ReportAlertSubtype: enum: - id: 0 name: None - id: 1 name: Byte Length - id: 2 name: Page - id: 3 name: File Size - id: 9 name: Test Failure - id: 10 name: Regular Expression - id: 11 name: Compare to Previous - id: 12 name: Compare to File - id: 13 name: Response Code - id: 14 name: Response Code - id: 15 name: Response Headers - id: 16 name: MAC Address - id: 20 name: Any - id: 21 name: DNS - id: 22 name: Connection - id: 23 name: Response - id: 30 name: Connection - id: 31 name: Content Type - id: 32 name: Custom - id: 33 name: Encoding - id: 34 name: Redirect - id: 35 name: Version - id: 40 name: Unknown - id: 41 name: Iframes - id: 42 name: Images - id: 43 name: Style Sheets - id: 44 name: Scripts - id: 45 name: XMLHttpRequest - id: 50 name: DNS - id: 51 name: Connect - id: 52 name: Send - id: 53 name: Wait - id: 54 name: Load - id: 55 name: TTFB - id: 56 name: Page Load - id: 57 name: Content Load - id: 58 name: Response - id: 59 name: Test Time - id: 60 name: DO NOT USE - id: 61 name: DOM Load - id: 62 name: Perceived Page Load - id: 63 name: Test Time with Suspect - id: 64 name: Server Response - id: 65 name: Delete - id: 66 name: Document Complete - id: 67 name: Redirect - id: 68 name: SSL - id: 70 name: Page Views - id: 71 name: Unique Visits - id: 72 name: Unique User - id: 80 name: Any - id: 81 name: DNS - id: 82 name: Connection - id: 83 name: Response - id: 84 name: SSL - id: 85 name: Other - id: 90 name: Tracepoints - id: 91 name: Indicators - id: 100 name: Ping RTT - id: 101 name: Ping Packet Loss - id: 102 name: Ping Jitter - id: 110 name: '# Requests' - id: 111 name: '# Hosts' - id: 112 name: '# Connections' - id: 113 name: '# Redirects' - id: 114 name: '# Other' - id: 115 name: '# Images' - id: 116 name: '# Scripts' - id: 117 name: '# HTML' - id: 118 name: '# CSS' - id: 119 name: '# XML' - id: 120 name: '# Flash' - id: 121 name: '# Media' - id: 130 name: Page Response - id: 131 name: Bottleneck Time - id: 132 name: '% Bottleneck' - id: 133 name: '# Requests' - id: 134 name: '# Failures' - id: 135 name: Byte Length - id: 136 name: Self Downloaded Bytes - id: 137 name: '% Self Bottleneck' - id: 138 name: '% Third Party Bottleneck' - id: 140 name: Test - id: 141 name: Content - id: 142 name: '% Downtime' - id: 143 name: Reachability - id: 150 name: Test URL - id: 151 name: Child URLs - id: 152 name: Any URLs - id: 160 name: DNS General - id: 161 name: DNS Answer - id: 162 name: DNS Authority - id: 163 name: DNS Additional - id: 170 name: Page Views - id: 171 name: Bounces - id: 172 name: DNS Additional - id: 173 name: Visits - id: 180 name: Bounce Rate - id: 181 name: Conversion Rate - id: 190 name: '# Cities' - id: 191 name: '# ASNs' - id: 192 name: Speed Index - id: 193 name: '# Countries' - id: 194 name: '# Hops' - id: 195 name: Handshake Time - id: 196 name: Days to Expiration - id: 200 name: Signal Quality - id: 201 name: Signal Strength - id: 210 name: Origin AS - id: 211 name: Path AS - id: 212 name: Origin Neighbor - id: 213 name: Prefix Mismatch - id: 220 name: Endpoint Experience Score - id: 230 name: Internet Sonar Benchmark Incidents - id: 233 name: Internet Sonar Isp incidents - id: 240 name: Tracing Response Time - id: 241 name: Tracing Request - id: 242 name: Tracing Errors - id: 243 name: Tracing Score - id: 250 name: Division Wide Node Run Rate - id: 251 name: Division Wide Node Utilization Capacity - id: 252 name: Division Wide Complex Alert - id: 254 name: Division Wide Node Offline Status - id: 255 name: Division Wide Node Utilization Cpu - id: 256 name: Division Wide Node Utilization Disk - id: 257 name: Division Wide Node Utilization Memory type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupItemFilterAPIModel: type: object properties: id: type: integer format: int64 status: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DomainStatus' alertGroupItemId: type: integer format: int32 filterType: type: integer format: int32 nullable: true filterValues: type: array items: type: string nullable: true tracepointId: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.FolderAPIModel: required: - divisionId - name - productId type: object properties: id: type: integer format: int32 parentId: maximum: 2147483647 minimum: 1 type: integer format: int32 nullable: true divisionId: maximum: 2147483647 minimum: 1 type: integer format: int32 productId: maximum: 2147483647 minimum: 1 type: integer format: int32 folderId: maximum: 2147483647 minimum: 1 type: integer format: int32 nullable: true name: maxLength: 128 minLength: 0 type: string testFolderTypeId: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.TestFolderType' advancedSettings: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.AdvancedSettingsAPIModel' requestSetting: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.RequestSettingsAPIModel' scheduleSetting: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.ScheduleSettingsAPIModel' alertGroupId: type: integer format: int32 nullable: true alertGroup: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Alert.AlertGroupAPIModel' insights: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightsAPIModel' additionalProperties: false Catchpoint.Symphony.ViewModels.MessageModel: type: object properties: id: type: string nullable: true message: type: string nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.AdvancedSettingsAPIModel: type: object properties: advancedSettingType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.SettingsType' id: type: integer format: int64 nullable: true appliedTestFlags: type: array items: $ref: '#/components/schemas/TestFlag' nullable: true filmstripFrequency: type: integer format: int32 nullable: true waitForNoActivity: type: integer format: int32 nullable: true maxStepRuntimeSecOverride: type: integer format: int32 nullable: true testBandwidthThrottling: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.BandwidthThrottling' viewportHeight: type: integer format: int32 nullable: true viewportWidth: type: integer format: int32 nullable: true ednsSubnet: type: string nullable: true clientId: type: string nullable: true matchSelfZoneBy: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.SelfZoneMatchingOptions' matchSelfZoneCriteria: type: string nullable: true additionalMonitor: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.DisplayMonitorType' failureHopCount: type: integer format: int32 nullable: true pingCount: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Alerts.AlertGroupItemFilterType: enum: - id: 0 name: None - id: 1 name: Index - id: 2 name: Name - id: 3 name: Address - id: 4 name: Any - id: 5 name: Destination - id: 6 name: CompositeTest - id: 7 name: CompositeFolder - id: 8 name: CompositeProduct - id: 9 name: CompositeAlertType - id: 10 name: CompositeAlertSubType type: integer format: int32 Catchpoint.Symphony.Enums.Test.InsightContentType: enum: - id: 0 name: Number - id: 2 name: Counter - id: 4 name: Second - id: 5 name: MicroSecond type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.NotificationGroupAPIModel: required: - recipients - subject type: object properties: subject: minLength: 1 type: string notifyOnWarning: type: boolean nullable: true notifyOnCritical: type: boolean nullable: true notifyOnImproved: type: boolean nullable: true alertWebhooks: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.AlertWebhookAPIModel' nullable: true recipients: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.RecipientAPIModel' id: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Test.APIInsightType: enum: - id: 0 name: Tracepoint - id: 1 name: Indicator type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.Schedules.OneTimeScheduleItemApiModel: type: object properties: id: type: integer format: int32 scheduleId: type: integer format: int32 name: type: string nullable: true startTime: type: string format: date-time nullable: true endTime: type: string format: date-time nullable: true additionalProperties: false Catchpoint.Symphony.Enums.Test.AuthenticationMethodType: enum: - id: 0 name: None - id: 1 name: Basic - id: 2 name: Digest - id: 3 name: Ntlm - id: 4 name: Plain - id: 5 name: Login - id: 6 name: Cram_MD5 - id: 7 name: Negotiate - id: 8 name: WPTScript type: integer format: int32 Catchpoint.Symphony.Enums.ObjectType: enum: - id: 0 name: None - id: 1 name: Language String - id: 2 name: User Access - id: 3 name: Machine - id: 4 name: Partition - id: 5 name: System - id: 6 name: Application Parameter - id: 7 name: ApplicationMachine - id: 8 name: ApplicationMachineParameter - id: 9 name: UserRole - id: 10 name: UserRolePermission - id: 11 name: Contact - id: 12 name: Contact Group - id: 13 name: ContactGroupItem - id: 14 name: UserFilter - id: 15 name: RestrictedIPAccess - id: 16 name: Reseller - id: 17 name: Client - id: 18 name: Division - id: 19 name: Schedule - id: 20 name: Schedule Item - id: 21 name: Test Location - id: 22 name: Test Location Group - id: 23 name: SyntheticLocationGroupItem - id: 24 name: AlertTemplate - id: 25 name: AlertTemplateMessage - id: 26 name: Alert Group - id: 27 name: Alert Group Item - id: 28 name: Product - id: 29 name: ProductSubDomain - id: 30 name: Folder - id: 31 name: Category - id: 32 name: Test - id: 33 name: TestTransactionStep - id: 34 name: TestCategory - id: 35 name: Notification Group - id: 36 name: Associated Request Header - id: 37 name: Alert Type - id: 38 name: Alert Subtype - id: 39 name: NotificationGroupEmail - id: 40 name: Country - id: 41 name: CountryState - id: 42 name: Permission - id: 43 name: ChartTemplate - id: 44 name: SyntheticPopulation - id: 45 name: InstantTest - id: 46 name: InstantTestItem - id: 47 name: Incident - id: 48 name: IncidentAlertNotification - id: 49 name: DivisionInsight - id: 50 name: Indicator - id: 51 name: Tracepoint - id: 52 name: CustomReportRequest - id: 53 name: InvalidTestReportDataInterval - id: 54 name: Apdex Threshold - id: 55 name: DivisionHost - id: 56 name: FreeUser - id: 57 name: OutclipWebsite - id: 58 name: OutclipSnippet - id: 59 name: WaterfallTemplate - id: 60 name: FreeTest - id: 61 name: LightCustomReportTemplate - id: 62 name: LightCustomReportTemplateField - id: 63 name: LightCustomReportRequest - id: 64 name: LightCustomReportRequestFilter - id: 65 name: DivisionApi - id: 66 name: BusinessContract - id: 67 name: Zone - id: 68 name: HostCollectionBlacklist - id: 69 name: Zone Rule - id: 70 name: TestMiniHar - id: 71 name: SavedChart - id: 72 name: SavedChartFilter - id: 73 name: ApdexFrustrationRatio - id: 74 name: GlimpseSitePackage - id: 75 name: GlimpseSite - id: 76 name: Page Group - id: 77 name: Variation - id: 78 name: BusinessLicenseContract - id: 79 name: AssociatedGlimpseLicense - id: 80 name: DivisionLicenses - id: 81 name: PullApiConsumer - id: 82 name: RouterHostPattern - id: 83 name: RouterHost - id: 84 name: ApiPushTemplate - id: 85 name: Dashboard - id: 86 name: Widget - id: 87 name: DashboardWidget - id: 88 name: DashboardPublicLink - id: 89 name: Benchmark Index - id: 90 name: Browser - id: 91 name: DomainGlobal - id: 92 name: OrganizationGlobal - id: 93 name: InternetServiceProviderGlobal - id: 94 name: Continent - id: 95 name: CountryStateCity - id: 96 name: NetworkSpeed - id: 97 name: Os - id: 98 name: MobileDevice - id: 99 name: Certificate - id: 100 name: Alert Webhook - id: 101 name: SyntheticMonitorSet - id: 102 name: SyntheticMonitorPackage - id: 103 name: SavedChartField - id: 104 name: GlobalVariable - id: 105 name: PullApiUsage - id: 106 name: File - id: 107 name: MachineHardwareType - id: 108 name: MachineOperatingSystemFlavor - id: 109 name: MachineVirtualizationType - id: 110 name: InternetServiceProvider - id: 111 name: City - id: 112 name: ContactTestAccessRestriction - id: 113 name: PricingModel - id: 114 name: Visualization - id: 115 name: Facility - id: 116 name: Storage - id: 117 name: DataView - id: 118 name: IdentityProvider - id: 119 name: Assertions - id: 120 name: Alert Group Item Filter - id: 121 name: DataViewDimension - id: 122 name: DataViewMetric - id: 123 name: AssociatedApplicationVersion - id: 124 name: CaptureServerSyntheticPopulation - id: 125 name: BandwidthThrottleSettings - id: 126 name: AlertInstruction - id: 127 name: AssociatedModel - id: 128 name: Model - id: 129 name: GlimpseProvider - id: 130 name: Integration - id: 131 name: IntegrationType - id: 132 name: SLAPurgeItem - id: 133 name: IntegrationGroup - id: 134 name: Associated Advanced Settings - id: 135 name: EnterpriseInstanceLicense - id: 136 name: InstanceDnsRecord - id: 137 name: VisualizationScript - id: 138 name: GlimpseEvent - id: 139 name: SyntheticInstanceRejected - id: 140 name: PointsAllocation - id: 141 name: GlimpseProviderType - id: 142 name: ApplicationVersion - id: 143 name: ApplicationType - id: 144 name: ApplicationCheck - id: 145 name: PerformanceReport - id: 146 name: Regex Association - id: 147 name: GlimpseSonarEntity - id: 148 name: GlimpseSonarGroup - id: 149 name: TestTemplateStatusType - id: 150 name: TestTypeSchema - id: 151 name: TestTemplate - id: 152 name: Template Field - id: 153 name: Associated Test Template Parameter - id: 154 name: TestTemplateApplicationGroup - id: 155 name: Associated Restricted Test Template - id: 156 name: Label - id: 157 name: LabelValue - id: 158 name: Associated Label Value - id: 159 name: Endpoint Location - id: 160 name: Endpoint Device - id: 161 name: SonarBusinessContract - id: 162 name: TestModuleDisplayPreferences - id: 163 name: Smartboard - id: 164 name: Component - id: 165 name: SmartboardComponent - id: 166 name: AssociatedBenchmarkIndex - id: 167 name: BgpPeer - id: 168 name: SmartboardFolder - id: 169 name: EndpointInstantTest - id: 170 name: Endpoint Scheduled Test - id: 171 name: GlimpseSonarNetworkDevice - id: 172 name: GeographyIpAddressLocationOverride - id: 173 name: Favorite Chart - id: 174 name: WptApiKey - id: 175 name: QuickChart - id: 176 name: Custom Visualization - id: 177 name: EndpointInstantTestItem - id: 178 name: WptBusinessContract - id: 179 name: WptFolder - id: 180 name: WptScheduleInterval - id: 181 name: WptDeviceType - id: 182 name: WptBrowserType - id: 183 name: WptConnectionType - id: 184 name: WptDevice - id: 185 name: Authentication - id: 186 name: AuthenticationContact - id: 187 name: Spotlight - id: 188 name: EndpointEmployeeApp - id: 189 name: Service Level Objective - id: 190 name: ASN - id: 191 name: Associated Service Level Objective - id: 192 name: System Service - id: 193 name: InternetWeatherConfig - id: 194 name: InternetServiceOverride - id: 195 name: InternetWeatherContract - id: 196 name: InternetWeatherAlert - id: 197 name: WptInstantTest - id: 198 name: Custom Service - id: 199 name: Mapped Service - id: 200 name: Test Suite - id: 201 name: LocationFromRtt - id: 202 name: IsDownIncident - id: 203 name: Tracing Contract - id: 204 name: InternetServiceRegion - id: 205 name: TracingSystem - id: 206 name: TracingService - id: 207 name: RumMobileApp - id: 208 name: Associated Benchmark Test - id: 209 name: BgpPrivatePeer - id: 210 name: AssociatedInternetWeatherServicePoint - id: 211 name: BenchmarkApp - id: 212 name: InternetSonarPointPricing - id: 213 name: Benchmark Test - id: 214 name: ClickHouseCluster - id: 215 name: Destination Url - id: 216 name: StackMap - id: 217 name: EarthView - id: 218 name: HeartbeatProduct - id: 219 name: HeartbeatTest - id: 220 name: EndpointAlertGroupItem - id: 221 name: ProxyConfig - id: 222 name: CompositeAlertGroup - id: 223 name: Scope type: integer format: int32 Catchpoint.Symphony.Enums.Alerts.NodeThresholdType: enum: - id: 0 name: Runs - id: 1 name: AverageAcrossNodes - id: 2 name: Node type: integer format: int32 Catchpoint.Symphony.REST.Common.Response.v2_0.HttpRequestHeaderAPIModel: type: object properties: requestValue: type: string nullable: true requestHeaderType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.WebRequestHeaderType' headerName: type: string nullable: true childHostPattern: type: string nullable: true additionalProperties: false System.DayOfWeek: enum: - id: 0 name: Sunday - id: 1 name: Monday - id: 2 name: Tuesday - id: 3 name: Wednesday - id: 4 name: Thursday - id: 5 name: Friday - id: 6 name: Saturday type: integer format: int32 Catchpoint.Symphony.Enums.Alerts.DnsTraceType: enum: - id: 0 name: None - id: 1 name: A - id: 2 name: NS - id: 3 name: MD - id: 4 name: MF - id: 5 name: CNAME - id: 6 name: SOA - id: 7 name: MB - id: 8 name: MG - id: 9 name: MR - id: 10 name: 'NULL' - id: 11 name: WKS - id: 12 name: PTR - id: 13 name: HINFO - id: 14 name: MINFO - id: 15 name: MX - id: 16 name: TXT - id: 17 name: RP - id: 18 name: AFSDB - id: 19 name: X25 - id: 20 name: ISDN - id: 21 name: RT - id: 22 name: NSAP - id: 23 name: NSAPPTR - id: 24 name: SIG - id: 25 name: KEY - id: 26 name: PX - id: 27 name: GPOS - id: 28 name: AAAA - id: 29 name: LOC - id: 30 name: NXT - id: 31 name: EID - id: 32 name: NIMLOC - id: 33 name: SRV - id: 34 name: ATMA - id: 35 name: NAPTR - id: 36 name: KX - id: 37 name: CERT - id: 38 name: A6 - id: 39 name: DNAME - id: 40 name: SINK - id: 41 name: OPT - id: 42 name: APL - id: 43 name: DS - id: 44 name: SSHFP - id: 45 name: IPSECKEY - id: 46 name: RRSIG - id: 47 name: NSEC - id: 48 name: DNSKEY - id: 49 name: DHCID - id: 50 name: NSEC3 - id: 51 name: NSEC3PARAM - id: 55 name: HIP - id: 64 name: SVCB - id: 65 name: HTTPS - id: 99 name: SPF - id: 100 name: UINFO - id: 101 name: UID - id: 102 name: GID - id: 103 name: UNSPEC - id: 249 name: TKEY - id: 250 name: TSIG - id: 32768 name: TA - id: 32769 name: DLV - id: 32770 name: AorAAAA type: integer format: int32 Catchpoint.Symphony.Enums.Test.SelfZoneMatchingOptions: enum: - id: 0 name: TestUrl - id: 1 name: Wildcard - id: 2 name: Regex type: integer format: int32 Catchpoint.Symphony.ViewModels.LabelKeyModel: type: object properties: id: type: integer format: int32 name: type: string nullable: true labelValues: type: array items: $ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.LabelValueModel' nullable: true color: type: string nullable: true changeLogObjectType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.ObjectType' objectId: type: integer format: int64 nullable: true additionalProperties: false Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel: type: object properties: id: type: integer format: int32 nullable: true name: type: string nullable: true statusType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.DomainStatus' insightType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.APIInsightType' token: type: string nullable: true httpSection: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.InsightSourceType' matchHeaderKey: type: boolean nullable: true format: type: string nullable: true includeChildren: type: boolean nullable: true isJsonFormat: type: boolean nullable: true contentType: $ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.InsightContentType' glimpseSiteId: type: integer format: int32 nullable: true additionalProperties: false Catchpoint.Symphony.Enums.DomainStatus: enum: - id: 0 name: Active - id: 1 name: Inactive - id: 2 name: Archived - id: 3 name: Suspended - id: 4 name: SuspendedByAdmin - id: 5 name: Open - id: 6 name: Resolved - id: 7 name: Deleted - id: 8 name: OverSubscribed - id: 9 name: Published - id: 10 name: Draft - id: 11 name: NeedsApproval type: integer format: int32 securitySchemes: bearer: type: http scheme: bearer bearerFormat: JWT