openapi: 3.0.0 info: title: Alerts version: 2.0.0 description: Alerts API Documentation contact: name: OpsRamp Support email: support@opsramp.com url: 'https://www.opsramp.com/about-opsramp/contact-us/' tags: - name: alerts description: Alerts API Documentation. externalDocs: url: 'https://develop.opsramp.com/alerts/' servers: - url: 'https://api.opsramp.com' description: Partner - All Others - url: 'https://{subdomain}.api.opsramp.com' description: Partner or Client custom branded sub-domain variables: subdomain: default: demo description: Custom sub-domain assigned to the client paths: '/api/v2/tenants/{clientId}/alerts': summary: Create Alerts on Resources description: |- Creates multiple alerts on resources of the client. A list of event IDs is generated when alerts are created. This list is valid for 30 days. Use the event IDs to search and get alert details. ### Notes - A list of event IDs is generated when alerts are created. - This list is valid for 30 days. Use the event IDs to search and get alert details. post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: string examples: example-multiple-alerts: value: - a6c952c1-2d2d-4c82-a16d-5870a2c7e4e6 - c1461bc2-eed5-4559-9d78-6ca6f35be8c5 - 3885d3fc-4e92-4a9d-871a-a5940cf7079b - 62b5d1c7-5e17-4027-9d9e-a8d566590468 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/alerted' examples: example-multiple-alerts: value: - serviceName: CPU device: hostName: Think-pad resourceUUID: DEV0000011767 providerUUID: '11767' systemUUID: '11767' macAddress: '2E:8B:EB:32:7A:F9' ipAddress: 172.2.229.109 subject: Test API Alert 1 for car alertTime: '2017-10-01T00:00:00+0000' currentState: CRITICAL app: OPSRAMP alertType: Maintenance component: C description: api call test monitorName: test - serviceName: CPU device: hostName: Think-pad-i5 resourceUUID: DEV0000011768 providerUUID: '11768' systemUUID: '11768' macAddress: '3B:5E:EB:52:3E:B5' ipAddress: 172.2.228.110 subject: Test API Alert 2 for car alertTime: '2017-10-02T00:00:00+0000' currentState: CRITICAL app: OPSRAMP alertType: Maintenance component: C description: api call test monitorName: test - serviceName: MEMORY resource: id: 5b850347-8798-45aa-9332-c7ff3dd1c60e subject: Test API Alert 1 for car alertTime: '2017-10-01T00:00:00+0000' currentState: CRITICAL app: OPSRAMP alertType: Maintenance component: C description: api call test monitorName: test - serviceName: MEMORY resource: extResourceId: '646438712529389643' ipAddress: 172.24.132.47 subject: The Physical Memory Usage on the device is 56% alertTime: '2018-11-02 10:52:55' currentState: CRITICAL alertType: Monitoring app: OPSRAMP component: MEMORY oldState: OK description: 'Api calls ' masterAgentUUID: 5b850347-8798-45aa-9332-c7ff3dd1c60e description: Provide either `device` or `resource` object. operationId: create_alerts parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alert': summary: Create Alert on a Resource description: |- Creates a single alert on a resource of the client. ### Notes - A list of event IDs is generated when alerts are created. This list is valid for 30 days. - Use the event IDs to search and get alert details. Creation of a new resource depends on the following: - A new resource is created and new device group, service group, and location are assigned. - A new resource is created and existing device group, service group, and location are assigned. - An already existing resource cannot be assigned to a new or existing Device Group, Service Group and Location. post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: string examples: example-single-alert: value: - c1461bc2-eed5-4559-9d78-6ca6f35be8c5 example-single-resource-alert: value: - 3885d3fc-4e92-4a9d-871a-a5940cf7079b example-single-cloud-resource-alert: value: - fa3245ca-6740-4f7a-bf06-02414c51595e example-single-alert-from-service: value: - 62b5d1c7-5e17-4027-9d9e-a8d566590468 requestBody: content: application/json: schema: $ref: '#/components/schemas/alerted' examples: example-single-alert: value: serviceName: CPU device: hostName: Think-pad resourceUUID: DEV0000011767 providerUUID: '11767' systemUUID: '11767' macAddress: '2E:8B:EB:32:7A:F9' ipAddress: 172.2.229.109 subject: Test API Alert for car alertTime: '2017-10-01T00:00:00+0000' currentState: CRITICAL app: OPSRAMP alertType: Maintenance component: C description: api calls monitorName: test example-single-resource-alert: value: serviceName: MEMORY resource: id: 5b850347-8798-45aa-9332-c7ff3dd1c60e subject: The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%. alertTime: '2018-11-02 10:52:55' currentState: CRITICAL alertType: Monitoring app: OPSRAMP component: MEMORY description: 'Api calls ' example-single-cloud-resource-alert: value: serviceName: MEMORY resource: extResourceId: '646438712529389643' ipAddress: 172.24.132.47 subject: The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%. alertTime: '2018-11-02 10:52:55' currentState: CRITICAL alertType: Monitoring app: OPSRAMP component: MEMORY description: 'Api calls ' masterAgentUUID: 5b850347-8798-45aa-9332-c7ff3dd1c60e example-single-alert-from-service: value: serviceName: CPU app: OPSRAMP resource: hostName: Think-pad resourceType: server tags: - environment: QA - department: R&D deviceGroups: - name: dg1 - name: dg2 serviceGroups: - name: sg1 - name: sg2 parent: id: SGP-a794d1de-e361-45ef-9d6e-4a450491bf35 location: name: San Jose subject: Performance Degradation on Windows Servers alertTime: '2019-07-12T00:00:00+0000' currentState: CRITICAL description: Provide either `device` or `resource` object. description: '' operationId: create_alert parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/alerts/{alertId}': summary: Get Alert Details description: | Gets client's alert details by alertId ### Notes - For an inference alert, resource name and client ID are provided in the response. - For an RCA alert, device ID, Name, and IP address are provided in the response.' get: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/alerted' examples: example-raw-alert: value: uniqueId: '93' subject: 'Disk c:\ Critical Used 90.31%; Free 9.69%; Disk Capacity 102642 MB. Threshold is 90%.' description: 'Disk c:\ is critical.(Crossed 90% usage). Total-102642 MB; Used-92700 MB (90.31%); Free-9942 MB (9.69%);' currentState: Critical oldState: Critical serviceName: Disk acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: true clientUniqueId: client_8 alertType: Obsolete app: OPSRAMP alertTime: '2016-07-24T10:40:47+0000' device: id: 253151d1-6b19-4158-9d91-050e7fb4dd8d name: res1 hostName: res1 ipAddress: 1.23.4.5 type: DEVICE aliasName: alias name resourceName: res name resourceType: Desktop resource: id: 253151d1-6b19-4158-9d91-050e7fb4dd8d hostName: res1 ipAddress: 1.23.4.5 type: Desktop aliasName: alias name name: check code resourceName: res name consoles: [] resourceType: Desktop frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 days: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 repeatCount: '2' tenantId: 8 status: Ticketed priority: N/A elapsedTimeString: '64d 59m ' createdDate: '2016-07-24T10:40:47+0000' updatedTime: '2016-07-24T10:40:50+0000' rba: false tenantName: Brocade Lab managedByOpsRamp: false incidentId: INC0000000093 actedTs: 0 eventType: ALERT metric: Disk inferenceId: 0 statusHistory: createdBy: system createdTime: '2016-07-24T10:40:47+0000' ticketedBy: 'opsramp_system_user ' ticketedTime: '2016-07-24T10:41:47+0000' example-inference-alert: value: uniqueId: '3511' subject: Inference test description: Inference test currentState: Ok oldState: Critical serviceName: Disk acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: false clientUniqueId: client_12 alertType: MONITORING app: OPSRAMP component: b717911b-04ce-37ce-9af8-e2242813eaa3 alertTime: '2018-05-07T11:00:28+0000' resource: name: 2adc3-aiops type: CLIENT metaData: {} repeatCount: '2' tenantId: 12 status: New priority: N/A elapsedTimeString: '3d 20h 45m ' healedTimeString: '1h 54m ' createdDate: '2018-05-07T12:55:19+0000' updatedTime: '2018-05-07T12:55:19+0000' rba: false tenantName: 2adc3-aiops managedByOpsRamp: false actedTs: 0 eventType: INFERENCE inferenceId: 0 statusHistory: createdBy: system createdTime: '2018-05-07T12:55:19+0000' parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/alertId' '/api/v2/tenants/{tenantId}/alerts/event/{eventId}': summary: Get Alert Details by Event ID description: | Gets alert details of the client by eventId ### Notes - A list of event IDs is generated when alerts are created. - This list is valid for 30 days.. - Use the event IDs to search and get alert details. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: uniqueId: type: string subject: type: string description: type: string currentState: type: string oldState: type: string serviceName: type: string acknowledged: type: boolean suppressed: type: boolean permanentlySuppressed: type: boolean closed: type: boolean ticketed: type: boolean clientUniqueId: type: string alertType: type: string app: type: string alertTime: type: string format: date-time device: type: object properties: id: type: string name: type: string hostName: type: string ipAddress: type: string type: type: string aliasName: type: string resourceName: type: string resourceType: type: string resource: type: object properties: id: type: string hostName: type: string ipAddress: type: string type: type: string aliasName: type: string name: type: string resourceName: type: string consoles: type: array items: {} resourceType: type: string frequency: type: integer paused: type: boolean deleted: type: boolean validateSSL: type: boolean port: type: integer encrypted: type: boolean timeout: type: integer days: type: integer ts: type: integer clientId: type: integer locationOffset: type: integer totalLocations: type: integer receiverHostPort: type: integer repeatCount: type: string tenantId: type: integer status: type: string priority: type: string elapsedTimeString: type: string createdDate: type: string format: date-time updatedTime: type: string format: date-time rba: type: boolean tenantName: type: string managedByOpsRamp: type: boolean incidentId: type: string actedTs: type: integer eventType: type: string metric: type: string inferenceId: type: integer statusHistory: type: object properties: createdBy: type: string createdTime: type: string format: date-time ticketedBy: type: string ticketedTime: type: string format: date-time examples: example-event-details: value: uniqueId: '93' subject: 'Disk c:\ Critical. Used 90.31%; Free 9.69%; Disk Capacity 102642 MB. Threshold is 90%.' description: 'Disk c:\ is critical. (Crossed 90% usage). Total-102642 MB; Used-92700 MB (90.31%); Free-9942 MB (9.69%);' currentState: Critical oldState: Critical serviceName: Disk acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: true clientUniqueId: client_8 alertType: Obsolete app: OPSRAMP alertTime: '2016-07-24T10:40:47+0000' device: id: 253151d1-6b19-4158-9d91-050e7fb4dd8d name: res1 hostName: res1 ipAddress: 1.23.4.5 type: DEVICE aliasName: alias name resourceName: res name resourceType: Desktop resource: id: 253151d1-6b19-4158-9d91-050e7fb4dd8d hostName: res1 ipAddress: 1.23.4.5 type: Desktop aliasName: alias name name: check code resourceName: res name consoles: [] resourceType: Desktop frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 days: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 repeatCount: '2' tenantId: 8 status: Ticketed priority: N/A elapsedTimeString: '64d 59m ' createdDate: '2016-07-24T10:40:47+0000' updatedTime: '2016-07-24T10:40:50+0000' rba: false tenantName: Brocade Lab managedByOpsRamp: false incidentId: INC0000000093 actedTs: 0 eventType: ALERT metric: Disk inferenceId: 0 statusHistory: createdBy: system createdTime: '2016-07-24T10:40:47+0000' ticketedBy: 'opsramp_system_user ' ticketedTime: '2016-07-24T10:41:47+0000' description: '' parameters: - $ref: '#/components/parameters/tenantId' - schema: type: string in: path name: eventId required: true description: Raw event unique identifier '/api/v2/tenants/{tenantId}/alerts/search': summary: Search Alerts description: |- Filter and Search alerts of the tenant. ### Query String example usage - `queryString` is Query Parameter creates simple and complex filters - Basic filtering with no page limits. eg Filter all Critical Alerts - `{base-url}/api/v2/tenants//sites/search?queryString=states:CRITICAL,WARNING` - Filtering with page limits . eg Get 500 Suppressed alerts in the first page - `{base-url}/api/v2/tenants//alerts/search?pageSize=500&pageNo=1&sortName=id&isDescendingOrder=false&queryString=actions:SUPPRESSED` - Filtering with multiple conditions . eg Get 500 Ticketed alerts in the first page occured in between these dates in descending order - `{base-url}/api/v2/tenants//alerts/search?pageSize=500&pageNo=1&sortName=id&isDescendingOrder=false&queryString=actions:TICKETED%2BstartDate:2016-02-24T09:19:47%200000%2BendDate:2016-02-26T10:20:47%200000` - Incorrect usage of queryString - `/api/v2/tenants//alerts/search?pageSize=500&pageNo=1&sortName=id&isDescendingOrder=false&queryString=ticketed:True` - `ticketed` is a `value` here not an `query parameter attribute`, hence query fails - If the resultset has all the values irrespective of query, this would mean `failed query` like above example get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/alerted' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example_alerts: value: results: - uniqueId: '122620538' subject: workflow alert Validation For Maintenance schedule Using JM-vas currentState: Critical serviceName: Network2 problemArea: Network2 acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: false clientUniqueId: client_22568 alertType: Monitoring app: OpsRamp component: C alertTime: '2021-07-24T17:19:12+0000' device: id: '9297503' name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' type: DEVICE aliasName: '' resourceName: '' resourceType: Other resource: id: 336a5197-c8d8-46d0-9953-ebf95dd8046b hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' dns: '' type: Other state: active make: '' osName: '' description: '' source: ALERT agentInstalled: false status: UNDEFINED aliasName: '' tags: [] name: jmeter-pv-us-ctl-vm01 resourceName: '' generalInfo: name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 resourceType: Other resourcePath: Other resourceName: '' aliasName: '' createdTime: '2021-05-23T13:39:12+0000' updatedTime: '' assetManagedTime: '2021-05-23T13:39:12+0000' firstAssetManagedTime: '2021-05-23T13:39:12+0000' consoles: [] clientUniqueId: client_22568 resourceType: Other resourcePath: Other alternateIp: '' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 monitorName: Network2 repeatCount: '2' tenantId: 22568 status: New priority: N/A elapsedTimeString: '59m ' createdDate: '2021-07-24T17:19:13+0000' updatedTime: '2021-07-24T17:40:01+0000' rba: false tenantName: JMClient1605551845209 rtype: RESOURCE entityType: RESOURCE mspName: SQALab extAlertId: '' managedByOpsRamp: false actedTs: 0 metricTime: 0 eventType: ALERT inferenceId: 0 ignoreRecoveryNoise: false availability: false snoozeDuration: 0 metric: Network2 isRecoveryAlert: false inferenceAlert: false statusHistory: createdBy: system createdTime: '2021-07-24T17:19:13+0000' clientTechnology: OpsRamp customFields: [] - uniqueId: '122620193' subject: The Physical Memory Usage on the device is 56%.The Virtual Memory Usage on the device is 43%. currentState: Critical serviceName: MEMORY problemArea: MEMORY acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: false clientUniqueId: client_22568 alertType: Monitoring app: OpsRamp component: MEMORY alertTime: '2021-07-24T17:09:07+0000' device: id: '9297503' name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' type: DEVICE aliasName: '' resourceName: '' resourceType: Other resource: id: 336a5197-c8d8-46d0-9953-ebf95dd8046b hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' dns: '' type: Other state: active make: '' osName: '' description: '' source: ALERT agentInstalled: false status: UNDEFINED aliasName: '' tags: [] name: jmeter-pv-us-ctl-vm01 resourceName: '' generalInfo: name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 resourceType: Other resourcePath: Other resourceName: '' aliasName: '' createdTime: '2021-05-23T13:39:12+0000' updatedTime: '' assetManagedTime: '2021-05-23T13:39:12+0000' firstAssetManagedTime: '2021-05-23T13:39:12+0000' consoles: [] clientUniqueId: client_22568 resourceType: Other resourcePath: Other alternateIp: '' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 monitorName: MEMORY repeatCount: '1' tenantId: 22568 status: New priority: N/A elapsedTimeString: '1h 9m ' createdDate: '2021-07-24T17:09:07+0000' updatedTime: '2021-07-24T17:09:07+0000' rba: false tenantName: JMClient1605551845209 rtype: RESOURCE entityType: RESOURCE mspName: SQALab extAlertId: '' managedByOpsRamp: false actedTs: 0 metricTime: 0 eventType: ALERT inferenceId: 0 ignoreRecoveryNoise: false availability: false snoozeDuration: 0 metric: MEMORY isRecoveryAlert: false inferenceAlert: false statusHistory: createdBy: system createdTime: '2021-07-24T17:09:07+0000' clientTechnology: OpsRamp customFields: [] - uniqueId: '117891648' subject: workflow alert Validation For Maintenance schedule Using JM-vas currentState: Critical serviceName: Network2 problemArea: Network2 acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: false clientUniqueId: client_22568 alertType: Monitoring app: OpsRamp component: Test alertTime: '2021-05-23T13:39:11+0000' device: id: '9297503' name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' type: DEVICE aliasName: '' resourceName: '' resourceType: Other resource: id: 336a5197-c8d8-46d0-9953-ebf95dd8046b hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' dns: '' type: Other state: active make: '' osName: '' description: '' source: ALERT agentInstalled: false status: UNDEFINED aliasName: '' tags: [] name: jmeter-pv-us-ctl-vm01 resourceName: '' generalInfo: name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 resourceType: Other resourcePath: Other resourceName: '' aliasName: '' createdTime: '2021-05-23T13:39:12+0000' updatedTime: '' assetManagedTime: '2021-05-23T13:39:12+0000' firstAssetManagedTime: '2021-05-23T13:39:12+0000' consoles: [] clientUniqueId: client_22568 resourceType: Other resourcePath: Other alternateIp: '' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 monitorName: Network2 repeatCount: '11' tenantId: 22568 status: New priority: N/A elapsedTimeString: '62d 4h 39m ' createdDate: '2021-05-23T13:39:12+0000' updatedTime: '2021-05-23T16:44:40+0000' rba: false tenantName: JMClient1605551845209 rtype: RESOURCE entityType: RESOURCE mspName: SQALab extAlertId: '' managedByOpsRamp: false actedTs: 0 metricTime: 0 eventType: ALERT inferenceId: 0 ignoreRecoveryNoise: false availability: false snoozeDuration: 0 metric: Network2 isRecoveryAlert: false inferenceAlert: false statusHistory: createdBy: system createdTime: '2021-05-23T13:39:12+0000' clientTechnology: OpsRamp customFields: [] - uniqueId: '117898523' subject: test workflow alert Validation For Maintenance schedule Using JM-vas currentState: Critical serviceName: Network1 problemArea: Network1 acknowledged: false suppressed: false permanentlySuppressed: false closed: false ticketed: false clientUniqueId: client_22568 alertType: Monitoring app: OpsRamp component: Test alertTime: '2021-05-23T16:39:58+0000' device: id: '9297503' name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' type: DEVICE aliasName: '' resourceName: '' resourceType: Other resource: id: 336a5197-c8d8-46d0-9953-ebf95dd8046b hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' dns: '' type: Other state: active make: '' osName: '' description: '' source: ALERT agentInstalled: false status: UNDEFINED aliasName: '' tags: [] name: jmeter-pv-us-ctl-vm01 resourceName: '' generalInfo: name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 resourceType: Other resourcePath: Other resourceName: '' aliasName: '' createdTime: '2021-05-23T13:39:12+0000' updatedTime: '' assetManagedTime: '2021-05-23T13:39:12+0000' firstAssetManagedTime: '2021-05-23T13:39:12+0000' consoles: [] clientUniqueId: client_22568 resourceType: Other resourcePath: Other alternateIp: '' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 monitorName: Network1 repeatCount: '2' tenantId: 22568 status: New priority: N/A elapsedTimeString: '62d 1h 38m ' createdDate: '2021-05-23T16:39:58+0000' updatedTime: '2021-05-23T16:43:38+0000' rba: false tenantName: JMClient1605551845209 rtype: RESOURCE entityType: RESOURCE mspName: SQALab extAlertId: '' managedByOpsRamp: false actedTs: 0 metricTime: 0 eventType: ALERT inferenceId: 0 ignoreRecoveryNoise: false availability: false snoozeDuration: 0 processIds: - PROCESS_e1d7b813-4808-495a-a6b5-a4ed37507d97 metric: Network1 isRecoveryAlert: false inferenceAlert: false statusHistory: createdBy: system createdTime: '2021-05-23T16:39:58+0000' clientTechnology: OpsRamp customFields: [] totalResults: 4 orderBy: ts pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - $ref: '#/components/parameters/pageNo' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/isDescendingOrder' - $ref: '#/components/parameters/sortName' - $ref: '#/components/parameters/queryString' - schema: type: string in: query name: viewID - schema: type: string in: query name: statusHistory - $ref: '#/components/parameters/states' - schema: type: string in: query name: startDate description: 'Filter the alert with alert base. startDate denotes the from date. Example: 2016-02-24T09:19:47 0000 (GMT)' - schema: type: string in: query name: endDate description: 'endDate denotes to date. Example: 2016-02-26T10:20:47 0000 (GMT)' - schema: type: string in: query name: uniqueId description: uuid of the alert. - schema: type: string enum: - manage - unmanage example: manage in: query name: deviceStatus description: ' Status of the device' - schema: type: string in: query name: resourceType description: 'Type of resource. Example:LOAD_BALANCER, SQS, EBS, DEVICE, SNS, REDSHIFT, SERVICE' - schema: type: string in: query name: resourceIds description: 'ID of a resource. Example: DEV0000015754,148e892d-84ce-496c-a123-f91e1a8a3f7d.' - schema: type: string enum: - ACKNOWLEDGED - TICKETED - CLOSED - IGNORE - SUPPRESSED - OPEN - PURGED - CORRELATED example: OPEN in: query name: actions description: 'Actions performed on the alert. Example: ACKNOWLEDGED, TICKETED.' - $ref: '#/components/parameters/alertTypes' - schema: type: string in: query name: metrics description: 'Metric type of the alert. Example: PING, SNMP Response.' - schema: type: string in: query name: duration description: 'Duration of alert. Duration is represented in Number of Days Example: 1, 7.' - schema: type: string enum: - updated - created example: created in: query name: alertTimeBase description: 'Search for the alert based on the updated or created time of an alert. Example: updated.' - schema: type: string in: query name: clientIds description: 'ID of clients. Example: client_1, client_2,526674ad-be06-4bdc-9634-e3b8c78b906e. Separate the IDs with a comma.' - schema: type: string in: query name: ticketId description: 'ID of the ticket to which the alert is attached. Example: INC0000000001' - schema: type: string in: query name: apps description: ' Apps from which the alert is generated. Example: Email, Nagios' summary: '' operationId: alerts_search parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{clientId}/alerts/{alertId}/actions/{action}': summary: Post Action on an Alert description: | Client user action on an alert. ### Notes - When unacknowledge or unsuppress is specified, the alert status becomes either open or ticketed (if there is an incident ID associated with the alert). post: tags: - alerts requestBody: content: application/json: schema: type: object properties: description: type: string snoozeDuration: type: number examples: example-alert-action: value: description: close a ticket example-alert-suppress-snooze: value: description: suppress Alert snoozeDuration: 10 responses: '200': description: OK description: '' operationId: alert_policy_escalations_actions parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - name: action in: path required: true schema: type: string enum: - acknowledge - suppress - close - unAcknowledge - unSuppress - heal description: Supported actions on alert - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alerts/{alertId}/incidents/{incidentId}/attach': summary: Associate Incident to Alert description: Associate client's incident with a given alert. post: tags: - alerts responses: '200': description: OK requestBody: content: application/json: schema: type: object properties: status: type: string description: The incident status used to check the status of an incident. priority: type: string description: 'The incident priority: low, normal, high, urgent, and very low.' enum: - Low - Normal - Urgent - Very low toEmail: type: string description: The email address to receive incident notifications. assignedUser: type: object description: The designated user who is assigned to the incident. properties: id: type: string loginName: type: string customFields: type: array description: User-customized fields that can include additional information about an incident. Use the Get Incident Custom Fields API to get custom fields of an incident. items: type: object properties: id: type: string name: type: string value: type: string attachments: type: array description: Information related to the incident in base64 encoded format. items: type: object properties: name: type: string file: type: string examples: example-incident-alert: value: status: Resolved priority: Low toEmail: john.smith@domain.com assignedUser: id: USR0000002146 loginName: API-User-1 customFields: - id: UDF0000003790 name: External Id value: '2' - id: UDF0000003791 name: Incident History value: request custom field - text attachments: - name: 1.txt file: U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ= - name: 2.txt file: U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ= operationId: alert_incident_attach description: '' parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - schema: type: string in: path name: incidentId description: Incident unique Identifier required: true - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alerts/{alertId}/tickets/{ticketId}/update': summary: Update incident with alert ID description: Associate client's incident with a given alert. put: tags: - alerts responses: '200': description: OK summary: '' operationId: alert_ticket_update parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - name: ticketId in: path required: true schema: type: string format: uuid description: OpsRamp ITSM ticket unique identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alerts/{alertId}/occurrences': summary: List the Alerts Occurences triggered description: |- List all the alerts occurences triggered for the client in a given duration of an alert. ### The process for pagination The API provides the results in descending order of alert-triggered date. The latest alert appears first based on the alert-triggered time. The process for handling any number of occurrences include the following: 1. Get all occurrences of an alert. 2. Get alert occurrences of an alert that is triggered within a specific duration. 3. Traverse through each page of occurrences. ### Get All occurrences of an alert To fetch all alert occurrences irrespective of the alert-triggered time, provide the URI: ``` /tenants/{tenantId}/alerts/{alertId}/occurrences ``` ### Get Alert occurrences of an alert that is triggered within a specific duration To fetch raw alerts triggered within a specific duration, provide the start time and end time. To fetch raw alerts triggered between January 13th 2017 to February 13th 2017, provide the startTime of 2017-01-13T00:00:00 0000 and an endTime of 2016-02-13T00:00:00 0000. This is the URI for that request: ``` /tenants/{tenantId}/alerts/{alertId}/occurrences?queryString=startTime:2017-01-13T00:00:00 0000+endTime:2017-02-13T00:00:00 0000 ``` ### Traverse through each page of occurrences There is a limit of 100 results per page. If an alert has 120 occurrences, the latest 100 results will appear in the first page. To traverse to the second page, use the endDate from the first page and provide it as the endTime in the query string. The second page will return the remaining 20 alerts. get: tags: - alerts parameters: - schema: type: integer default: 100 in: query name: pageSize - schema: type: string in: query name: queryString responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: uniqueId: type: string subject: type: string description: type: string currentState: type: string createdTimeString: type: string format: date-time pageSize: type: integer nextPage: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time descendingOrder: type: boolean examples: example-alerts-occurences: value: results: - uniqueId: '7' subject: 'Event Source : McLogEvent / Id : 257' description: 'Source : McLogEvent Event ID : 257 Event Description : The scan of D:\setup\Projects\ITOM\build\war\WEB-INF\lib\fastutil-6.5.7.jar has taken too long to complete and is being canceled. Scan engine version used is 5900.7806 DAT version 8560.0000. Event Log Name : Application Event Log Type : INFORMATION Event Log Date Time : 06/16/2017 05:37:18.0' currentState: Critical createdTimeString: '2017-06-16T05:38:10+0000' - uniqueId: '7' subject: 'Event Source : McLogEvent / Id : 257' description: 'Source : McLogEvent Event ID : 257 Event Description : The scan of D:\setup\Projects\CSGRID\build\server\indexer\lib\aws-java-sdk-models-1.11.128.jar has taken too long to complete and is being canceled. Scan engine version used is 5900.7806 DAT version 8560.0000. Event Log Name : Application Event Log Type : INFORMATION Event Log Date Time : 06/16/2017 05:32:01.0' currentState: Critical createdTimeString: '2017-06-16T05:32:12+0000' - uniqueId: '7' subject: 'Event Source : McLogEvent / Id : 257' description: 'The following event has repeated 4 times in the last 4 minutes Source : McLogEvent Event ID : 257 Event Description : Blocked by port blocking rule (Anti-virus Standard Protection:Prevent mass mailing worms from sending mail). Event Log Name : Application Event Log Type : INFORMATION Event Log Date Time : 05/30/2017 06:00:03.0 ' currentState: Critical createdTimeString: '2017-05-30T06:03:50+0000' - uniqueId: '7' subject: 'Event Source : McLogEvent / Id : 257' description: 'The following event has repeated 2 times in the last 2 minutes Source : McLogEvent Event ID : 257 Event Description : Blocked by port blocking rule (Anti-virus Standard Protection:Prevent mass mailing worms from sending mail). Event Log Name : Application Event Log Type : INFORMATION Event Log Date Time : 05/29/2017 15:33:55.0' currentState: Critical createdTimeString: '2017-05-29T13:31:14+0000' pageSize: 100 nextPage: true startDate: '2017-06-16T05:38:10+0000' endDate: '2017-05-29T10:17:49+0000' descendingOrder: true operationId: create_occurences parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alertStatusHistory/{alertId}': summary: Get Alert Status History description: Gets client's alert status history. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: alertId: type: integer createdBy: type: string createdTime: type: string format: date-time acknowledgedBy: type: string acknowledgedTime: type: string suppressedBy: type: string suppressedTime: type: string format: date-time examples: example-alert-history: value: alertId: 2156 createdBy: system createdTime: '2019-04-02T14:27:55+0000' acknowledgedBy: superadmin acknowledgedTime: '2019-04-02T14:33:18+0000' suppressedBy: superadmin suppressedTime: '2019-04-02T14:33:59+0000' parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/alerts/{alertId}/comments': summary: Get Alert Comments description: Gets comments given by client on an alert. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: cumulativeAlertId: type: integer commentType: type: integer description: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string phoneNumber: type: string profileImage: type: object properties: logoPath: type: string thumbPath: type: string tinyThumbPath: type: string imageType: type: string createdDate: type: string format: date-time totalResults: type: integer pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean orderBy: type: string examples: example-alert-comments: value: results: - cumulativeAlertId: 289 commentType: 5 description: 'Partition : / Total : 17133.81MB Used : 11390.87MB Free : 4872.59MB' createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@gmail.com phoneNumber: 406-625-2345 profileImage: logoPath: 'https://yourdomain.com/images/users/1/profileImages/1.jpg?1469269179000' thumbPath: 'https://yourdomain.com/images/users/1/profileImages/thumb-1.jpg?1469269180000' tinyThumbPath: 'https://yourdomain.com/images/users/1/profileImages/tiny-thumb-1.jpg?1469269180000' imageType: image/jpeg createdDate: '2016-10-25T08:15:45+0000' - cumulativeAlertId: 289 commentType: 5 description: 'Partition : / Total : 17133.81MB' createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@gmail.com phoneNumber: 406-625-1234 profileImage: logoPath: 'https://yourdomain.com/images/users/1/profileImages/1.jpg?1469269179000' thumbPath: 'https://yourdomain.com/images/users/1/profileImages/thumb-1.jpg?1469269180000' tinyThumbPath: 'https://yourdomain.com/images/users/1/profileImages/tiny-thumb-1.jpg?1469269180000' imageType: image/jpeg createdDate: '2016-10-25T10:48:42+0000' totalResults: 2 orderBy: created_date pageNo: 1 pageSize: 2 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/alerts/{alertId}/escalations': summary: Get Alert Escalation Policy associated with alert description: |- Gets the escalation policy associated to an alert. ### Notes - For multiple matched escalation policy the selection is based on ordering below - Policy which matches with higher priority. - In case of similar priority the oldest policy is matched. get: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/escalatedPolicy' examples: example-manual: value: id: POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7 name: Network Issues description: '' policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T12:13:31+0000' updatedDate: '2017-05-15T12:13:31+0000' active: true scope: id: 5 uniqueId: msp_5 name: Luminalto Partner activated: true createdBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@organization.com phoneNumber: '' mobileNumber: 802-456-1234 updatedBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@organization.com phoneNumber: '' mobileNumber: 802-456-1234 allClients: true resources: - id: 7447fef1-68ee-4c2a-a366-273abc819dbc name: ESC00002 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: ADC Client type: CLIENT filterCriteria: matchingType: ALL rules: - key: 'Alert : Description' operator: CONTAINS value: CRITICAL escalationType: AUTOMATIC escalations: - waitMins: 0 priority: Very Low repeatFrequency: 10 action: NOTIFICATION recipients: - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Support team type: ROSTER - id: USR0000000019 name: Jim Bolt type: USER - waitMins: 5 updateIncident: none: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Level 1 Impact description: '' urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Critical Issue description: '' priority: High incident: status: New priority: Low assignedUser: loginName: John_Smith lastName: Smith firstName: John email: john.smith@organization.com phoneNumber: '' mobileNumber: 802-123-4123 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Component name: text_api_lab_3791 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: Value_1 defaultValue: Default Component customField: true toEmail: support.admin@organization.com action: INCIDENT notifyIncident: forEveryUpdate example-machine-learning: value: id: POLICY-14d82994-a67e-463b-955a-37ff2eee7368 name: ML_policy description: '' policyType: ESCALATION_POLICY createdDate: '2018-12-18T12:04:36+0000' updatedDate: '2018-12-18T12:04:36+0000' active: true scope: id: 9 uniqueId: client_9 name: Brocade Corp. activated: true escalationType: AUTOMATIC escalations: - action: INCIDENT waitMins: 0 incident: status: New priority: High estimatedHours: 0 timeSpent: 0 estimatedMinutes: 0 machineLearning: continuousLearning: false trainingFileId: ml_alert_escalation_training learnedFieldsToOutputColumnsMap: Assignee Group: incident.assigneeGroup Priority: incident.priority updateIncident: none: 'true' notifyIncident: forEveryUpdate summary: '' operationId: alert_policy_escalations-on-alertId parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/alertId' '/api/v2/tenants/{tenantId}/users/{userId}/alertViews': summary: Get Alert Views description: Gets a list of alert views. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string description: type: string viewType: type: string defaultView: type: boolean examples: example-alert-views-shared: value: - id: 35 name: Warning and critical alerts description: Testing 3 viewType: Shared defaultView: true example-alert-view-private: value: - id: 33 name: Last One Day Alerts description: Testing 1 viewType: Private defaultView: true - id: 34 name: Ticketed Alerts description: Testing 2 viewType: Private defaultView: true - id: 35 name: Warning and critical alerts description: Testing 3 viewType: Shared defaultView: true parameters: - schema: type: boolean default: true in: query name: isDescendingOrder description: List preference indicating whether descending order is required. - schema: type: string default: id in: query name: sortName description: Unique ID allotted to a view when an alert view is created. - schema: type: string default: all in: query name: viewType description: |- Supported values: - All: Provides private and shared alert views of a client. - Private: Provides alerts that are private to the logged-in user. - Shared: Provides alerts that are shared across the client. - schema: type: boolean default: true in: query name: defaultView description: Displays the default alert view. parameters: - name: userId in: path required: true schema: type: string description: Unique uuid for user - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/users/{userId}/alertViews/{viewId}': summary: Get Alert View by View ID description: Gets an alert view of a user. get: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/alertView' examples: example-alert-view: value: id: 18 name: NOC_View description: This View is useful for NOC people createdOn: '2020-03-17T08:28:15+0000' createdBy: id: USR0000000012 loginName: rgu_basar lastName: BASAR firstName: RGUKT email: test@opsramp.com phoneNumber: '' viewType: Private defaultView: true partners: - id: 7 uniqueId: msp_5 name: Test Partner activated: true clients: - id: 9 uniqueId: client_93 name: Test Client activated: true maskResourceIdentity: false offlineAlertstoThirdPartyTool: false remoteCommands: true alertTimestamp: Last Updated Time duration: 2days resourceOrgin: all states: - Critical availability: all example-alert-view-for-client: value: id: 1074 name: test description: '' createdOn: '2022-02-02T12:17:12+0000' createdBy: id: USR0000001229 loginName: colin.parry@test lastName: lname firstName: fname email: parry.user@test.com phoneNumber: '' userPreferences: dateFormat: 'dd-MM-yyyy HH:mm:ss' displayMode: dark viewType: Private partners: - id: 3 uniqueId: msp_3 name: Demo Partner activated: true featureFlags: {} clients: - id: 154 uniqueId: client_154 name: OpsRamp Support activated: true offlineAlertstoThirdPartyTool: false uuid: 77d8adea-a3fc-38ed-1d7f-269bd58c05a6 addOns: - Knowledgebase Management - OS Service Start/Stop Actions - Process Automation - Remote Access Management - SMS and Voice packages: - Hybrid Discovery and Monitoring - Event and Incident Management - Remediation and Automation webConsoles: true locations: - id: 5764 name: europe-west2 clientId: 154 mspId: 3 city: London path: GOOGLE/europe-west2 uuid: 154_GOOGLE_europe-west2 alertTimestamp: Last Updated Time duration: 2days resourceOrgin: all availability: all defaultView: false summary: '' parameters: - name: userId in: path required: true schema: type: string description: Unique uuid for user - schema: type: string in: path name: viewId required: true description: Filter view unique identifier - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/rosters': summary: Create Rosters description: Creates rosters for tenants. post: tags: - alerts requestBody: content: application/json: schema: type: object properties: name: type: string description: | Unique name for roster used for roster identification. description: type: string timeZone: type: object description: |- Time zone in which the roster should operate (see table). An example time zone is: `"timeZone": {"name": "Asia/Calcutta"},` properties: name: type: string shiftDetails: type: array items: $ref: '#/components/schemas/rosterShift' examples: example-one-time-roster: value: name: SJ Network Support description: Team which handles SJ network issues timeZone: name: Asia/Calcutta shiftDetails: - name: Morning shift schedule: type: one-time startDate: '2018-02-06T07:05:00+0000' endDate: '2018-03-10T17:30:00+0000' users: - id: USR0000000018 userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 example-recurring: value: name: SJ Network Support description: Team to handle all network issues in SJ site. timeZone: name: Asia/Calcutta shiftDetails: - name: Morning shift schedule: type: one-time startDate: '2018-02-05T07:05:00+0000' endDate: '2018-06-10T16:10:20+0000' users: - id: USR0000000018 userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 - name: Evening shift schedule: type: recurring startDate: '2018-03-06T00:00:00+0000' startTime: '16:30:00' endTime: '01:30:10' pattern: type: weekly weekDays: 'Wednesday,Thursday,Friday' repeatFrequency: 5 endPattern: type: NEVER users: - id: USR0000000020 userGroups: - uniqueId: USRGRP-48965gg5-8fg6-a3aa-e288-0d3667e36f5 responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string description: '' description: type: string createdTime: type: string updatedTime: type: string timeZone: type: object description: '' properties: id: type: string name: type: string label: type: string code: type: string client: type: object properties: id: type: integer uniqueId: type: string name: type: string activated: type: boolean shiftDetails: type: array items: $ref: '#/components/schemas/rosterShift' examples: example-one-time-roster: value: id: ES-3b05178f-b197-46b2-9451-db9bfc3c8403 name: SJ Network Support description: Team to monitor all network issues in SJ site. createdTime: '2018-02-04T09:08:15+0000' updatedTime: '' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST client: id: 7 uniqueId: client_7 name: Logix Inc activated: true shiftDetails: - id: ESD-237dffd1-8b86-47da-a40a-78246b6028e1 name: Morning shift schedule: type: one-time startDate: '2018-02-06T07:05:00+0000' endDate: '2017-06-10T16:10:20+0000' users: - id: USR0000000018 loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com phoneNumber: '' mobileNumber: '9004561234' userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 name: Network Admins description: '' createdTime: '2017-03-14T11:40:35+0000' - id: ESD-edaea54b-9a2a-42e9-b54b-6dea26c55202 name: Evening shift schedule: type: recurring startDate: '2018-02-06T00:00:00+0000' startTime: '16:30:00' endTime: '01:30:10' pattern: type: weekly weekDays: 'Wednesday,Thursday,Friday' repeatFrequency: 5 endPattern: type: NEVER users: - id: USR0000000018 loginName: James_Blake lastName: Blake firstName: James email: james.blake@myorganization.com phoneNumber: '' mobileNumber: '9001237123' userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 name: Database Admins description: Team to monitor all Database issues. createdTime: '2017-03-14T11:40:35+0000' operationId: create_rosters parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/rosters/{rosterId}': summary: Manage Rosters description: 'Updates, gets and deletes rosters for tenants.' delete: tags: - alerts responses: '200': description: OK operationId: remove_rosters get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string description: '' description: type: string createdTime: type: string format: date-time updatedTime: type: string format: date-time timeZone: type: object description: '' properties: id: type: string name: type: string label: type: string code: type: string allClients: type: boolean shiftDetails: type: array items: $ref: '#/components/schemas/rosterShift' examples: example-roster: value: id: ES-f64e08e8-9d78-40fa-8bba-19d36d42653f name: Linix Admins description: Team working on Linux issues createdTime: '2017-12-27T06:26:41+0000' updatedTime: '2017-12-27T06:57:00+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST allClients: true shiftDetails: - id: ESD-ab20240d-7d02-489e-8cbd-6592e2980aec name: Second shift schedule: type: recurring startDate: '2017-12-27T04:45:00+0000' startTime: '10:15:00' endTime: '15:20:00' pattern: type: weekly weekDays: 'Wednesday,Thursday,Friday' repeatFrequency: 5 endPattern: type: NEVER users: - id: USR0000000021 loginName: James.Hudson lastName: Hudson firstName: James email: james.h@myorganization.com phoneNumber: 802-1231-234 - id: ESD-f05a111c-a596-4ad5-9eba-67444020434b name: First shift schedule: type: one-time startDate: '2017-12-28T04:41:12+0000' endDate: '2017-12-29T09:46:20+0000' users: - id: USR0000000043 loginName: John.Smith lastName: Smith firstName: John email: john.smith@myorganization.com phoneNumber: 803-4567-890 userGroups: - uniqueId: USRGRP-b5f0e4d4-76ad-4497-8fc7-2790e3eaa343 name: Network Admins Group description: Team working on network issues. createdTime: '2017-12-17T16:26:55+0000' updatedTime: '2017-12-18T10:48:51+0000' operationId: get_rosters post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string description: '' description: type: string createdTime: type: string updatedTime: type: string timeZone: type: object description: '' properties: id: type: string name: type: string label: type: string code: type: string client: type: object properties: id: type: integer uniqueId: type: string name: type: string activated: type: boolean shiftDetails: type: array items: $ref: '#/components/schemas/rosterShift' examples: example-1: value: id: ES-26ecfba7-6896-47a8-aa8d-825b610513e6 name: Network and Windows Support description: Team working on network and Windows devices issues. createdTime: '2017-12-27T06:32:11+0000' updatedTime: '' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST client: id: 7 uniqueId: client_7 name: Logix Inc activated: true shiftDetails: - id: ESD-5296f16f-d254-4d67-bfe8-574d3519d172 name: Morning shift schedule: type: one-time startDate: '2017-12-28T04:41:12+0000' endDate: '2017-12-29T09:46:20+0000' users: - id: USR0000000018 loginName: John.Smith lastName: Smith firstName: John email: john.smith@myorganization.com phoneNumber: '' mobileNumber: 802-123-4433 userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 name: Network Architects description: '' createdTime: '2017-03-14T11:40:35+0000' requestBody: content: application/json: schema: type: object properties: name: type: string description: | Unique name for roster used for roster identification. description: type: string timeZone: type: object description: |- Time zone in which the roster should operate (see table). An example time zone is: `"timeZone": {"name": "Asia/Calcutta"},` properties: name: type: string shiftDetails: type: array items: $ref: '#/components/schemas/rosterShift' examples: example-1: value: name: Network and Windows Support description: Team working on all network and Windows devices issues. timeZone: name: Asia/Calcutta shiftDetails: - id: ESD-5296f16f-d254-4d67-bfe8-574d3519d172 name: Morning shift schedule: type: one-time startDate: '2017-12-28T04:41:12+0000' endDate: '2017-12-29T09:46:20+0000' users: - id: USR0000000018 userGroups: - uniqueId: USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4 operationId: create_rosters_all parameters: - in: path name: tenantId schema: type: string required: true description: Describes the client ID or msp ID of the tenant - $ref: '#/components/parameters/rosterId' '/api/v2/tenants/{tenantId}/rosters/search': summary: Search Rosters description: | Search rosters within a tenant. ### Differentiate Rosters To differentiate between partner-level and client-level rosters: - Client level roster: If `client` and client details are provided. - Partner-level roster: If `allClients: true` is provided. get: responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string description: type: string createdTime: type: string format: date-time updatedTime: type: string format: date-time timeZone: type: object properties: id: type: string name: type: string label: type: string code: type: string client: type: object properties: uniqueId: type: string name: type: string activated: type: boolean allClients: type: boolean totalResults: type: integer pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-partner-rosters: value: results: - id: ES-1f43a99c-469e-a62a-b452-aacf6ad81e3b name: Network Issues Support description: Network Issues Support - Asia Region createdTime: '2017-02-09T11:59:25+0000' updatedTime: '2017-03-08T07:25:02+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST client: uniqueId: client_7 name: Test Client activated: true - id: ES-d89ca222-1ee8-50ef-e40a-ba89fb23586b name: Implementation Support description: Implementation Support - Level 1 createdTime: '2017-03-14T11:42:04+0000' updatedTime: '2017-06-28T11:33:49+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST allClients: true - id: ES-157ce85f-2f91-94e9-dc2d-ec4591ef2ed5 name: Alerts Support description: Alerts Support - Level 1 createdTime: '2017-05-04T10:12:23+0000' updatedTime: '2017-06-28T11:33:49+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST client: uniqueId: client_7 name: Test Client activated: true - id: ES-9f0e489c-8c00-4dba-8a7e-9c81f710d0d3 name: Maintenance Team description: Maintenance team to address Jobs and Patches issues createdTime: '2017-06-16T07:08:35+0000' updatedTime: '2017-06-27T13:07:19+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST allClients: true - id: ES-b519563f-5b9f-4bcf-9a90-ce3cddf5c268 name: Network Management Team - Level 1 description: Network management team to address critical network issues. createdTime: '2017-06-27T12:38:23+0000' updatedTime: '2017-06-28T10:59:20+0000' timeZone: id: '19' name: Asia/Calcutta label: 'GMT +05:30 India' code: IST client: uniqueId: client_7 name: Test Client activated: true totalResults: 5 pageNo: 1 pageSize: 20 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false parameters: - $ref: '#/components/parameters/pageNo' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/isDescendingOrder' - $ref: '#/components/parameters/sortName' - $ref: '#/components/parameters/queryString' - schema: type: string in: query name: name description: The roster name (must be identical to match) - schema: type: boolean default: false in: query name: allList description: 'If true, get both partner and client level rosters and if false (the default), get partner level rosters.' tags: - alerts summary: Search rosters description: '' operationId: alert_rosters_search parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/escalations': summary: Create Alert Escalation Policy description: |- Creates an alert escalation policy. The policy is a predefined action to be taken when an alert is not acknowledged. ### Notes - escalationType: - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED: Automated notifications via recipient users until acknowledged, closed, suppressed, or ticketed. - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED: Automated notifications via recipient users until acknowledged, closed, or suppressed. - MANUAL: Contact users directly as required. - filterCriteria: Use the following filter request structure for "Alert : Occurrence Frequency". - occurrences: Any integer. - frequency: Any integer. - frequencyType: In hours or days or weeks post: tags: - alerts requestBody: content: application/json: schema: $ref: '#/components/schemas/escalationPolicy' examples: example-automatic-until-acknowledged-closed-suppressed-ticketed: value: name: Create escalate alert policy API description: Test description resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: Contains value: critical - isNativeAttribute: true key: Business Hours operator: IS value: 'Yes' - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 action: INCIDENT updateIncident: withAlertState: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High notifyIncident: whenAlertStateChanged incident: priority: Very Low assigneeGroup: uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 name: Test Group assignedUser: id: USR0000000030 loginName: OpsAdmin businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 customFields: - id: UDF0000000002 name: test_cutom_2 value: '2' - id: UDF0000000004 name: esc_custom_field_4 value: request custom field - text cc: tester1@opsramp.com toEmail: tester2@opsramp.com example-automatic-until-acknowledged-closed-suppressed: value: name: Create escalate alert policy API description: Test description resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: Contains value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 action: INCIDENT updateIncident: none: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High notifyIncident: whenAlertStateChanged incident: priority: Very Low assigneeGroup: uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 name: Test Group assignedUser: id: USR0000000030 loginName: OpsAdmin businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 customFields: - id: UDF0000000002 name: test_cutom_2 value: '2' - id: UDF0000000004 name: esc_custom_field_4 value: request custom field - text cc: tester1@opsramp.com toEmail: tester2@opsramp.com example-manual: value: name: Create escalate alert policy API for NOC description: Test description resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: Contains value: critical escalationType: MANUAL escalations: - recipients: - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP example-auto-ticket-update: value: name: Create escalate alert policy API description: Test description enabledMode: 'ON' resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 action: INCIDENT updateIncident: updateWhenAlertStateChange: 'true' autoResolveIncident: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High incident: priority: Very Low category: uniqueId: SCAT-23ebce6e-4860-4145-b15c-a4a2071eaec1 subCategory: uniqueId: SCAT-066bd31b-be66-4e10-978a-e7f2ab3394e6 assigneeGroup: uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 name: Test Group assignedUser: id: USR0000000030 loginName: OpsAdmin businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 customFields: - id: UDF0000000002 name: test_cutom_2 value: '2' - id: UDF0000000004 name: esc_custom_field_4 value: request custom field - text cc: tester1@opsramp.com toEmail: tester2@opsramp.com example-create-escalation-policy-with-tag: $ref: ./models/opsramp-alerts/create-escalation-policy-with-tag-request-v1.yaml # commented by bala externalValue: '#components/requestBodies/create-escalation-policy-with-tag-request' description: '' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/escalatedPolicy' examples: example-automatic-until-acknowledged-closed-suppressed-ticketed: value: id: POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42 name: Create escalate alert policy API description: Test description policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T10:35:51+0000' updatedDate: '2017-05-15T10:35:51+0000' active: true enabledMode: 'ON' scope: id: 7 uniqueId: client_7 name: Netenrich Client activated: true createdBy: loginName: ops_admin_user firstName: Ops Admin email: tester1@opsramp.com updatedBy: loginName: ops_admin_user firstName: Ops Admin email: tester1@opsramp.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: Ops Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: type: critical - isNativeAttribute: true key: Business Hours operator: IS value: 'Yes' - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: type: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 updateIncident: none: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Test Ops impact description: Test urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Test Ops urgency description: Test priority: High incident: status: New priority: Low assignedUser: id: USR0000000030 loginName: OpsAdmin lastName: User firstName: Ops email: opsuser@opsramp.com phoneNumber: '' mobileNumber: '9876543210' assigneeGroup: id: 1 name: Test Group description: '' uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Impact 2 description: Impact level 2 urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Urgency 1 description: Urgency level 1 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Test Cutom name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: '2' defaultValue: '' customField: true - id: UDF0000000004 classCode: INCIDENT displayLabel: Esc custom field name: esc_custom_field_4 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: request custom field - text defaultValue: '' customField: true cc: tester1@opsramp.com toEmail: tester2@opsramp.com action: INCIDENT notifyIncident: whenAlertStateChanged example-automatic-until-acknowledged-closed-suppressed: value: id: POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42 name: Create escalate alert policy API description: Test description policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T10:35:51+0000' updatedDate: '2017-05-15T10:35:51+0000' active: true enabledMode: 'ON' scope: id: 7 uniqueId: client_7 name: Netenrich Client activated: true createdBy: loginName: ops_admin_user firstName: Ops Admin email: opsuser@opsramp.com updatedBy: loginName: ops_admin_user firstName: Ops Admin email: opsuser@opsramp.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: Ops Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: CRITICAL - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 updateIncident: none: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Test Ops impact description: Test urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Test Ops urgency description: Test priority: High incident: status: New priority: Low assignedUser: id: USR0000000030 loginName: OpsAdmin lastName: User firstName: Ops email: opsuser@opsramp.com phoneNumber: '' mobileNumber: '9876543210' assigneeGroup: id: 1 name: Test Group description: '' uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Impact 2 description: Impact level 2 urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Urgency 1 description: Urgency level 1 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Test Cutom name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: '2' defaultValue: '' customField: true - id: UDF0000000004 classCode: INCIDENT displayLabel: Esc custom field name: esc_custom_field_4 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: request custom field - text defaultValue: '' customField: true cc: tester1@opsramp.com toEmail: tester2@opsramp.com action: INCIDENT notifyIncident: whenAlertStateChanged example-manual: value: id: POLICY-a204aea2-f943-46cb-86fa-86197e796f70 name: Create escalate alert policy API for NOC123 description: Test description policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T11:10:32+0000' updatedDate: '2017-05-15T11:10:32+0000' active: true enabledMode: 'ON' scope: id: 5 uniqueId: msp_5 name: Ops Partner activated: true createdBy: loginName: ops_admin_user firstName: Ops Admin email: opsuser@opsramp.com updatedBy: loginName: ops_admin_user firstName: Ops Admin email: opsuser@opsramp.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: Ops Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: CRITICAL escalationType: MANUAL escalations: - action: NOTIFICATION recipients: - id: USR0000000019 name: mani_partner type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Test roster type: ROSTER example-ticket-update: value: id: POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42 name: Create escalate alert policy API description: Test description policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T10:35:51+0000' updatedDate: '2017-05-15T10:35:51+0000' active: true enabledMode: 'ON' scope: id: 7 uniqueId: client_7 name: Netenrich Client activated: true createdBy: loginName: ops_admin_user firstName: Ops Admin email: tester1@opsramp.com updatedBy: loginName: ops_admin_user firstName: Ops Admin email: tester1@opsramp.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: Ops Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 updateIncident: none: 'true' updateWhenAlertStateChange: 'true' withAlertState: 'true' autoResolveIncident: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Test Ops impact description: Test urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Test Ops urgency description: Test priority: High incident: status: New priority: Low assignedUser: id: USR0000000030 loginName: OpsAdmin lastName: User firstName: Ops email: opsuser@opsramp.com phoneNumber: '' mobileNumber: '9876543210' assigneeGroup: id: 1 name: Test Group description: '' uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Impact 2 description: Impact level 2 urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Urgency 1 description: Urgency level 1 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Test Cutom name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: '2' defaultValue: '' customField: true - id: UDF0000000004 classCode: INCIDENT displayLabel: Esc custom field name: esc_custom_field_4 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: request custom field - text defaultValue: '' customField: true cc: tester1@opsramp.com toEmail: tester2@opsramp.com action: INCIDENT example-create-escalation-policy-with-tag: $ref: ./models/opsramp-alerts/create-escalation-policy-with-tag-response-v1.yaml summary: '' operationId: alert_policy_escalations parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/escalations/{policyId}': summary: Manage Alert Escalation Policy description: 'Gets, update and delete alert escalation policy of tenant by policyId.' delete: tags: - alerts responses: '200': description: OK get: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/escalatedPolicy' examples: example-policy-details: value: id: POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7 name: Cloud Instance Alerts Policy description: '' policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T12:13:31+0000' updatedDate: '2017-05-15T12:13:31+0000' active: true scope: uniqueId: msp_5 name: Luminalto activated: true createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@myorganization.com updatedBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@myorganization.com allClients: true resources: - id: 7447fef1-68ee-4c2a-a366-273abc819dbc name: ESC00002 type: RESOURCE resourceType: RESOURCE aliasName: '' resourceName: '' hostName: Device11 - id: 59d820d3-7a64-4329-ba9c-bb9c14a4815c name: Device12 type: RESOURCE resourceType: RESOURCE aliasName: '' resourceName: '' hostName: Device12 filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical escalationType: AUTOMATIC escalations: - waitMins: 0 priority: High repeatFrequency: 10 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Support Team type: ROSTER - id: USR0000000019 name: Jim Bolt type: USER - action: INCIDENT waitMins: 5 incident: status: New priority: Low assignedUser: loginName: James.Hudson lastName: Hudson firstName: James email: james.hudson@myorganization.com phoneNumber: '' mobileNumber: 802-123-4123 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Component name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: Test1 defaultValue: Default Component customField: true businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Impact 3 description: SP Level Impact urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Urgency 3 description: SP Level Urgency toEmail: support@myorganization machineLearning: continuousLearning: false learnedFieldsToOutputColumnsMap: Assignee Group: incident.assigneeGroup Priority: incident.priority updateIncident: none: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-d8853b21-ebc5-dd1d-d9a3-7a7b121ae0e name: Test Ops impact description: '' urgency: uniqueId: SURG-59358506-4bf1-4d35-c902-de3b14a00c10 name: Test Ops urgency description: '' priority: High notifyIncident: forEveryUpdate example-auto-update-incidents: value: id: POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7 name: Test escalations description: '' policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T12:13:31+0000' updatedDate: '2017-05-15T12:13:31+0000' active: true enabledMode: 'ON' scope: uniqueId: msp_5 name: Test Partner activated: true createdBy: loginName: superadmin lastName: Test firstName: tester email: tester@opsramp.com updatedBy: loginName: superadmin lastName: Test firstName: tester email: tester@opsramp.com allClients: true resources: - id: d7bfffe6-03a4-48db-b6e2-a5aa8d5f28d4 name: Device11 type: RESOURCE resourceType: RESOURCE aliasName: '' resourceName: '' hostName: Device11 - id: 59d820d3-7a64-4329-ba9c-bb9c14a4815c name: Device12 type: RESOURCE resourceType: RESOURCE aliasName: '' resourceName: '' hostName: Device12 filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 0 priority: Very Low repeatFrequency: 10 notifyLimitCount: 2 action: NOTIFICATION recipients: - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Test roster type: ROSTER - id: USR0000000019 name: mani_partner type: USER - action: INCIDENT waitMins: 5 incident: status: New priority: Low assignedUser: loginName: superadmin lastName: Test firstName: tester email: tester@opsramp.com phoneNumber: '' mobileNumber: '1234567890' customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Test Cutom name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: Test1 defaultValue: '' customField: true businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Impact 3 description: SP Level Impact urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Urgency 3 description: SP Level Urgency toEmail: tester1@opsramp.com machineLearning: continuousLearning: false learnedFieldsToOutputColumnsMap: Assignee Group: incident.assigneeGroup Priority: incident.priority updateIncident: none: 'true' updateWhenAlertStateChange: 'true' withAlertState: 'true' autoResolveIncident: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-d8853b21-ebc5-dd1d-d9a3-7a7b121ae0e name: Test Ops impact description: '' urgency: uniqueId: SURG-59358506-4bf1-4d35-c902-de3b14a00c10 name: Test Ops urgency description: '' priority: High parameters: - schema: type: string in: query name: scope description: 'Users, User Groups, and Rosters to receive the escalations.' - schema: type: string in: query name: rosters description: | Roster is a list of users part of the schedule doing particular duty. - schema: type: string enum: - MANUAL - AUTOMATIC in: query name: escalationType description: | Escalation rules are actions taken when an alert is not acknowledged within the desired time.OpsRamp supports manual and automatic escalation types. - schema: type: string enum: - NOTIFICATION - INCIDENT in: query name: action description: |- Escalation action to take - Escalate as Notification implies to send periodic notifications to users until the alert is acknowledged. - Escalate as Incident implies to automatically create an incident from the alert and assign to the desired user/team. - schema: type: string in: query name: escalations description: | Information about the escalation actions. - schema: type: string in: query name: waitMins description: | The time interval to escalate an alert after generation. Escalate after the alert has elapsed the set time. - schema: type: string in: query name: notifyLimitCount description: |- A threshold limit on the number of notifications a user receives. Example: notifyLimitCount: 5 - schema: type: string in: query name: alertStateTransitionFrom description: | For every change in the alert state, user receives notifications. - schema: type: string in: query name: recipients description: |- - For escalationType: MANUAL- Users to contact directly. User ID (or) name. - For escalationType: AUTOMATIC- Recipients who receives notifications. - schema: type: string in: query name: allClients description: | This string helps to differentiate between partner and client escalation policies. allClients: true indicates the policy is a partner level policy. - schema: type: string in: query name: machineLearning description: |- This string indicates that machine-learning is enabled to automatically escalate an incident to appropriate teams. - Machine-learning enabled incident attributes: Example: Assignee Group, Priority - "Assignee Group" is the Incident attribute and "incident.assigneeGroup" is the respective output column in a CSV file. - learnedFieldsToOutputColumnsMap"Assignee Group": "incident.assigneeGroup","Priority": "incident.priority" - schema: type: string in: query name: repeatFrequency description: |- The time interval when a user receives repeated notifications. This example indicates that a user receives repeated notifications every 15 minutes: repeatFrequency: 15. operationId: alert_policy_escalations-policId-details post: description: |- When the escalation action is set to INCIDENT, an incident is automatically created from the alert and assigned to the desired user/team. - Create New Incident - Update Incident No further level of escalation can be added as the escalation ends when an incident is created from the alert. tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/escalatedPolicy' examples: example-automatic-escalation: value: id: POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42 name: Network Devices Down description: Issue in Network devices. policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T10:35:51+0000' updatedDate: '2017-05-15T10:35:51+0000' active: true scope: id: 7 uniqueId: client_7 name: AB Client activated: true createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@domain.com updatedBy: loginName: vJohn.Smith lastName: Smith firstName: John email: john.smith@domain.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: OpsRamp Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: days escalationType: AUTOMATIC escalations: - waitMins: 5 priority: Low repeatFrequency: 5 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: OpsRamp group type: USERGROUP_DL - waitMins: 5 updateIncident: withAlertState: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: High Level Impact description: The issue may cause fluctuations in network. urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: High description: Need to fix within 2 hours. priority: High incident: status: New priority: Low assignedUser: id: USR0000000030 loginName: James.Rivers lastName: Rivers firstName: James email: James.Rivers@domain.com phoneNumber: '' mobileNumber: 406-559-1234 assigneeGroup: id: 1 name: Network Group description: '' uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Number of attached incidents name: Attached Incidents fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: '2' defaultValue: '' customField: true - id: UDF0000000004 classCode: INCIDENT displayLabel: Incident History name: Incident History fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: request custom field - text defaultValue: '' customField: true cc: support@domain.com toEmail: james.scott@domain.com action: INCIDENT notifyIncident: whenAlertStateChanged example-manual-escalation: value: id: POLICY-a204aea2-f943-46cb-86fa-86197e796f70 name: Network Devices Down description: Issues in network devices. policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T11:10:32+0000' updatedDate: '2017-05-15T11:10:32+0000' active: true scope: id: 5 uniqueId: msp_5 name: OpsRamp Partner activated: true createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@domain.com updatedBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@domain.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Network Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Network Service Group type: SERVICEGROUP - id: client_6 name: OpsRamp Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical escalationType: MANUAL escalations: - action: NOTIFICATION recipients: - id: USR0000000019 name: Partner.A type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Test roster type: ROSTER example-auto-incident-updates: value: id: POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42 name: Create escalate alert policy API description: Test description policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T10:35:51+0000' updatedDate: '2017-05-15T10:35:51+0000' active: true enabledMode: 'ON' scope: id: 7 uniqueId: client_7 name: Netenrich Client activated: true createdBy: loginName: ops_admin_user firstName: Ops Admin email: opsuser@opsramp.com updatedBy: loginName: ops_admin_user lastName: ' ' firstName: Ops Admin email: opsuser@opsramp.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Test Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Test SG type: SERVICEGROUP - id: client_6 name: Ops Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 updateIncident: none: 'true' updateWhenAlertStateChange: 'true' withAlertState: 'true' autoResolveIncident: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f name: Test Ops impact description: Test urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 name: Test Ops urgency description: Test priority: High incident: status: New priority: Low assignedUser: id: USR0000000030 loginName: Ops_User lastName: User firstName: Ops email: opsuser@opsramp.com phoneNumber: '' mobileNumber: '9876543210' assigneeGroup: id: 1 name: Test Group description: '' uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 customFields: - id: UDF0000000002 classCode: INCIDENT displayLabel: Test Cutom name: test_cutom_2 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: '2' defaultValue: '' customField: true - id: UDF0000000004 classCode: INCIDENT displayLabel: Esc custom field name: esc_custom_field_4 fieldType: TYPE_TEXT mandatory: false editable: true description: '' value: request custom field - text defaultValue: '' customField: true cc: tester1@opsramp.com toEmail: tester2@opsramp.com action: INCIDENT requestBody: content: application/json: schema: $ref: '#/components/schemas/escalationPolicy' examples: example-automatic-escalation: value: name: Network Devices Down description: Issues in network devices. resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: days escalationType: AUTOMATIC escalations: - waitMins: 5 priority: Low repeatFrequency: 5 action: NOTIFICATION recipients: - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: OpsRamp group type: USERGROUP_DL - waitMins: 5 action: INCIDENT updateIncident: withAlertState: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High notifyIncident: whenAlertStateChanged incident: priority: Very Low assigneeGroup: uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 name: Network Group assignedUser: id: USR0000000030 loginName: Ops_User customFields: - id: UDF0000000002 name: Number of attached incidents value: '2' - id: UDF0000000004 name: esc_custom_field_4 value: |- $function.substring($alert.description ,'SITE ID=',' ') cc: support@domain.com toEmail: james.scott@domain.co example-manual-escalation: value: id: POLICY-a204aea2-f943-46cb-86fa-86197e796f70 name: Network Devices Down description: Issues in network devices. policyType: ESCALATION_POLICY clientMatchingType: ALL createdDate: '2017-05-15T11:10:32+0000' updatedDate: '2017-05-15T11:10:32+0000' active: true scope: id: 5 uniqueId: msp_5 name: OpsRamp Partner activated: true createdBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@domain.com updatedBy: loginName: John.Smith lastName: Smith firstName: John email: john.smith@domain.com resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 name: LPT00001 type: RESOURCE - id: 7_AWS name: AWS type: LOCATION - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 name: Network Group type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 name: Network Service Group type: SERVICEGROUP - id: client_6 name: OpsRamp Client type: CLIENT filterCriteria: matchingType: ALL rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical escalationType: MANUAL escalations: - action: NOTIFICATION recipients: - id: USR0000000019 name: Partner.A type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: ES-d16473ee-29de-1cf2-4983-86307733e34c name: Test roster type: ROSTER example-auto-incident-updates: value: name: Create escalate alert policy API description: Test description enabledMode: 'ON' resources: - id: bf3a10a2-92f1-4610-b3f4-174ed83db7b9 type: RESOURCE - id: DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2 type: DEVICEGROUP - id: SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817 type: SERVICEGROUP - id: 7_AWS type: LOCATION - id: client_7 type: CLIENT filterCriteria: matchingType: ANY rules: - isNativeAttribute: true key: 'Alert : Description' operator: CONTAINS value: critical - isNativeAttribute: true key: 'Alert : Occurrence Frequency' operator: GREATERTHANOREQUALTO value: occurrences: '5' frequency: '2' frequencyType: hours - isNativeAttribute: true key: 'Resource : Resource Type' operator: MATCH value: DEVICE - isNativeAttribute: false key: test_cutom_attribute operator: CONTAINS value: custom value escalationType: AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED escalations: - waitMins: 5 priority: Low repeatFrequency: 5 action: NOTIFICATION recipients: - id: ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47 name: Cloud roster type: ROSTER - id: USR0000000028 name: AP_User type: USER - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Cloud group type: USERGROUP - id: USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d name: Ops group type: USERGROUP_DL - waitMins: 5 action: INCIDENT updateIncident: updateWhenAlertStateChange: 'true' autoResolveIncident: 'true' priorityRules: - key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High incident: priority: Very Low assigneeGroup: uniqueId: USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558 name: Test Group assignedUser: id: USR0000000030 loginName: Ops_User customFields: - id: UDF0000000002 name: test_cutom_2 value: '2' - id: UDF0000000004 name: esc_custom_field_4 value: request custom field - text cc: tester1@opsramp.com toEmail: tester2@opsramp.com parameters: - $ref: '#/components/parameters/tenantId' - name: policyId in: path required: true schema: type: string format: uuid description: Policy unique identifier '/api/v2/tenants/{tenantId}/escalations/{policyId}/{mode}': summary: Set Alert Escalation Policy mode description: 'Enables, disables and set an observed/recommend mode for an alert escalation policy of the tenant.' post: tags: - alerts responses: '200': description: OK operationId: alert_policy_escalations_mode parameters: - $ref: '#/components/parameters/tenantId' - name: policyId in: path required: true schema: type: string format: uuid description: Policy unique identifier - schema: type: string enum: - enable - disable - observed - recommend name: mode in: path required: true description: 'Supported policy operation mode: enable/disable policy, use recommend/observed only for escalated incidents' '/api/v2/tenants/{tenantId}/escalations/search': summary: Search Escalation Policies description: Gets the escalation polices defined for the tenant. get: tags: - alerts parameters: - $ref: '#/components/parameters/pageNo' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/isDescendingOrder' - $ref: '#/components/parameters/sortName' - $ref: '#/components/parameters/queryString' - schema: type: string in: query name: name description: Alert Escalation policy name. Only identical policies in query string name are displayed. - schema: type: string format: binary enum: - 'true' - 'false' default: 'true' in: query name: allList description: 'This string is applicable to a partner user to fetch client policies as well. By default, OpsRamp provides partner alert escalation policies if allList is not provided in the query string.Provide allList:true to fetch partner and client alert escalation policies. Provide allList:false to fetch only partner alert escalation policies.' - schema: type: string in: query name: startCreationDate description: 'Search for policies created within a certain time frame. Provide a start date. An example: 2017-05-05T13:25:15 0000' - schema: type: string in: query name: endCreationDate description: 'Provide an end date. An example: 2017-05-08T10:30:40 0000' - schema: type: string in: query name: startUpdationDate description: 'Search for policies updated within a certain time frame. Provide a start date. An example: 2017-06-10T09:20:10 0000' - schema: type: string in: query name: endUpdationDate description: 'Provide an end date. An example: 2017-06-15T08:10:30 0000' responses: '200': description: OK content: application/json: schema: type: object description: '' properties: results: type: array description: Paginated results of the querySet items: type: object properties: id: type: string name: type: string description: type: string policyType: type: string createdDate: type: string format: date-time updatedDate: type: string format: date-time active: type: boolean description: '' mlBased: type: boolean description: |- Indicates the machine-learning based escalation policy. mlBased: `true` indicates the machine-learning based escalation policy. mlBased: `false` indicates manual escalation policy. default: false scope: type: object properties: uniqueId: type: string name: type: string activated: type: boolean allClients: type: boolean totalResults: type: integer description: Total paginated records pageNo: type: integer description: Page no of paginated results pageSize: type: integer description: No of records in page totalPages: type: integer description: Total no of pages in paginated results nextPage: type: boolean description: Is next paginated result present true or false descendingOrder: type: boolean description: 'true if paginated data order is descending ' previousPageNo: type: integer description: Previous paginated result page no examples: example-policies: value: results: - id: POLICY-a0250f66-bf3a-7568-edef-83e7e8ac4231 name: SJ Network Maintenance description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:25:15+0000' updatedDate: '2017-05-16T04:32:14+0000' active: false mlBased: false scope: uniqueId: client_7 name: Luminalto activated: true - id: POLICY-dbfd8922-1efe-3b4c-8881-aec1518cc2fc name: Network Maintenance Issue description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:25:23+0000' updatedDate: '2017-05-15T11:08:06+0000' active: true mlBased: false scope: uniqueId: msp_5 name: Ops Partner activated: true allClients: true - id: POLICY-5f2d43f2-32cb-3322-a863-19012cfa6c40 name: Wifi-Service Issues description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:25:32+0000' updatedDate: '2017-05-05T13:25:32+0000' active: true mlBased: false scope: uniqueId: msp_5 name: Ops Partner activated: true allClients: true - id: POLICY-482ebe14-dac7-5d13-24a3-e219fd71d6c7 name: Alert Critical- Network description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:25:43+0000' updatedDate: '2017-05-05T13:25:43+0000' active: true mlBased: false scope: uniqueId: client_7 name: Luminalto activated: true - id: POLICY-8d2b558a-42dd-94aa-edd9-811515bef274 name: CG Network Infrastructure description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:25:51+0000' updatedDate: '2017-05-05T13:25:51+0000' active: true mlBased: false scope: uniqueId: client_7 name: Luminalto activated: true - id: POLICY-b2d28729-fc38-2cd8-ab57-b60d9366f5fa name: Escalate alert to WC Network team description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-05T13:26:14+0000' updatedDate: '2017-05-05T13:26:14+0000' active: true mlBased: false scope: uniqueId: client_6 name: Online Services activated: true - id: POLICY-31c5640e-e9bd-83ee-3fce-46e444855dfe name: Network issue- Low description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-08T07:46:14+0000' updatedDate: '2017-05-14T11:43:45+0000' active: true mlBased: false scope: uniqueId: client_6 name: Online Services activated: true - id: POLICY-8b2c57b5-77e2-47c8-b849-4f9bb71d280d name: Cloud Instance Escalation description: Test description policyType: ESCALATION_POLICY createdDate: '2017-05-15T08:17:00+0000' updatedDate: '2017-05-15T08:17:57+0000' active: true mlBased: false scope: uniqueId: client_6 name: Online Services activated: true - id: POLICY-d25263af-9cd4-4964-bd8b-f8ede21af086 name: Discovery Issues description: Test description policyType: ESCALATION_POLICY createdDate: '2017-05-15T08:27:30+0000' updatedDate: '2017-05-15T08:28:05+0000' active: true mlBased: false scope: uniqueId: client_6 name: Online Services activated: true - id: POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7 name: Windows Server Monitoring description: '' policyType: ESCALATION_POLICY createdDate: '2017-05-15T12:13:31+0000' updatedDate: '2017-05-15T12:13:31+0000' active: true mlBased: false scope: uniqueId: client_6 name: Online Services activated: true totalResults: 10 pageNo: 1 pageSize: 20 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false summary: '' operationId: alert_policy_escalations_search parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/policies/alertCorrelation': summary: Manage Alert Correlation Policy description: Creates and gets alert correlation policies for tenants. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string enabled: type: boolean precedence: type: integer type: type: string machineLearning: type: object properties: accuracy: type: integer totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-with-machine-learning: value: results: - id: POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358 name: test_dependency_correlation_ap enabled: false precedence: 25 type: DEPENDENCY - id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap enabled: true precedence: 29 type: ALGORITHM - id: POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3 name: test_co-occurrence_correlation_ap enabled: true precedence: 30 type: CO_OCCURRENCE machineLearning: accuracy: 98 totalResults: 3 orderBy: precedence pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false example-without-machine-learning: value: results: - id: POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358 name: test_dependency_correlation_ap enabled: false precedence: 25 type: DEPENDENCY - id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap enabled: true precedence: 29 type: ALGORITHM - id: POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3 name: test_co-occurrence_correlation_ap enabled: true precedence: 30 type: CO_OCCURRENCE totalResults: 3 orderBy: precedence pageNo: 1 pageSize: 10 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false example-partner-correlation-policy: value: results: - id: POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358 name: test_dependency_correlation_ap enabled: false precedence: 25 type: DEPENDENCY - id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap enabled: true precedence: 29 type: ALGORITHM - id: POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3 name: test_co-occurrence_correlation_ap enabled: true precedence: 30 type: CO_OCCURRENCE machineLearning: accuracy: 98 totalResults: 3 orderBy: precedence pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize operationId: alert_policy_corr_details description: '' post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string enabled: type: boolean precedence: type: integer filterCriteria: type: object properties: filterBased: type: boolean matchingType: type: string rules: type: array items: type: object properties: filterType: type: string entityName: type: string operator: type: string entityValue: type: string type: type: string algorithmCorrelation: type: object properties: alertsTimeWindow: type: integer matchingConditions: type: array items: type: object properties: property: type: string matchType: type: string primaryAlertSubject: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string createdTime: type: string updatedTime: type: string examples: create-w-algo-corr: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: Correlate alerts on parked VMwares enabled: true precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: Agent Status operator: Equals entityValue: Down type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Nearly Identical primaryAlertSubject: Agent down on parked VMwares createdBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com createdTime: '2018-04-27T13:14:07+0000' updatedTime: '' create-w-co_occ-corr: value: id: POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3 name: Server-SJ Alerts enabled: true precedence: 30 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: Logix - filterType: customAttributes entityName: agent-status operator: Equals entityValue: up type: CO_OCCURRENCE createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: john.smith@myorganization.com createdTime: '2018-08-27T13:14:07+0000' updatedTime: '' create-w-ip-filter: value: id: POLICY-AC-e275116e-c457-47be-bd25-9eef3c1d7976 name: IP policy api demo enabled: true precedence: 88 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: Within Range ipAddress: 192.168.5.130 netmask: 255.255.255.192 type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: resource_name matchType: Identical primaryAlertSubject: IP policy api demo createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: admin@opsramp.com createdTime: '2018-12-28T10:42:42+0000' updatedTime: '' create-client-scope-w-algo-all-org-match: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap clientsIncluded: ALL enabled: true precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_custom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: admin@opsramp.com createdTime: '2017-11-27T13:14:07+0000' updatedTime: '' create-client-scope-w-algo-incl-org-match: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap includedClients: - client_8 - client_9 enabled: true precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_custom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: admin@opsramp.com createdTime: '2017-11-27T13:14:07+0000' updatedTime: '' example-policy-with-tags: value: id: POLICY-AC-6da6be4e-273c-4a49-a9bd-84fc0cf3d939 name: Test Corr Policy enabled: true enabledMode: 'ON' precedence: 4 filterCriteria: filterBased: true matchingType: ANY rules: - filterType: alertCustomAttributes entityName: ExternalId operator: Equals entityValue: '10000' type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 15 matchingConditions: - property: alert_component matchType: Identical createdBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com userPreferences: displayMode: light createdTime: '2023-07-12T10:56:48+0000' updatedTime: '' requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the alert correlation policy. filterCriteria: type: object description: Filter for resources whose alerts will match this policy. properties: filterBased: description: Determine if the alert correlation policy should consider the below filter rules. type: boolean matchingType: description: Match ALL or ANY of the rules to filter for resources whose alerts will match this policy. enum: - ALL - ANY type: string rules: type: array description: '(Mandatory if "filterBase": "true") Filter resources with the rules that follow.' items: type: object properties: filterType: type: string description: |- "nativeAttributes": Filter for resources on the basis of predefined attributes. "customAttributes": Filter for resources using custom attributes of device and client. entityName: type: string description: |- Native or custom attribute name. For example, to filter for resources with host_name "VG-Host", use the following: "filterType":"nativeAttributes", "entityName":"host_name", "operator":"CONTAINS", "entityValue":"VG-Host" To filter for resources with a custom attribute"Agent Status", use the following: "filterType":"customAttributes", "entityName":"Agent Status", "operator":"CONTAINS", "entityValue":"Up" Entity names of native attributes: - "dns_name" - "host_name" - "alias_name" - "ip_address" - "resource_type" - "agent_installed" - "operating_system" - "make" - "model" - "alert_source" - "alert_metric" - "device_group" - "service_group" - "site" - "application" - "resource_name" For more options, view Get Custom Attributes of a Client API. operator: type: string description: | The logical operators to filter for resources. To filter Windows resources, use "Contains Windows". To filter resources with the agent is installed, use the following: "entityName": "agent_installed", "operator": "Is", "entityValue": "Yes" enum: - Contains - Not Contains - Equals - Not Equals - Starts with - Ends with - Regex - Is entityValue: type: string description: The unique value of the alert. An example would be "VG-Host". ipMatchingConditions: type: object description: |- Mandatory Mandatory only when "CIDR Match" is selected. (An example is "192.168.1.1/24".) Mandatory only when "Within Range" or "Equals" is selected. Mandatory when "Within Range" is selected (An example is "255.255.255.192".) properties: ipAddressMatchType: type: string enum: - CIDR Match - Within Range - Equals ipAddress: type: string netmask: type: string type: type: string enum: - DEPENDENCY - ALGORITHM - CO_OCCURRENCE description: The alert correlation policy type. dependencyCorrelation: type: object description: Correlate alerts on upstream and downstream resources. properties: alertsTimeWindow: type: integer description: 'Correlate alerts that are generated within a time span specified in minutes. An example is when a user wants to correlate alerts on upstream and downstream resources within a span of 15 minutes. If a value isn''t specified, the default time window is 5 minutes.' enum: - 5 - 10 - 15 - 20 - 25 - 30 - 45 - 60 - 90 - 120 default: 5 upstreamMetrics: type: array description: Metrics on the upstream resource that may generate alerts. Use the Get Metrics API to get metrics assigned to a resource. items: type: string downstreamMetrics: type: array description: Metrics on the downstream resource that may generate alerts. Use the Get Metrics API to get metrics assigned to a resource. items: type: string algorithmCorrelation: type: object description: Correlate alerts that share similar alert properties. properties: alertsTimeWindow: type: integer description: 'Correlate alerts that are generated within a time span specified in minutes. If a value isn''t specified, the default time window is 5 minutes.' enum: - 5 - 10 - 15 - 20 - 25 - 30 - 45 - 60 - 90 - 120 default: 5 matchingConditions: type: array description: |- Correlate alerts based all of the on the following: 1. Select the alert property with which the alerts should be grouped (example is "Host Name"). 2. Match the type of alert property. If a user wants to correlate alerts which exactly share same IP address 172.34.213, provide the "property": "ip_address" and "matchType": "Identical" fields. See Matching conditions table for detailed information on match types. items: type: object properties: property: type: string enum: - resource_type - resource_name - subject - host_name - alert_source - alert_metric - device_group - service_group - site - alert_description matchType: type: string enum: - Identical - Nearly Identical - Similar - Somewhat primaryAlertSubject: type: string description: 'Provide a subject for the primary alert generated. This helps to identify the Inference. If no subject is provided, the primary alert is treated as the subject for alert correlation.' machineLearning: type: string enum: - trainingFileId - continuousLearning organizationMatchingType: type: string includedClients: type: array items: type: string enabledMode: type: string enum: - 'ON' - 'OFF' - OBSERVED description: 'To enable an alert correlation policy, set "enabledMode": "ON". To disable an alert correlation policy, set "enabledMode: "OFF". To enable an alert correlation policy to observe, set "enabledMode": "OBSERVED".' precedence: description: 'Determine the execution order of a policy. For example, if VMware is specified as part of the agent status policy and network outage policy, the user can determine which policy should execute first to correlate VMware alerts.' type: integer required: - name examples: example-policy-with-algo-corr: value: name: Correlate alerts on parked VMwares filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: Agent Status operator: Equals entityValue: Down type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Nearly Identical primaryAlertSubject: Agent down on parked VMwares example-policy-with-co_occ-corr: value: name: Server-SJ Alerts filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: Logix - filterType: customAttributes entityName: agent_status operator: Equals entityValue: up type: CO_OCCURRENCE example-policy-with-ip-filter: value: name: Server-SJ Alerts type: ALGORITHM filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: Within Range ipAddress: 192.168.5.130 netmask: 255.255.255.192 algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: resource_name matchType: Identical primaryAlertSubject: IP policy api demo example-partner-scope-with-algo-allclients: value: name: test_algorithm_correlation_ap organizationMatchingType: ALL filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_custom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy example-partner-scope-with-algo-few-clients: value: name: test_algorithm_correlation_ap organizationMatchingType: INCLUDE includedClients: - client_8 - client_9 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_custom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy example-policy-with-tags: value: name: Test Corr Policy enabled: true enabledMode: 'ON' precedence: 4 filterCriteria: filterBased: true matchingType: ANY rules: - filterType: alertCustomAttributes entityName: ExternalId operator: Equals entityValue: '10000' type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 15 matchingConditions: - property: alert_component matchType: Identical operationId: alert_policy_corr_post parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/policies/alertCorrelation/{policyId}': summary: Manage Alert Correlation description: 'Update, gets and deletes an alert correlation policy of tenant by poliyId.' delete: tags: - alerts responses: '200': description: OK operationId: alert_policy_corr_Id_del get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string enabled: type: boolean precedence: type: integer filterCriteria: type: object properties: filterBased: {} matchingType: type: string rules: type: array items: type: object properties: filterType: type: string entityName: type: string operator: type: string entityValue: type: string type: type: string dependencyCorrelation: type: object properties: alertsTimeWindow: type: integer upstreamMetrics: type: array items: type: string downstreamMetrics: type: array items: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string updatedBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string createdTime: type: string updatedTime: type: string algorithmCorrelation: type: object properties: alertsTimeWindow: type: integer matchingConditions: type: array items: type: object properties: property: type: string matchType: type: string primaryAlertSubject: type: string machineLearning: type: object properties: trainingFileId: type: string continuousLearning: type: boolean clientsIncluded: type: string includedClients: type: array items: type: string examples: example-dependency-correlation: value: id: POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358 name: Correlate alerts on Hypervisor enabled: false precedence: 25 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: Root_Device operator: Starts with entityValue: ESX type: DEPENDENCY dependencyCorrelation: alertsTimeWindow: 15 upstreamMetrics: - system.process.cpu - system.ping.pl downstreamMetrics: - system.memory.utilization - system.ping.rta createdBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com updatedBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com createdTime: '2018-03-27T13:14:07+0000' updatedTime: '2018-04-10T14:22:10+0000' example-algorithm-based-correlation: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: Correlate alerts on network outage enabled: false precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: ip_address operator: Contains entityValue: '162.11' - filterType: customAttributes entityName: device_location operator: Contains entityValue: West type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: ip_address matchType: Nearly Identical primaryAlertSubject: 'Network outage on Switch 162 ' createdBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com updatedBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com createdTime: '2018-03-27T13:14:07+0000' updatedTime: '2018-04-10T14:22:11+0000' example-cooccurrence-based-correlation: value: id: POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3 name: Server SJ-Alerts enabled: false precedence: 30 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: Logix - filterType: customAttributes entityName: agent_status operator: Equals entityValue: up type: CO_OCCURRENCE machineLearning: trainingFileId: ml_alert_correlation_training_client_9 continuousLearning: false createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: john.smith@myorganization.com updatedBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: john.smith@myorganization.com createdTime: '2018-08-27T13:14:07+0000' updatedTime: '2018-09-12T10:22:11+0000' example-client-scope-algorithm-all: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap clientsIncluded: ALL enabled: true precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_cutom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: admin@opsramp.com createdTime: '2017-11-27T13:14:07+0000' updatedTime: '' example-client-scope-algorithm-include: value: id: POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3 name: test_algorithm_correlation_ap includedClients: - client_8 - client_9 enabled: true precedence: 29 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: test_cutom_attribute operator: Not Contains entityValue: a type: ALGORITHM algorithmCorrelation: alertsTimeWindow: 20 matchingConditions: - property: subject matchType: Identical - property: alert_metric matchType: Identical primaryAlertSubject: subject-alertMetric policy createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: admin@opsramp.com createdTime: '2017-11-27T13:14:07+0000' updatedTime: '' operationId: alert_policy_corr_Id_details post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string enabled: type: boolean precedence: type: integer filterCriteria: type: object properties: filterBased: type: boolean matchingType: type: string rules: type: array items: type: object properties: filterType: type: string entityName: type: string operator: type: string entityValue: type: string type: type: string algorithmCorrelation: type: object properties: alertsTimeWindow: type: integer matchingConditions: type: array items: type: object properties: property: type: string matchType: type: string primaryAlertSubject: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string createdTime: type: string updatedTime: type: string examples: example-1: value: id: POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358 name: Correlate alerts on Hypervisor enabled: false precedence: 25 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: Root_Device operator: Starts with entityValue: ESX type: DEPENDENCY dependencyCorrelation: alertsTimeWindow: 15 upstreamMetrics: - system.process.cpu - system.ping.pl downstreamMetrics: - system.memory.utilization - system.ping.rta createdBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com updatedBy: loginName: John_Smith lastName: Smith firstName: John email: john.smith@myorganization.com createdTime: '2018-03-27T13:14:07+0000' updatedTime: '2018-04-10T14:22:10+0000' requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the alert correlation policy. filterCriteria: type: object description: Filter for resources whose alerts will match this policy. properties: filterBased: description: Determine if the alert correlation policy should consider the below filter rules. type: boolean matchingType: description: Match ALL or ANY of the rules to filter for resources whose alerts will match this policy. enum: - ALL - ANY type: string rules: type: array description: '(Mandatory if "filterBase": "true") Filter resources with the rules that follow.' items: type: object properties: filterType: type: string description: |- "nativeAttributes": Filter for resources on the basis of predefined attributes. "customAttributes": Filter for resources using custom attributes of device and client. enum: - nativeAttributes - customAttributes - alertCustomAttributes entityName: type: string description: |- Native or custom attribute name. For example, to filter for resources with host_name "VG-Host", use the following: "filterType":"nativeAttributes", "entityName":"host_name", "operator":"CONTAINS", "entityValue":"VG-Host" To filter for resources with a custom attribute"Agent Status", use the following: "filterType":"customAttributes", "entityName":"Agent Status", "operator":"CONTAINS", "entityValue":"Up" Entity names of native attributes: - "dns_name" - "host_name" - "alias_name" - "ip_address" - "resource_type" - "agent_installed" - "operating_system" - "make" - "model" - "alert_source" - "alert_metric" - "device_group" - "service_group" - "site" - "application" For more options, view Get Custom Attributes of a Client API. operator: type: string description: | The logical operators to filter for resources. To filter Windows resources, use "Contains Windows". To filter resources with the agent is installed, use the following: "entityName": "agent_installed", "operator": "Is", "entityValue": "Yes" enum: - Contains - Not Contains - Equals - Not Equals - Starts with - Ends with - Regex - Is entityValue: type: string description: The unique value of the alert. An example would be "VG-Host". ipMatchingConditions: type: object description: |- Mandatory Mandatory only when "CIDR Match" is selected. (An example is "192.168.1.1/24".) Mandatory only when "Within Range" or "Equals" is selected. Mandatory when "Within Range" is selected (An example is "255.255.255.192".) properties: ipAddressMatchType: type: string description: '' enum: - CIDR Match - Within Range - Equals ipAddress: type: string netmask: type: string type: type: string enum: - DEPENDENCY - ALGORITHM - CO_OCCURRENCE description: The alert correlation policy type. dependencyCorrelation: type: object description: Correlate alerts on upstream and downstream resources. properties: alertsTimeWindow: type: integer description: 'Correlate alerts that are generated within a time span specified in minutes. An example is when a user wants to correlate alerts on upstream and downstream resources within a span of 15 minutes. If a value isn''t specified, the default time window is 5 minutes.' enum: - 5 - 10 - 15 - 20 - 25 - 30 - 45 - 60 - 90 - 120 default: 5 upstreamMetrics: type: array description: Metrics on the upstream resource that may generate alerts. Use the Get Metrics API to get metrics assigned to a resource. items: type: string downstreamMetrics: type: array description: Metrics on the downstream resource that may generate alerts. Use the Get Metrics API to get metrics assigned to a resource. items: type: string algorithmCorrelation: type: object description: Correlate alerts that share similar alert properties. properties: alertsTimeWindow: type: integer description: 'Correlate alerts that are generated within a time span specified in minutes. If a value isn''t specified, the default time window is 5 minutes.' enum: - 5 - 10 - 15 - 20 - 25 - 30 - 45 - 60 - 90 - 120 default: 5 matchingConditions: type: array description: |- Correlate alerts based all of the on the following: 1. Select the alert property with which the alerts should be grouped (example is "Host Name"). 2. Match the type of alert property. If a user wants to correlate alerts which exactly share same IP address 172.34.213, provide the "property": "ip_address" and "matchType": "Identical" fields. See Matching conditions table for detailed information on match types. items: type: object properties: property: type: string enum: - resource_type - subject - host_name - alert_source - alert_metric - device_group - service_group - site - alert_description matchType: type: string enum: - Identical - Nearly Identical - Similar - Somewhat primaryAlertSubject: type: string description: 'Provide a subject for the primary alert generated. This helps to identify the Inference. If no subject is provided, the primary alert is treated as the subject for alert correlation.' machineLearning: type: string enum: - trainingFileId - continuousLearning organizationMatchingType: type: string includedClients: type: array items: type: string enabledMode: type: string enum: - 'ON' - 'OFF' - OBSERVED description: 'To enable an alert correlation policy, set "enabledMode": "ON". To disable an alert correlation policy, set "enabledMode: "OFF". To enable an alert correlation policy to observe, set "enabledMode": "OBSERVED".' precedence: description: 'Determine the execution order of a policy. For example, if VMware is specified as part of the agent status policy and network outage policy, the user can determine which policy should execute first to correlate VMware alerts.' type: integer required: - name examples: example-policy-details: value: name: Correlate alerts on Hypervisor enabled: 'false' precedence: 25 filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Contains entityValue: vm - filterType: customAttributes entityName: Root_Device operator: Starts with entityValue: ESX type: DEPENDENCY dependencyCorrelation: alertsTimeWindow: 15 upstreamMetrics: - system.ping.pl - system.process.cpu downstreamMetrics: - system.ping.rta - system.memory.utilization operationId: alert_policy_corr_Id_post parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/policyId' '/api/v2/tenants/{tenantId}/policies/alertCorrelation/{policyId}/{mode}': summary: Set Alert Correlation Policy mode description: 'Enables, disables and configures observed mode to an alert correlation policy for tenants.' post: tags: - alerts responses: '200': description: OK operationId: alert_policy_cor_mode parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/mode' '/api/v2/tenants/{tenantId}/policies/alertprediction': summary: Create and Get Alert Prediction Policy description: Creates and gets alert prediction policies of a tenant. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/alertPrediction' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-policies: value: results: - id: POLICY-APP-92012ed3-61d7-4291-883c-27a892a5468a name: API-01 enabledMode: 'ON' - id: POLICY-APP-420ad7bc-c757-49b7-90f3-2b4ff5403e05 name: API-02 enabledMode: 'ON' - id: POLICY-APP-999479b4-2791-4d2f-b0e3-955b7f44130a name: API-03 enabledMode: 'ON' - id: POLICY-APP-c73535ae-c50f-4a62-bc5c-75f03ffa1830 name: API-03 enabledMode: 'ON' - id: POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374 name: Alert Prediction Policy enabledMode: 'ON' totalResults: 5 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize description: This endpoint list all the alert prediction policies of the client. operationId: alert_policy_pred_details post: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/alertPrediction' examples: example-1: value: id: POLICY-APP-594bc866-6702-462d-88ba-04aa3fdc26ed name: Alert Prediction Policy enabledMode: 'ON' example-alert-prediction-with-tag: $ref: ./models/opsramp-alerts/create-alert-prediction-with-tag-response-v1.yaml requestBody: content: application/json: schema: $ref: '#/components/schemas/alertPrediction' examples: example-partner-policy: value: name: Alert Prediction Policy filterCriteria: filterBased: 'true' matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts With entityValue: vm seasonalityTimeFrame: 10D example-alert-prediction-with-tag: $ref: ./models/opsramp-alerts/create-alert-prediction-with-tag-request-v1.yaml description: This endpoint can be used to create an alert prediction policy. description: This endpoint creates a new alert prediction policy of the client. operationId: alert_policy_pred_post parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{clientId}/polices/alertprediction/{policyId}': summary: Manage Alert Prediction Policy description: 'Update, gets and deletes an alert prediction policy of the client by policyId .' delete: tags: - alerts responses: '200': description: OK operationId: alert_policy_pred_Id_del get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string enabledMode: type: string createdTime: type: string updatedTime: type: string filterCriteria: type: object properties: filterBased: type: string matchingType: type: string rules: type: array items: type: object properties: filterType: type: string enum: - nativeAttributes - customAttributes - alertCustomAttributes entityName: type: string enum: - resource_name - alias_name - ip_address - resource_type - agent_installed - operating_system - make - model - alert_metric - alert_component - device_group - service_group - site - application - dns_name operator: type: string enum: - Contains - Not Contains - Equals - Not Equals - Starts With - Ends With - Regex - Is entityValue: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string examples: example-policy-details: value: id: POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374 name: Alert Prediction Policy enabled: false enabledMode: 'ON' filterCriteria: filterBased: 'true' matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts With entityValue: vm createdBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com userPreferences: displayMode: light createdTime: '2021-05-21T10:16:53+0100' updatedTime: '' seasonalityTimeFrame: 10D operationId: alert_policy_pred_Id_details post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string name: type: string enabledMode: type: string createdTime: type: string updatedTime: type: string filterCriteria: type: object properties: filterBased: type: boolean matchingType: type: string rules: type: array items: type: object properties: filterType: type: string entityName: type: string operator: type: string entityValue: type: string createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string examples: example-policy-payload: value: id: POLICY-APP-2ed7be75-b7d8-442d-adc0-d0c9b6dd1374 name: Alert Prediction Policy enabled: false enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm createdBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com userPreferences: displayMode: light createdTime: '2021-05-21T10:16:53+0100' updatedTime: '' seasonalityTimeFrame: 10D example-policy-update: value: id: POLICY-APP-b786fdb7-f675-4253-98ca-66775ed3d1c1 name: Alert Prediction Policy enabled: false enabledMode: 'ON' filterCriteria: {} createdBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com userPreferences: displayMode: light createdTime: '2021-05-21T10:18:56+0100' updatedTime: '' seasonalityTimeFrame: 10D requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the alert prediction policy. enabledMode: type: string enum: - 'ON' - 'OFF' description: 'To enable an alert prediction policy, set "enabledMode": "ON". To disable an alert prediction policy, set "enabledMode: "OFF". ' filterCriteria: type: object description: Filter for resources whose alerts will match this policy. properties: filterBased: description: Determine if the alert prediction policy should consider the below filter rules. type: string matchingType: description: Match ALL or ANY of the rules to filter for resources whose alerts will match this policy. enum: - ALL - ANY type: string rules: type: array description: '(Mandatory if "filterBase": "true") Filter resources with the rules that follow.' items: type: object properties: filterType: type: string description: |- "nativeAttributes": Filter for resources on the basis of predefined attributes. "customAttributes": Filter for resources using custom attributes of device and client. enum: - nativeAttributes - customAttributes - alertCustomAttributes entityName: type: string description: |- Native or custom attribute name. For example, to filter for resources with host_name "VG-Host", use the following: "filterType":"nativeAttributes", "entityName":"host_name", "operator":"CONTAINS", "entityValue":"VG-Host" To filter for resources with a custom attribute"Agent Status", use the following: "filterType":"customAttributes", "entityName":"Agent Status", "operator":"CONTAINS", "entityValue":"Up" Entity names of native attributes: - "dns_name" - "host_name" - "alias_name" - "ip_address" - "resource_type" - "agent_installed" - "operating_system" - "make" - "model" - "alert_source" - "alert_metric" - "device_group" - "service_group" - "site" - "application" For more options, view Get Custom Attributes of a Client API. operator: type: string description: | The logical operators to filter for resources. To filter Windows resources, use "Contains Windows". To filter resources with the agent is installed, use the following: "entityName": "agent_installed", "operator": "Is", "entityValue": "Yes" enum: - Contains - Not Contains - Equals - Not Equals - Starts with - Ends with - Regex - Is entityValue: type: string description: The unique value of the alert. An example would be "VG-Host". seasonalityTimeFrame: description: Predict based on the data for last N days. type: string required: - name examples: example-policy-payload: value: name: Alert Prediction Policy enabledMode: 'ON' filterCriteria: filterBased: 'true' matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm seasonalityTimeFrame: 10D example-policy-update: value: name: Alert Prediction Policy enabledMode: 'ON' seasonalityTimeFrame: 10D operationId: alert_policy_pred_Id_post parameters: - $ref: '#/components/parameters/policyId' - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/policies/firstResponse': summary: Manage First Response Policy Details description: Creates and views first response policydetails of the tenant. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string enabled: type: boolean precedence: type: integer firstResponseType: type: string totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-1: value: results: - id: POLICY-AC-c44f4193-154a-4aa5-b8a9-e5ea5acb386b name: Policy1 enabled: true precedence: 1 firstResponseType: SUPPRESSION - id: POLICY-AC-d53e179d-8c9b-4564-b793-dc639f6a7cf2 name: Policy2 enabled: true precedence: 2 firstResponseType: SUPPRESSION totalResults: 2 orderBy: precedence pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: false parameters: - schema: type: integer in: query name: pageNo - schema: type: integer in: query name: pageSize description: |- Example: - https://server.com/api/v2/tenants/client_4/policies/firstResponse/ - https://server.comp.com/api/v2/tenants/client_4/policies/firstResponse/?pageNo=1&pageSize=100 - https://server.comp.com/api/v2/tenants/msp_3/policies/firstResponse/?pageNo=1&pageSize=100 operationId: get_frp post: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/firstResponse' examples: example-client-policy: value: id: POLICY-AC-d53e179d-8c9b-4564-b793-dc639f6a7cf2 name: firstResponse_1 enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: CIDR Match cidrNotation: 192.168.1.1/24 attributeActions: continuousLearning: true suppress: learnedConfiguration: true suppressDuration: 5 runProcess: learnedConfiguration: true processIds: - PROCESS_9beade88-834a-4229-ab34-90380214cf74 patternActions: suppress: seasonalAlerts: true seasonalityTimeFrame: 7D createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: opsAdmin@opsramp.com updatedBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: opsAdmin@opsramp.com createdTime: '2019-02-28T09:25:56+0000' updatedTime: '2019-02-28T10:14:05+0000' example-partner-policy: value: id: POLICY-AC-5c75b766-6dc3-4998-bf87-81d5fbf31961 name: ml_time clientsIncluded: ALL enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm attributeActions: suppress: learnedConfiguration: true suppressDuration: 5 createdBy: id: USR0000000003 loginName: superadmin lastName: ' ' firstName: Super Admin email: helpdesk@opsramp.com updatedBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com createdTime: '2020-11-05T11:29:23+0000' updatedTime: '2020-11-06T14:00:18+0000' example-msp-all-policy: value: id: POLICY-AC-aa3186cb-5572-43ed-abb9-3ca5a211bcb3 name: partnerPolicy2 clientsIncluded: ALL enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm - filterType: nativeAttributes entityName: alert_occur_freq operator: Less than or equals to alertOccurrenceFreqCondition: alertOccurrenceFrequencey: '1' alertOccurrenceFreqDuration: '2' alertOccurrenceFreqDurationType: hours attributeActions: suppress: learnedConfiguration: true suppressDuration: 5 createdBy: loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com createdTime: '2020-08-17T13:35:28+0530' updatedTime: '' example-custom-attribute: value: id: POLICY-AC-c30bec34-509f-4687-8edc-8fe17095f6ac name: Test Policy1 enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ANY rules: - filterType: alertCustomAttributes entityName: ExternalId operator: Equals entityValue: '10000' createdBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com userPreferences: displayMode: light createdTime: '2023-07-12T10:19:25+0000' updatedTime: '' attributeActions: suppress: learnedConfiguration: false suppressDuration: -1 runProcess: learnedConfiguration: false continuousLearning: false patternActions: suppress: seasonalAlerts: false requestBody: content: application/json: schema: $ref: '#/components/schemas/firstResponse' examples: example-client-policy: value: name: firstResponse_1 enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: CIDR Match cidrNotation: 192.168.1.1/24 attributeActions: continuousLearning: true suppress: learnedConfiguration: true suppressDuration: 5 runProcess: learnedConfiguration: true processIds: - PROCESS_9beade88-834a-4229-ab34-90380214cf74 patternActions: seasonalityTimeFrame: 7D suppress: seasonalAlerts: true example-msp-policy: value: name: partnerPolicy1 organizationMatchingType: INCLUDE includedClients: - client_8 - client_9 enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts With entityValue: vm attributeActions: suppress: suppressDuration: 5 learnedConfiguration: true example-msp-all-policy: value: name: partnerPolicy2 organizationMatchingType: ALL enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts With entityValue: vm - filterType: nativeAttributes entityName: alert_occur_freq operator: Less than or equals to alertOccurrenceFreqCondition: alertOccurrenceFrequencey: '1' alertOccurrenceFreqDuration: '2' alertOccurrenceFreqDurationType: hours attributeActions: suppress: suppressDuration: 5 learnedConfiguration: true example-custom-attribute: value: name: Test FR Policy enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ANY rules: - filterType: alertCustomAttributes entityName: ExternalId operator: Equals entityValue: '10000' attributeActions: suppress: learnedConfiguration: false suppressDuration: -1 description: '' operationId: create_frp parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{tenantId}/policies/firstResponse/{policyId}': summary: Manage First Response Policy by ID description: 'Updates, gets and deletes a first response policy of the tenant by policyId.' delete: tags: - alerts responses: '200': description: OK get: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/firstResponse' examples: example-policy: value: id: POLICY-AC-aa3186cb-5572-43ed-abb9-7830574ee1b2 name: Policy1 enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm attributeActions: continuousLearning: true suppress: learnedConfiguration: true suppressDuration: 5 runProcess: learnedConfiguration: true processIds: - PROCESS_9beade88-834a-4229-ab34-90380214cf74 patternActions: suppress: seasonalAlerts: true seasonalityTimeFrame: 3M createdBy: loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com createdTime: '2020-08-17T13:35:29+0530' updatedTime: '' operationId: frp_details post: tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/firstResponse' examples: example-client-policy: value: id: POLICY-AC-d53e179d-8c9b-4564-b793-dc639f6a7cf2 name: firstResponse_1 enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: CIDR Match cidrNotation: 192.168.1.1/24 attributeActions: continuousLearning: true suppress: learnedConfiguration: true suppressDuration: 5 runProcess: learnedConfiguration: true processIds: - PROCESS_9beade88-834a-4229-ab34-90380214cf74 patternActions: suppress: seasonalAlerts: true seasonalityTimeFrame: 7D createdBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: opsAdmin@opsramp.com updatedBy: loginName: opsramp_api_user lastName: ' ' firstName: OpsRamp API User email: opsAdmin@opsramp.com createdTime: '2019-02-28T09:25:56+0000' updatedTime: '2019-02-28T10:14:05+0000' client_msp-policy-update: value: id: POLICY-AC-5c75b766-6dc3-4998-bf87-81d5fbf31961 name: ml_time clientsIncluded: ALL enabled: true enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm attributeActions: suppress: learnedConfiguration: true suppressDuration: 5 createdBy: id: USR0000000003 loginName: superadmin lastName: ' ' firstName: Super Admin email: helpdesk@opsramp.com updatedBy: id: USR0000000002 loginName: opsramp_api_user lastName: ' ' firstName: API User email: helpdesk@opsramp.com createdTime: '2020-11-05T11:29:23+0000' updatedTime: '2020-11-06T14:00:18+0000' requestBody: content: application/json: schema: $ref: '#/components/schemas/firstResponse' examples: example-client-policy: value: name: firstResponse_1 enabledMode: 'ON' filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: resource_name operator: Starts with entityValue: vm - filterType: nativeAttributes entityName: ip_address ipMatchingConditions: ipAddressMatchType: CIDR Match cidrNotation: 192.168.1.1/24 attributeActions: continuousLearning: true suppress: learnedConfiguration: true suppressDuration: 5 runProcess: learnedConfiguration: true processIds: - PROCESS_9beade88-834a-4229-ab34-90380214cf74 patternActions: seasonalityTimeFrame: 7D suppress: seasonalAlerts: true client_msp-policy-update: value: name: ml_time enabled: true organizationMatchingType: ALL filterCriteria: filterBased: true matchingType: ALL rules: - filterType: nativeAttributes entityName: host_name operator: Starts with entityValue: vm attributeActions: continuousLearning: false suppress: suppressDuration: 5 learnedConfiguration: true description: '' description: |- Example: - https://server.com/api/v2/tenants/client_7/policies/firstResponse/POLICY-AC-3218d82f-25c6-4d4d-bd88-b83c5e30721c - https://server.com/api/v2/tenants/client_7/policies/firstResponse/POLICY-AC-aa3186cb-5572-43ed-abb9-7830574ee1b2 - https://server.com/api/v2/tenants/msp_3/policies/firstResponse/POLICY-AC-5c75b766-6dc3-4998-bf87-81d5fbf31961 operationId: update_policy parameters: - $ref: '#/components/parameters/tenantId' - schema: type: string in: path name: policyId required: true '/api/v2/tenants/{tenantId}/policies/firstResponse/{policyId}/{status}': summary: Enable and Disable First Response Policy description: Enables and disables the first response policy. post: tags: - alerts responses: '200': description: OK description: '' operationId: post_frp_mode parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/policyId' - schema: type: string enum: - enable - disable - observed in: path name: status required: true description: Policy state '/api/v2/tenants/{clientId}/machineLearning/train/{trainingType}': summary: Post the Request for Required Machine Learning Training Type description: |- Initiates the appropirate learning for client resources. ### Notes - Based on the training data one should train - Supported trainings are ALERT_ESCALATION_TRAINING,ALERT_FIRST_RESPONSE_TRAINING,ALERT_CORRELATION_TRAINING post: tags: - alerts responses: '200': description: OK operationId: process_ml_training parameters: - schema: type: string name: trainingType in: path required: true description: Training type option to train the policy - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances': summary: Create Schedule Maintainence Activity description: Creates a different types of recurring maintainence schedule of the client. post: tags: - alerts requestBody: content: application/json: schema: $ref: '#/components/schemas/sm' examples: example-weekly-recurring: value: name: Recurring-weeklyschedule description: Recurring-weeklyschedule runRBA: false installPatch: false correlateAlerts: true devices: - hostName: Device_1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: DG-1 - id: '11' locations: - name: LOC-1 - id: '12' schedule: type: Recurring startTime: '2015-05-28T10:55:27+0000' endTime: '2015-05-29T18:55:27+0000' timezone: America/Puerto_Rico pattern: type: weekly weekDays: 'Wednesday,Thursday' example-one-time: value: name: Onetimeschedule description: Onetimeschedule runRBA: false installPatch: false devices: - hostName: device-1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: DG-1 - id: '11' locations: - name: LOC-1 - id: '12' schedule: type: One-Time startTime: '2015-05-28T10:55:27+0000' endTime: '2016-05-29T18:55:27+0000' timezone: America/New_York example-monthly-recurring-dayOfMonth: value: name: Recurring-monthly-1schedule description: Recurring-monthly-1schedule runRBA: false installPatch: false devices: - hostName: Device_4 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: DG-1 - id: '11' locations: - name: LOC-1 - id: '12' schedule: type: Recurring startTime: '2015-05-28T10:55:27+0000' endTime: '2015-05-29T18:55:27+0000' timezone: America/Puerto_Rico pattern: type: monthly dayOfMonth: '14' example-monthly-recurring-dayOfWeek: value: name: Recurring-monthly-2schedule description: Recurring-monthly-2schedule runRBA: false installPatch: false devices: - hostName: Device_2 - id: '10' deviceGroups: - name: DG-1 - id: '11' locations: - name: LOC-1 - id: '12' schedule: type: Recurring startTime: '2015-05-28T10:55:27+0000' endTime: '2015-05-29T18:55:27+0000' timezone: America/Los_Angeles pattern: type: monthly weekIndex: Third dayOfWeek: Thursday example-daily-recurring: value: name: Recurring-dailyeverydayschedule description: Recurring-dailyeverydayschedule runRBA: false installPatch: false devices: - hostName: Device_1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: DG-1 - id: '11' locations: - name: LOC-1 - id: '12' schedule: type: Recurring startTime: '2015-05-28T10:55:27+0000' endTime: '2015-05-29T18:55:27+0000' timezone: America/Puerto_Rico pattern: type: daily dayFrequency: every weekday example-aliasName: value: name: Onetimeschedule description: Onetimeschedule runRBA: false installPatch: false devices: - aliasName: alias-host-name deviceGroups: - name: DG-1 locations: - name: LOC-1 schedule: type: One-Time startTime: '2015-05-28T10:55:27+0000' endTime: '2016-05-29T18:55:27+0000' timezone: GMT alertConditions: matchingType: ANY rules: - key: subject operator: CONTAINS value: newTest - key: description operator: CONTAINS value: test Description - key: serviceName operator: CONTAINS value: newTest example-all-resources: value: description: Scheduled maintainence for all client resources installPatch: false name: Test Client level SM Policy runRBA: false schedule: startTime: '2022-07-18T14:52:00+0530' endTime: '2022-07-18T14:59:00+0530' timezone: Asia/Calcutta type: One-Time description: '' responses: '200': description: OK content: application/json: schema: type: object properties: uniqueId: type: string examples: example-sm: value: uniqueId: SM-d21b6b44-c85a-426c-9963-0e977070ce98 operationId: create_sm summary: '' description: '' parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances/{smId}': summary: Manage Scheduled Maintenance Windows description: 'Updates, gets and deletes client''s scheduled maintenence windows.' get: description: Gets scheduled maintenance window details. tags: - alerts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/completedSm' examples: example-sm: value: id: '1' uniqueId: SM-12cf031e-ef33-4318-9707-e3f86817f562 name: Sample SM description: Test Schedule dontRunRBA: 'false' dontInstallPatch: 'true' runRBA: true installPatch: false runEscalateAction: true correlateAlerts: true createdTime: '2021-07-25T03:12:02+0000' updatedTime: '' schedule: type: recurring startTime: '2021-10-01T06:00:00+0530' endTime: '2021-10-01T12:00:00+0530' endBy: Never pattern: type: monthly weekIndex: Second dayOfWeek: Wednesday timezone: Asia/Calcutta devices: - id: 4b93211e-776e-4555-811d-ef8a1f300ca0 generalInfo: name: vjp02-kailash-sjc osName: Linux ipAddresses: 172.26.22.95 hostName: vjp02-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: cf98748d-bad9-4469-b21d-db3d521720b3 generalInfo: name: vjp03-kailash-sjc osName: Linux ipAddresses: 172.26.22.96 hostName: vjp03-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE status: Pending operationId: get_sm_details post: description: |- Updates a pending schedule maintenance window. ### Notes - Schedule details can be updated. For example: name, schedule type, and alert conditions. Resource details cannot be updated. - To get the list of pending schedule maintenance windows, use the Search Schedule Maintenance Windows endpoint. - For a recurring schedule maintenance to end at a specific time period, provide the end date and time in the field endTime. Example: "2016-05-29T18:55:27+0000" tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: uniqueId: type: string examples: example-1: value: uniqueId: SM-c11b6b44-c85a-426c-9963-0e977070ce98 requestBody: content: application/json: schema: $ref: '#/components/schemas/smUpdate' examples: example-sm-details: value: name: Network devices schedule maintenance description: Recurring maintenance runRBA: false installPatch: false correlateAlerts: true schedule: type: Recurring startTime: '2018-08-18T10:55:27+0000' endTime: '2018-08-19T18:55:27+0000' timezone: GMT pattern: type: weekly weekDays: 'Wednesday,Thursday' alertConditions: matchingType: ANY rules: - key: subject operator: CONTAINS value: newTest - key: description operator: CONTAINS value: test Description - key: serviceName operator: CONTAINS value: newTest operationId: post_sm_details delete: description: Deletes a scheduled maintenance window. tags: - alerts responses: '200': description: OK operationId: remove_sm_all parameters: - $ref: '#/components/parameters/clientId' - schema: type: string name: smId in: path required: true '/api/v2/tenants/{clientId}/scheduleMaintenances{smId}/resources/{resourcesType}': summary: Get Resources of Schedule Maintenance Windows description: Retrieve the list of devices (or device groups or sites) for a scheduled maintenance window of the client. parameters: - name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier - schema: type: string name: resourcesType in: path required: true description: 'Supported values for resourcetypes (resources,deviceGroups,sites)' - $ref: '#/components/parameters/clientId' get: responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string description: type: string totalResults: type: number pageNo: type: number pageSize: type: number totalPages: type: number nextPage: type: boolean previousPageNo: type: number descendingOrder: type: boolean readOnly: true examples: example-sm-devices: value: results: - id: 4b7e4bc4-2115-4f15-bbd9-642396d486b6 hostName: cn-agent-docker01 ipAddress: 212.328.345.123 type: DOCKER - id: e8893d5c-5448-4123-992f-2a7631a97310 hostName: k8-pool1-wk1 ipAddress: 121.321.435.251 type: DEVICE - id: 66296829-c08d-45fb-9c8c-b6702189611d hostName: WIN7-PC ipAddress: 132.346.768.121 type: DEVICE - id: 9be5120f-f2f7-45d0-88e4-83d67461f751 hostName: HYDLPT272167 ipAddress: 121.345.321.134 type: DEVICE - id: 8016775e-f1b4-47d5-bdd0-e039b115c45f hostName: DBMS10734 ipAddress: 177.162.136.193 type: DEVICE totalResults: 50 pageNo: 1 pageSize: 5 totalPages: 10 nextPage: true nextPageNo: 2 previousPageNo: 0 descendingOrder: false example-sm-deviceGroups: value: results: - id: DGP-98a9dac3-18ae-4456-88d3-e7ffa5ce4ace name: Windows Servers description: '' createdDate: '2018-02-10T10:15:32+0000' updatedDate: '2018-08-02T14:20:10+0000' - id: DGP-6fd28a3f-9f10-4c74-ac15-bd9de54ec056 name: Network Devices description: '' createdDate: '2018-03-13T11:20:50+0000' updatedDate: '2018-08-02T17:15:40+0000' totalResults: 6 pageNo: 1 pageSize: 2 totalPages: 3 nextPage: true nextPageNo: 2 previousPageNo: 0 descendingOrder: false example-sm-sites: value: results: - id: '164' name: Virginia-East description: Server locations in East Virgnia - id: '165' name: California-Central description: Network Centers in California totalResults: 6 pageNo: 1 pageSize: 2 totalPages: 3 nextPage: true nextPageNo: 2 previousPageNo: 0 descendingOrder: false description: '' summary: '' operationId: get_sm_resourcetypes '/api/v2/tenants/{clientId}/scheduleMaintenances/{smId}/end': summary: End Scheduled Maintenance Window description: |- Interrupt the planned schedule maintainence window of the client. ### Notes - User can end only active schedule maintenance windows. - Active schedule maintenance windows that are one-time maintenance windows move to a completed state. - Recurring maintenance windows move to pending state. post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: object properties: uniqueId: type: string status: type: string examples: example-sm-end: value: uniqueId: SM-a7aa1874-ee4f-4a12-add1-2313bd717d4e status: Pending description: '' operationId: post_sm_end parameters: - name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances/{smId}/resume': summary: Resumes Scheduled Maintainence Window description: Resumes a suspended scheduled maintainence window of the client. Only suspended schedule maintenance windows can be resumed. post: tags: - alerts responses: '200': description: OK operationId: post_sm_resume parameters: - name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances/{smId}/suspend': summary: Suspend scheduled maintenance window description: |- Only active client's schedule maintenance windows can be suspended. ### Notes - Dates in date range consider date as yyyy-MM-dd and ignore the time HH: mm: ss. - Send dates (start date & end date) in GMT format. post: tags: - alerts responses: '200': description: OK requestBody: content: application/json: schema: type: object properties: pattern: type: string enum: - now - range startDate: type: string format: date-time endDate: type: string format: date-time examples: example-suspend-now: value: pattern: now example-suspend-date-range: value: pattern: range startDate: '2016-06-18T00:00:00+0000' endDate: '2016-06-19T00:00:00+0000' operationId: post_sm_suspend parameters: - name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances/search': summary: Search Scheduled Maintenance Windows description: Gets the client's scheduled maintenance windows under a specific client. get: tags: - alerts parameters: - $ref: '#/components/parameters/pageNo' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/isDescendingOrder' - $ref: '#/components/parameters/sortName' - $ref: '#/components/parameters/queryString' - schema: type: string in: query name: uniqueId description: Schedule Maintenance window unique ID - schema: type: string in: query name: name description: Schedule Maintenance name - schema: type: string in: query name: startDate description: 'Start date of schedule maintenance. Example: 2016-08-12T10:55:27 0000' - schema: type: string in: query name: endDate description: 'Expiry date of schedule maintenance. Example: 2016-09-15T18:55:27 0000' - schema: type: string in: query name: deviceUniqueId description: Device ID - schema: type: string in: query name: deviceGroupId description: Device group ID - schema: type: string in: query name: deviceGroupName description: Device group name - schema: type: string in: query name: siteId description: Site ID - schema: type: string in: query name: siteName description: Site name - schema: type: string in: query name: startCreationDate description: 'Filter schedule maintenance windows created within a date range. Provide from creation date. Example: 2016-07-24T06:48:40 0000' - schema: type: string in: query name: endCreationDate description: 'Filter schedule maintenance windows created within a date range. Provide to creation date. Example: 2016-07-26T06:48:40 0000' - schema: type: string in: query name: startUpdationDate description: 'Filter schedule maintenance windows updated within a date range. Provide from update date. Example: 2016-07-24T06:48:40 0000' - schema: type: string in: query name: endUpdationDate description: 'Filter schedule maintenance windows updated within a date range. Provide to update date. Example: 2016-07-26T06:48:40 0000' - schema: type: string enum: - Active - Pending - Suspended - Completed example: Active in: query name: status description: 'Filter with scheduled maintenance window status. For example, to get all scheduled maintenance windows that are completed, provide status: Completed in the query string. Supported statuses.' responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/completedSm' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-sm-list: value: results: - id: '1' uniqueId: SM-12cf031e-ef33-4318-9707-e3f86817f562 name: Recurring-Monthly description: Monthly-recurring-never-ends dontRunRBA: 'false' dontInstallPatch: 'true' runRBA: true installPatch: false runEscalateAction: true correlateAlerts: true createdTime: '2021-07-25T03:12:02+0000' updatedTime: '' schedule: type: recurring startTime: '2021-10-01T06:00:00+0530' endTime: '2021-10-01T12:00:00+0530' endBy: Never pattern: type: monthly weekIndex: Second dayOfWeek: Wednesday timezone: Asia/Calcutta devices: - id: 4b93211e-776e-4555-811d-ef8a1f300ca0 generalInfo: name: vjp02-kailash-sjc osName: Linux ipAddresses: 172.26.22.95 hostName: vjp02-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: cf98748d-bad9-4469-b21d-db3d521720b3 generalInfo: name: vjp03-kailash-sjc osName: Linux ipAddresses: 172.26.22.96 hostName: vjp03-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE status: Pending createdBy: 11083 updatedBy: 0 - id: '1' uniqueId: SM-af41af59-277a-4364-a82d-035a351d457f name: Monthly-day-of-month description: Recurring-monthly-day-of-month dontRunRBA: 'true' dontInstallPatch: 'true' runRBA: false installPatch: false runEscalateAction: true correlateAlerts: false createdTime: '2021-07-25T03:11:06+0000' updatedTime: '' schedule: type: recurring startTime: '2021-10-01T09:13:00-0300' endTime: '2021-10-01T14:00:00-0300' endBy: Never pattern: type: monthly dayOfMonth: '02,05,07' timezone: America/Buenos_Aires devices: - id: 5ecd2c90-4689-456c-adb0-02b131c61717 generalInfo: name: vjp01-kailash-sjc osName: Linux ipAddresses: 172.26.22.94 hostName: vjp01-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 4b93211e-776e-4555-811d-ef8a1f300ca0 generalInfo: name: vjp02-kailash-sjc osName: Linux ipAddresses: 172.26.22.95 hostName: vjp02-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 98372573-035f-4a2b-a19b-da778a1a3be5 generalInfo: name: vjp-reports01-kailash-sjc osName: Linux ipAddresses: 172.26.22.90 hostName: vjp-reports01-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 94a31045-a374-41b4-98d3-2e037feb7ccf generalInfo: name: vjp-metricmonitor01-kailash-sjc osName: Linux ipAddresses: 172.26.22.100 hostName: vjp-metricmonitor01-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE status: Pending createdBy: 11083 updatedBy: 0 - id: '1' uniqueId: SM-c3c24f04-035b-4ff3-b162-c835b2b7a89f name: Daily-with-frequency description: Recurring-daily-frequency dontRunRBA: 'true' dontInstallPatch: 'true' runRBA: false installPatch: false runEscalateAction: true createdTime: '2021-07-25T03:09:55+0000' updatedTime: '' schedule: type: recurring startTime: '2021-10-01T04:00:00+0530' endTime: '2021-10-01T15:00:00+0530' endBy: Never pattern: type: daily dayFrequency: everyday repeatFrequency: 5 timezone: Asia/Calcutta devices: - id: 1a1a1884-a719-4d5d-a002-c627087f4902 generalInfo: name: vhdfs03-kailash-sjc osName: Linux ipAddresses: 172.26.22.73 hostName: vhdfs03-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: cf70e6bf-e355-4a64-aec2-12673b533403 generalInfo: name: vapp02-trisul-sjc osName: Ubuntu 18.04.2 LTS ipAddresses: 172.26.17.12 hostName: vapp02-trisul-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: d8baa795-cd1d-4808-a053-185e06f59f59 generalInfo: name: vjp-availability02-kailash-sjc osName: Linux ipAddresses: 172.26.22.103 hostName: vjp-availability02-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 2e40073b-2b16-4278-b897-bbf6f16719ca generalInfo: name: vhdfs02-kailash-sjc osName: Linux ipAddresses: 172.26.22.72 hostName: vhdfs02-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 25c5ca84-26da-4b0b-aba4-cc254bc0e71a generalInfo: name: vjp-alertsla01-kailash-sjc osName: Linux ipAddresses: 172.26.22.97 hostName: vjp-alertsla01-kailash-sjc resourceType: Linux resourceName: '' aliasName: '' clientUniqueId: client_13598 type: DEVICE status: Pending createdBy: 11083 updatedBy: 0 - id: '1' uniqueId: SM-0459dd4c-5d99-4e60-b441-d800a39fcc0a name: Test-recurring-weekly description: Test-weeky-on-given-days dontRunRBA: 'true' dontInstallPatch: 'true' runRBA: false installPatch: false runEscalateAction: true correlateAlerts: false createdTime: '2021-07-25T03:02:41+0000' updatedTime: '' schedule: type: recurring startTime: '2021-10-01T07:00:00+0530' endTime: '2021-11-30T15:00:00+0530' pattern: type: weekly weekDays: 'Sunday,Tuesday,Saturday' timezone: Asia/Calcutta devices: - id: 66ff9621-af3e-495b-9346-09f859c129d9 generalInfo: name: gke-opsqagcp2-default-pool-83b7791b-rer2 ipAddresses: 10.128.15.201 hostName: '' resourceType: Server resourceName: gke-opsqagcp2-default-pool-83b7791b-rer2 aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 13397864-9841-427b-8201-a4a29d2941dc generalInfo: name: gke-kritis-test-default-pool-12cf78c3-odqb ipAddresses: 10.128.15.202 hostName: '' resourceType: Server resourceName: gke-kritis-test-default-pool-12cf78c3-odqb aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 35cea90b-b8d2-4f51-b36f-069fd4b211b0 generalInfo: name: gke-opsqagcp2-default-pool-83b7791b-v12f ipAddresses: 10.128.15.199 hostName: '' resourceType: Server resourceName: gke-opsqagcp2-default-pool-83b7791b-v12f aliasName: '' clientUniqueId: client_13598 type: DEVICE - id: 10cbf9d2-bbab-47ef-9123-317de7a8d8ae generalInfo: name: gke-opsqagcp2-default-pool-83b7791b-6wt0 ipAddresses: 10.128.15.196 hostName: '' resourceType: Server resourceName: gke-opsqagcp2-default-pool-83b7791b-6wt0 aliasName: '' clientUniqueId: client_13598 type: DEVICE status: Pending alertConditions: matchingType: ANY rules: - key: 'Alert : Metric' operator: contains value: ' mysql.innodb.row.lock.waits' - key: 'Alert : Description' operator: equals value: testdec - key: 'Alert : Subject' operator: startswith value: subject policyUniqueId: POLICY-98b09d3b-10a5-45a5-aa0f-323100ce3975 createdBy: 11083 updatedBy: 0 - id: '1' uniqueId: SM-5267d7d8-41f1-4a2d-8b43-9c9d6116b7a7 name: Test-1-weekly description: Test dontRunRBA: 'false' dontInstallPatch: 'false' runRBA: true installPatch: true runEscalateAction: true createdTime: '2021-07-25T02:50:04+0000' updatedTime: '' schedule: type: recurring startTime: '2021-08-12T03:55:27-0700' endTime: '2021-08-29T11:55:27-0700' pattern: type: weekly weekDays: 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday' timezone: America/Los_Angeles devices: - id: 2f006a09-ee6a-424f-a50f-6ca5d5b0a733 generalInfo: name: HYDLPT220 osName: 'Microsoft Windows 10 Pro, 64-bit' ipAddresses: 172.24.133.34 hostName: HYDLPT220 resourceType: Laptop resourceName: '' aliasName: '' osBuildNumber: '17763' clientUniqueId: client_13598 type: DEVICE status: Pending createdBy: 2 updatedBy: 0 - id: '1' uniqueId: SM-151c5fe6-c02e-40eb-b611-6490269277a7 name: Schedule-One-time description: Schedule-One-time dontRunRBA: 'false' dontInstallPatch: 'false' runRBA: true installPatch: true runEscalateAction: true createdTime: '2021-07-24T14:25:04+0000' updatedTime: '' schedule: type: one-time startTime: '2021-09-28T21:00:00-0700' endTime: '2021-09-28T22:00:00-0700' timezone: America/Los_Angeles devices: - id: 2f006a09-ee6a-424f-a50f-6ca5d5b0a733 generalInfo: name: HYDLPT220 osName: 'Microsoft Windows 10 Pro, 64-bit' ipAddresses: 172.24.133.34 hostName: HYDLPT220 resourceType: Laptop resourceName: '' aliasName: '' osBuildNumber: '17763' clientUniqueId: client_13598 type: DEVICE status: Pending createdBy: 2 updatedBy: 0 - id: '1' uniqueId: SM-079e75d3-cbb0-4ae4-a3c6-01dc181adc5b name: Completed-SM-ontime description: Completed-SM dontRunRBA: 'false' dontInstallPatch: 'false' runRBA: true installPatch: true runEscalateAction: true createdTime: '2020-01-28T11:24:07+0000' updatedTime: '' schedule: type: one-time startTime: '2020-01-28T20:00:00-0800' endTime: '2020-01-28T21:00:00-0800' timezone: America/Los_Angeles devices: [] deviceGroups: - name: All Devices description: All Devices createdTime: 1517230206000 status: Completed createdBy: 11943 updatedBy: 0 totalResults: 7 pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true description: '' operationId: sm_search parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/scheduleMaintenances/{smId}/resources': summary: Manage Schedule Maintenance Window Resources description: Adds and deletes client's resources to schedule maintenance window. post: description: |- Adds resources to a scheduled maintenance window. ### Notes - Resources can only be added to Active, Pending, or Suspended scheduled maintenance windows. - To search for scheduled maintenance windows on the basis of status, use the search schedule maintenance API. - Entities can be added such as resource, device group, location to a schedule maintenance window. For example, all resource types such as Server, Storage, Volumes, RedShift, RDS or Lambda services are now supported. - User can add up to 100 resources (device, device group, location) to a schedule maintenance window. tags: - alerts requestBody: content: application/json: schema: description: '' type: object x-examples: example-1: devices: - hostName: device-1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: Network Group - id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af locations: - name: West Virginia - id: '12' properties: devices: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: hostname: type: string - properties: aliasName: type: string - properties: uniqueId: type: string type: object deviceGroups: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 - properties: id: type: string type: object locations: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 - properties: id: type: string type: object examples: example-sm-with-resources: value: devices: - hostName: device-1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: Network Group - id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af locations: - name: West Virginia - id: '12' example-sm-alias-name: value: devices: - hostName: device-1 - uniqueId: 90491678-096c-4223-9867-f31c37ff09da - aliasName: tenantwindows deviceGroups: - name: DG-1 - id: DGP-420a80f4-5fba-46d5-a1c1-20e2df4a326a locations: - name: LOC-1 - id: '12' responses: '200': description: OK operationId: post_sm_resources delete: description: 'Deletes resources from a scheduled maintenance window. Resources can only be removed from Active, Pending, or Suspended scheduled maintenance windows.' tags: - alerts responses: '200': description: OK requestBody: content: application/json: schema: type: object properties: devices: type: array items: anyOf: - properties: hostName: type: string - properties: aliasName: type: string - properties: uniqueId: type: string type: object locations: type: array items: anyOf: - properties: name: type: string - properties: id: type: string type: object deviceGroups: type: array items: anyOf: - properties: name: type: string - properties: id: type: string type: object examples: example-remove-resources: value: devices: - uniqueId: 90491678-096c-4223-9867-f31c37ff09da deviceGroups: - name: DG-1 locations: - name: LOC-1 example-remove-with-aliasname: value: devices: - aliasName: tenantwindows deviceGroups: - name: DG-1 locations: - name: LOC-1 operationId: remove_sm summary: '' parameters: - name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier - $ref: '#/components/parameters/clientId' /api/v2/alertTypes: summary: Get Supported Alert Types description: Gets the list of supported alert types in the platform. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: string examples: example-alerttypes: value: - AGENT - MAINTENANCE - MONITORING - APPLIANCE - SCHEDULED MAINTENANCE - OBSOLETE - FORECAST - CHANGE DETECTION '/api/v2/tenants/{tenantId}/subAlertTypes': summary: Get Sub-Alert Types description: Gets the sub-alert types. post: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: string examples: example-alert-subtypes: value: - AVUD - AVUS - DEFRAG - Device Down - DISK - EVENTLOGS - Hung Server - Memory - Paging File - PATCH DLD - PATCH DLS - PATCH INLD - PATCH INLS - Processor Usage - TEMP parameters: - schema: type: string in: query name: alertTypes description: '{alertType}' parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/alerts/tenants/{clientId}/tickets/{ticketId}': summary: Get Alert Details by Incident ID description: Gets client's alert details by associated incidentId. get: tags: - alerts responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: uniqueId: type: string subject: type: string currentState: type: string serviceName: type: string acknowledged: type: boolean suppressed: type: boolean permanentlySuppressed: type: boolean closed: type: boolean alertType: type: string app: type: string alertTime: type: string format: date-time device: type: object properties: id: type: string name: type: string ipAddress: type: string type: type: string repeatCount: type: string tenantId: type: integer createdTime: type: integer status: type: string priority: type: string elapsedTimeString: type: string healedTimeString: type: string updatedTime: type: string format: date-time tktId: type: string rba: type: boolean tenantName: type: string mspId: type: string rtype: type: string mspName: type: string managedByOpsRamp: type: boolean actedTs: type: integer eventType: type: string metric: type: string inferenceId: type: number examples: example-incident: value: - uniqueId: '40535' subject: chrome.exe | Not Running currentState: Ok serviceName: Windows Process acknowledged: false suppressed: false permanentlySuppressed: false closed: false alertType: Monitoring app: OPSRAMP alertTime: '2015-11-18T09:44:07+0000' device: id: 982b6937-83ae-4262-a023-d6097a711a9e name: HYDLPT204 ipAddress: 172.28.2.148 type: DEVICE repeatCount: '2' tenantId: 107 createdTime: 1447839848946 status: Ticketed priority: N/A elapsedTimeString: '110d 22h 5m ' healedTimeString: '2h 47m ' updatedTime: '2015-11-18T12:31:53+0000' tktId: ticket_1622 rba: false tenantName: Notification_client5 rtype: DEVICE mspId: msp_102 mspName: OpsRamp4.1 managedByOpsRamp: true actedTs: 1448628691167 eventType: ALERT metric: Windows Process inferenceId: 1230 parameters: - name: ticketId in: path required: true schema: type: string format: uuid description: OpsRamp ITSM ticket unique identifier - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/policies/{alertPolicyType}/{policyId}/{mode}': x-internal: true summary: Set Alert Policy Modes description: |- Set Alert Policy Modes using various options ### Notes - User can set the required mode of alert policies - User has to provide the alert policy type as path parameter - Only firstResponse policy supports recommend mode parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of the tenant - name: policyId in: path required: true schema: type: string format: uuid description: Policy unique identifier - name: mode in: path required: true schema: type: string enum: - enable - disable - observed - recommend example: enable description: Describes alert policy mode - $ref: '#/components/parameters/alertPolicyType' post: summary: Set Alert Policy Modes operationId: post-api-v2-tenants-tenantId-policies-alertPolicyType-policyId-modes responses: '200': description: OK x-deprecated: true tags: - alerts components: securitySchemes: accessToken: type: oauth2 flows: clientCredentials: tokenUrl: 'https://subdomain.api.opsramp.com' scopes: {} parameters: tenantId: in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of the tenant policyId: name: policyId in: path required: true schema: type: string format: uuid description: Policy unique identifier alertId: name: alertId in: path required: true schema: type: string format: uuid description: Alert unique Identifier action: name: action in: path required: true schema: type: string enum: - acknowledge - suppress - close - unAcknowledge - unSuppress - heal description: Supported actions on alert userId: name: userId in: path required: true schema: type: string description: Unique uuid for OpsRamp user ticketId: name: ticketId in: path required: true schema: type: string format: uuid description: OpsRamp ITSM ticket unique identifier rosterId: name: rosterId in: path required: true schema: type: string format: uuid description: Roster unique Identifier smId: name: smId in: path required: true schema: type: string format: uuid description: Scheduled maintenance unique identifier trainingType: name: trainingType in: path required: true schema: type: string description: Training type option to train the policy pageNo: name: pageNo in: query required: false schema: type: integer description: Current pagination number pageSize: name: pageSize in: query required: false schema: type: integer description: No of records in each page isDescendingOrder: name: isDescendingOrder in: query required: false schema: type: boolean description: 'Pagination data ordering: true for descending false for ascending' sortName: name: sortName in: query required: false schema: type: string enum: - id - ts - startaltime - c_name - p_name - source - rtype - rname example: id description: Field name on which paginated data is ordered queryString: name: queryString in: query required: true schema: type: string description: Generic query string to be prepared using below query parameters x-more-information-url: / x-more-information-title: See "api-overview" clientId: name: clientId in: path required: true schema: type: string description: Describes the clientId of the tenant alertPolicyType: name: alertPolicyType in: path required: true schema: type: string enum: - alertCorrelation - firstResponse example: alertCorrelation description: Decribes the type of alert policy mode: name: mode in: path required: true schema: type: string enum: - enable - disable - observed example: enable description: Describes alert policy mode alertTypes: name: alertTypes in: query required: false schema: type: string enum: - Monitoring - Maintenance - Appliance - Agent - Scheduled Maintenance - Obsolete - Integration Failure description: Types of alerts states: name: states in: query required: false schema: type: string enum: - Ok - Warning - Critical - Info example: Ok description: Current state of the alert schemas: firstResponse: description: '' type: object title: firstResponse properties: name: type: string minLength: 1 enabledMode: type: string minLength: 1 organizationMatchingType: type: string matchingType: type: string filterCriteria: type: object properties: filterBased: type: boolean matchingType: type: string minLength: 1 enum: - ANY - ALL default: ANY example: ANY rules: type: array uniqueItems: true minItems: 1 items: type: object properties: filterType: type: string minLength: 1 enum: - nativeAttributes - customAttributes - alertCustomAttributes example: nativeAttributes entityName: type: string minLength: 1 enum: - dns_name - resource_name - alias_name - ip_address - resource_type - agent_installed - operating_system - make - model - alert_source - alert_metric - alert_component - device_group - service_group - site - application - alert_subject - alert_description - host_name - alert_occur_freq operator: type: string minLength: 1 enum: - Contains - Starts With - Starts with - Not Contains - Equals - Not Equals - Ends With - Regex - Less than or equals to example: Contains entityValue: type: string minLength: 1 alertOccurrenceFreqCondition: type: object description: Alert Frequency counter to invoke First Response policy properties: alertOccurrenceFrequencey: type: string description: 'Alerts triggered ' alertOccurrenceFreqDuration: type: string description: | Frequency duration alertOccurrenceFreqDurationType: type: string description: | Duration unit enum: - hours - days - weeks example: hours attributeActions: type: object properties: continuousLearning: type: boolean suppress: type: object properties: learnedConfiguration: type: boolean suppressDuration: type: number runProcess: type: object description: Can only be used for client level policy properties: learnedConfiguration: type: boolean processIds: type: array items: type: string patternActions: type: object description: Can only be used for client level policy properties: seasonalityTimeFrame: type: string minLength: 1 description: This property will be applicable only when seasonalAlerts is set to true. D represents Days. M reresents Months. enum: - 7D - 10D - 30D - 60D - 90D - 3M example: 90D suppress: type: object properties: seasonalAlerts: type: boolean default: false createdBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string updatedBy: type: object properties: loginName: type: string lastName: type: string firstName: type: string email: type: string createdTime: type: string updatedTime: type: string alertPrediction: description: '' type: object title: alertPrediction properties: name: type: string minLength: 1 description: The name of the alert prediction policy. id: type: string description: uuid of the policy. seasonalityTimeFrame: type: string minLength: 1 default: 90D enum: - 10D - 30D - 60D - 90D - 7D example: 90D description: Learning based on the data for last N days. enabledMode: type: string description: 'To enable an alert prediction policy, set "enabledMode": "ON". To disable an alert prediction policy, set "enabledMode: "OFF"' filterCriteria: type: object description: Determine if the alert prediction policy should consider the below filter rules. properties: filterBased: type: string description: Enable filter based rules. matchingType: type: string minLength: 1 description: Match ALL or ANY of the rules to filter for resources whose alerts will match this policy. rules: type: array uniqueItems: true minItems: 1 items: type: object description: '(Mandatory if "filterBase": "true") Filter resources with the rules that follow.' properties: filterType: type: string minLength: 1 enum: - nativeAttributes - customAttributes - alertCustomAttributes example: customAttributes entityName: type: string minLength: 1 enum: - dns_name - resource_name - alias_name - ip_address - resource_type - agent_installed - operating_system - make - model - alert_metric - alert_component - device_group - service_group - site - applicatio operator: type: string minLength: 1 enum: - Contains - Not Contains - Equals - Not Equals - Starts With - Ends With - Regex default: Contains entityValue: type: string minLength: 1 required: - name resource: title: resource type: object properties: id: type: string name: type: string type: type: string resourceType: type: string aliasName: type: string hostName: type: string managedResource: description: '' type: object properties: hostName: type: string minLength: 1 resourceUUID: type: string minLength: 1 providerUUID: type: string minLength: 1 systemUUID: type: string minLength: 1 macAddress: type: string minLength: 1 ipAddress: type: string minLength: 1 required: - hostName - resourceUUID - providerUUID - systemUUID - macAddress - ipAddress x-examples: example-1: hostName: Think-pad resourceUUID: DEV0000011767 providerUUID: '11767' systemUUID: '11767' macAddress: '2E:8B:EB:32:7A:F9' ipAddress: 172.2.229.109 escalationObject: description: '' type: object properties: waitMins: type: number priority: type: string enum: - Low - Normal - High - Urgent - Very Low repeatFrequency: type: integer action: type: string minLength: 1 enum: - INCIDENT - NOTIFICATION recipients: type: array items: $ref: '#/components/schemas/receiver' updateIncident: type: object properties: withAlertState: type: string deprecated: true enum: - 'true' - 'false' example: 'true' autoResolveIncident: type: string description: Auto resolve issue when alert stated is closed. Replaces "withAlertState property". enum: - 'true' - 'false' example: 'true' none: type: string deprecated: true enum: - 'true' - 'false' example: 'true' updateWhenAlertStateChange: type: string description: The latest alert description is appended to the conversation of the incident. No change to the status of the incident is made based on the escalated alert state.Replaces "none". enum: - 'true' - 'false' example: 'false' updateForEveryRepeatAlert: type: string description: ' The incident is updated with every repeated alert’s description irrespective of the alert state. ' enum: - 'true' - 'false' example: 'true' priorityRules: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/priorityRule' notifyIncident: type: string minLength: 1 incident: $ref: '#/components/schemas/incidentObject' notifyLimitCount: type: number alertStateTransitionFrom: type: string filter: description: '' type: object x-examples: example-filter-type1: matchingType: ANY rules: - key: 'Alert : State' operator: CONTAINS value: string example-filter-type2: matchingType: ANY rules: - key: string operator: CONTAINS value: frequency: string occurrences: string frequencyType: string properties: matchingType: type: string minLength: 1 enum: - ANY - ALL description: Matching rule rules: type: array uniqueItems: true minItems: 1 description: Filter criteria object items: anyOf: - $ref: '#/components/schemas/filterKeyObject' - $ref: '#/components/schemas/filterKeystring' filteringRules: type: object description: '' x-examples: example-1: matchingType: ANY rules: - {} properties: matchingType: type: string minLength: 1 enum: - ANY - ALL rules: type: array items: anyOf: - $ref: '#/components/schemas/filterKeystring' - $ref: '#/components/schemas/filterKeyObject' smFilter: description: '' type: object properties: matchingType: type: string minLength: 1 enum: - ANY - ALL rules: type: array uniqueItems: true minItems: 0 items: oneOf: - $ref: '#/components/schemas/filterKeystring' - $ref: '#/components/schemas/filterKeyObject' policyUniqueId: type: string required: - matchingType - rules alertCondition: description: '' type: object title: '' properties: matchingType: type: string minLength: 1 enum: - ANY - ALL rules: type: array uniqueItems: true minItems: 0 items: type: object properties: key: type: string minLength: 1 enum: - subject - description - serviceName operator: type: string minLength: 1 value: type: string policyUniqueId: type: string incidentObject: type: object properties: priority: type: string minLength: 1 enum: - Low - Normal - High - Urgent - Very Low assigneeGroup: type: object properties: uniqueId: type: string minLength: 1 name: type: string minLength: 1 assignedUser: type: object properties: id: type: string minLength: 1 loginName: type: string minLength: 1 businessImpact: type: object properties: uniqueId: type: string minLength: 1 urgency: type: object properties: uniqueId: type: string minLength: 1 customFields: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 value: type: string minLength: 1 cc: type: string minLength: 1 toEmail: type: string minLength: 1 category: type: object properties: uniqueId: type: string subCategory: type: object properties: uniqueId: type: string priorityRule: description: '' type: object x-examples: example-1: key: currentState.code operator: Is value: Warning businessImpact: uniqueId: SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f urgency: uniqueId: SURG-09358506-4af1-4d35-b902-cd3b14a00c10 priority: High properties: key: type: string minLength: 1 operator: type: string minLength: 1 value: type: string minLength: 1 businessImpact: type: object properties: uniqueId: type: string minLength: 1 urgency: type: object properties: uniqueId: type: string minLength: 1 priority: type: string minLength: 1 receiver: description: '' type: object x-examples: example-1: id: USR0000000028 name: API_User type: USER properties: id: type: string minLength: 1 name: type: string minLength: 1 type: type: string minLength: 1 escalatedPolicy: description: Escalation policy uuid type: object properties: id: type: string minLength: 1 description: Escalation policy uuid name: type: string minLength: 1 description: Escalation policy name description: type: string description: Description details of escalation policy policyType: type: string minLength: 1 enum: - ESCALATION_POLICY description: Policy type clientMatchingType: type: string minLength: 1 description: Included clients.Default value all i..e all the serviced clients. updatedDate: type: string minLength: 1 description: Last updated time createdDate: type: string minLength: 1 description: Last created time active: type: boolean description: Is policy active escalationType: type: string minLength: 1 enum: - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED - MANUAL - AUTOMATIC description: Automated notifications types for recipient users allClients: type: boolean description: Include partner polices resources: type: array uniqueItems: true minItems: 1 description: Resource details items: $ref: '#/components/schemas/resource' scope: $ref: '#/components/schemas/policyScope' enabledMode: type: string enum: - 'ON' - 'OFF' - RECOMMEND - OBSERVED default: 'ON' createdBy: $ref: '#/components/schemas/changesBy' updatedBy: $ref: '#/components/schemas/changesBy' filterCriteria: $ref: '#/components/schemas/filteringRules' escalations: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/escalationObject' required: - id - policyType escalationPolicy: type: object title: escalationPolicy description: '' properties: id: type: string name: type: string description: type: string escalationType: type: string enum: - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED - AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED - MANUAL - AUTOMATIC description: Automated notifications for recipient users policyType: type: string enum: - ESCALATION_POLICY createdDate: type: string updatedDate: type: string active: type: boolean default: true enabledMode: type: string enum: - 'OFF' - 'ON' - RECOMMEND - OBSERVED default: 'ON' resources: type: array description: Used to define different resources to apply the escalate alert policy. items: $ref: '#/components/schemas/resource' escalations: type: array description: Used to define the users for escalated alerts notifications. items: $ref: '#/components/schemas/escalationObject' filterCriteria: $ref: '#/components/schemas/filter' allClients: type: boolean default: true updatedBy: $ref: '#/components/schemas/changesBy' createdBy: $ref: '#/components/schemas/changesBy' required: - name - escalationType - resources - escalations policyScope: description: '' type: object x-examples: example-1: id: 13593 uniqueId: msp_13593 name: SQALab activated: true isMSP: true isClient: false isServiceProvider: false isSolutionProvider: false properties: id: type: number uniqueId: type: string minLength: 1 name: type: string minLength: 1 activated: type: boolean default: true isMSP: type: boolean default: true isClient: type: boolean default: false isServiceProvider: type: boolean default: false isSolutionProvider: type: boolean default: false required: - name changesBy: description: '' type: object properties: id: type: string minLength: 1 loginName: type: string minLength: 1 lastName: type: string minLength: 1 firstName: type: string minLength: 1 email: type: string minLength: 1 userPreferences: type: object properties: displayMode: type: string minLength: 1 smSchedule: description: '' type: object properties: endTime: type: string minLength: 1 description: 'UTC/GMT time or time with timezone offset Eg:"2021-09-09T19:00:00+0000" for GMT/UTC time or "2021-09-09T13:00:00-0600" for America/Denver timezone ' startTime: type: string minLength: 1 description: 'UTC/GMT time or time with timezone offset Eg:"2021-09-09T19:00:00+0000" for GMT/UTC time or "2021-09-09T13:00:00-0600" for America/Denver timezone ' timezone: type: string minLength: 1 description: 'Timezone for which the user wants to set as Local time.For eg "timezone": "America/Denver will let the users get the local time in America/Denver Timezone ' enum: - Pacific/Honolulu - America/Anchorage - America/Puerto_Rico - America/Los_Angeles - America/Denver - America/Chicago - America/New_York - America/Buenos_Aires - Atlantic/Azores - GMT - Europe/Paris - Europe/Istanbul - Africa/Addis_Ababa - Asia/Tehran - Asia/Yerevan - Asia/Karachi - Asia/Calcutta - Asia/Dacca - Asia/Shanghai - Asia/Tokyo - Australia/Darwin - Australia/Sydney - Pacific/Guadalcanal - Pacific/Auckland - Pacific/Apia type: type: string minLength: 1 enum: - Recurring - One-Time - recurring - one-time description: Recurrence type pattern: type: object description: 'Recurrence pattern object ' properties: type: type: string minLength: 1 enum: - daily - weekly - monthly description: Recurrence type weekDays: type: string minLength: 1 description: 'Weekday(s) in csv for eg Wednesday,Thursday or Thursday ' dayOfMonth: type: string description: Numeric day of month weekIndex: type: string enum: - First - Second - Third - Fourth - Last description: Week Number dayOfWeek: type: string description: Day of the Week dayFrequency: type: string enum: - everyday - every weekday description: Repeat frequency sm: description: '' type: object x-examples: example-1: description: Recurring-monthly-2schedule deviceGroups: - name: DG-1 - id: '11' devices: - hostName: Device_2 - id: '10' installPatch: 'false' locations: - name: LOC-1 - id: '12' name: Recurring-monthly-2schedule runRBA: 'false' schedule: endTime: '2015-05-29T18:55:27+0000' pattern: dayOfWeek: Thursday type: monthly weekIndex: Third startTime: '2015-05-28T10:55:27+0000' timezone: America/Los_Angeles type: Recurring value: description: Recurring-monthly-2schedule deviceGroups: - name: DG-1 - id: '11' devices: - hostName: Device_2 - id: '10' installPatch: 'false' locations: - name: LOC-1 - id: '12' name: Recurring-monthly-2schedule runRBA: 'false' schedule: endTime: '2015-05-29T18:55:27+0000' pattern: dayOfWeek: Thursday type: monthly weekIndex: Third startTime: '2015-05-28T10:55:27+0000' timezone: America/Los_Angeles type: Recurring example-2: uniqueId: string name: string description: string installPatch: true dontInstallPatch: string runRBA: true runEscalateAction: true schedule: endTime: string startTime: string timezone: Pacific/Honolulu type: Recurring pattern: type: daily weekDays: string dayOfMonth: string weekIndex: First dayOfWeek: string dayFrequency: everyday dontRunRBA: string devices: - hostName: string deviceGroups: - name: string locations: - name: string alertConditions: matchingType: ANY rules: - key: subject operator: string value: string policyUniqueId: string properties: uniqueId: type: string name: type: string minLength: 1 description: type: string minLength: 1 installPatch: type: boolean description: Install patch during maintenance. dontInstallPatch: type: string description: Install patch during maintenance readOnly: true runRBA: type: boolean runEscalateAction: type: boolean description: Enable escalation policy dontRunRBA: type: string description: Enable run book automation readOnly: true correlateAlerts: type: boolean description: Enable correlation during scheduled maintenance. default: false schedule: $ref: '#/components/schemas/smSchedule' devices: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: hostName: type: string minLength: 1 - properties: aliasName: type: string - properties: uniqueId: type: string type: object deviceGroups: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 - properties: id: type: string type: object locations: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 - properties: id: type: string type: object alertConditions: $ref: '#/components/schemas/alertCondition' required: - name - description - schedule smUpdate: description: '' type: object x-examples: example-1: description: Recurring-monthly-2schedule deviceGroups: - name: DG-1 - id: '11' devices: - hostName: Device_2 - id: '10' installPatch: 'false' locations: - name: LOC-1 - id: '12' name: Recurring-monthly-2schedule runRBA: 'false' schedule: endTime: '2015-05-29T18:55:27+0000' pattern: dayOfWeek: Thursday type: monthly weekIndex: Third startTime: '2015-05-28T10:55:27+0000' timezone: America/Los_Angeles type: Recurring value: description: Recurring-monthly-2schedule deviceGroups: - name: DG-1 - id: '11' devices: - hostName: Device_2 - id: '10' installPatch: 'false' locations: - name: LOC-1 - id: '12' name: Recurring-monthly-2schedule runRBA: 'false' schedule: endTime: '2015-05-29T18:55:27+0000' pattern: dayOfWeek: Thursday type: monthly weekIndex: Third startTime: '2015-05-28T10:55:27+0000' timezone: America/Los_Angeles type: Recurring properties: uniqueId: type: string name: type: string minLength: 1 description: type: string minLength: 1 installPatch: type: boolean dontInstallPatch: type: string runRBA: type: boolean runEscalateAction: type: boolean correlateAlerts: type: boolean description: 'Enable correlation during maintainence ' default: false schedule: $ref: '#/components/schemas/smSchedule' dontRunRBA: type: string alertConditions: $ref: '#/components/schemas/alertCondition' required: - name - description - schedule completedSm: description: '' type: object properties: id: type: string uniqueId: type: string name: type: string minLength: 1 description: type: string minLength: 1 installPatch: type: boolean dontInstallPatch: type: string runRBA: type: boolean dontRunRBA: type: string runEscalateAction: type: boolean correlateAlerts: type: boolean default: false description: Enable correlation during maintainence schedule: $ref: '#/components/schemas/smSchedule' deviceGroups: type: array uniqueItems: true minItems: 1 items: type: object properties: name: type: string minLength: 1 required: - name locations: type: array uniqueItems: true minItems: 1 items: type: object properties: name: type: string minLength: 1 required: - name alertConditions: $ref: '#/components/schemas/alertCondition' status: type: string enum: - Completed - Active - Pending - Suspended default: Active createdTime: type: string updatedTime: type: string createdBy: type: number updatedBy: type: number policyUniqueId: type: string devices: type: array uniqueItems: true minItems: 0 items: type: object properties: hostName: type: string minLength: 1 required: - name - description - schedule - devices smResources: description: '' anyOf: - properties: devices: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: hostName: type: string minLength: 1 required: - hostName - properties: uniqueId: type: string type: object required: - devices - properties: deviceGroups: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 required: - name - properties: id: type: string type: object required: - deviceGroups - properties: locations: type: array uniqueItems: true minItems: 1 items: anyOf: - properties: name: type: string minLength: 1 required: - name - properties: id: type: string type: object required: - locations type: object smDevice: description: '' type: object x-examples: example-1: id: 2f006a09-ee6a-424f-a50f-6ca5d5b0a733 generalInfo: name: HYDLPT220 osName: 'Microsoft Windows 10 Pro, 64-bit' ipAddresses: 172.24.133.34 hostName: HYDLPT220 resourceType: Laptop resourceName: '' aliasName: '' osBuildNumber: '17763' clientUniqueId: client_13598 type: DEVICE properties: id: type: string minLength: 1 generalInfo: type: object properties: name: type: string minLength: 1 osName: type: string minLength: 1 ipAddresses: type: string minLength: 1 hostName: type: string minLength: 1 resourceType: type: string minLength: 1 resourceName: type: string aliasName: type: string osBuildNumber: type: string minLength: 1 clientUniqueId: type: string minLength: 1 type: type: string minLength: 1 alerted: type: object description: '' properties: uniqueId: type: string minLength: 1 description: Alert uuid currentState: type: string minLength: 1 description: Alert current state serviceName: type: string minLength: 1 description: Alert Metric subject: type: string minLength: 1 description: Alert Subject app: type: string minLength: 1 description: 'Event source name which generates alert, For eg External monitoring tool like SCOM' description: type: string minLength: 1 description: Alert description details oldState: type: string minLength: 1 description: Alert previous state from current sta problemArea: type: string minLength: 1 acknowledged: type: boolean description: Alert akcnowledged suppressed: type: boolean description: Alert suppressed permanentlySuppressed: type: boolean closed: type: boolean ticketed: type: boolean description: Alert has incident created clientUniqueId: type: string minLength: 1 description: Tenant uuid alertType: type: string minLength: 1 enum: - Agent - Obsolete - Appliance - Monitoring - Scheduled Maintenance - Forecast - Change Detection - MONITORING - Maintenance example: Monitoring description: OpsRamp Alerting type component: type: string minLength: 1 description: Component from which alert got generated alertTime: type: string minLength: 1 description: Time when alert was generated at source device: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 hostName: type: string minLength: 1 ipAddress: type: string type: type: string minLength: 1 aliasName: type: string resourceName: type: string resourceType: type: string minLength: 1 resource: type: object description: Resource Object details properties: id: type: string minLength: 1 description: 'Resource ' hostName: type: string minLength: 1 description: Resource hostname ipAddress: type: string description: Resource IP address dns: type: string description: Resource DNS type: type: string minLength: 1 state: type: string minLength: 1 description: Resource state make: type: string description: Make of the Resource osName: type: string description: Resource OS description: type: string source: type: string minLength: 1 agentInstalled: type: boolean description: Agent installed resource status: type: string minLength: 1 aliasName: type: string description: Resource Alias name tags: type: array items: type: object name: type: string minLength: 1 resourceName: type: string generalInfo: type: object description: Resource generalInfo object details properties: name: type: string minLength: 1 hostName: type: string minLength: 1 resourceType: type: string minLength: 1 resourcePath: type: string minLength: 1 resourceName: type: string aliasName: type: string createdTime: type: string minLength: 1 updatedTime: type: string assetManagedTime: type: string minLength: 1 firstAssetManagedTime: type: string minLength: 1 consoles: type: array items: type: object clientUniqueId: type: string minLength: 1 resourceType: type: string minLength: 1 resourcePath: type: string minLength: 1 alternateIp: type: string frequency: type: number paused: type: boolean deleted: type: boolean validateSSL: type: boolean port: type: number encrypted: type: boolean timeout: type: number ts: type: number clientId: type: number locationOffset: type: number totalLocations: type: number receiverHostPort: type: number topologyEnabled: type: boolean device: type: boolean excludeIndexing: type: boolean cloudInstance: type: boolean saId: type: number extResourceId: type: string description: Unique cloud resource identifier. Mandatory for cloud resources like Azure cloud resource to reconcile with scheduled cloud resource discov. monitorName: type: string minLength: 1 description: Applied monitor name for monitori repeatCount: type: string minLength: 1 description: Count of the alerts occured with similar state tenantId: type: number status: type: string minLength: 1 priority: type: string minLength: 1 enum: - P0 - P1 - P2 - P3 - P4 - P5 - N/A description: Alert priority elapsedTimeString: type: string minLength: 1 createdDate: type: string minLength: 1 updatedTime: type: string minLength: 1 rba: type: boolean description: Run book automation applied tenantName: type: string minLength: 1 rtype: type: string minLength: 1 entityType: type: string minLength: 1 mspName: type: string minLength: 1 extAlertId: type: string managedByOpsRamp: type: boolean actedTs: type: number metricTime: type: number eventType: type: string minLength: 1 enum: - ALERT - RCA - Inference - Alert - INFERENCE example: ALERT inferenceId: type: number ignoreRecoveryNoise: type: boolean availability: type: boolean snoozeDuration: type: number metric: type: string minLength: 1 isRecoveryAlert: type: boolean inferenceAlert: type: boolean statusHistory: type: object description: Alert history properties: createdBy: type: string minLength: 1 createdTime: type: string minLength: 1 ticketedBy: type: string ticketedTime: type: string clientTechnology: type: string minLength: 1 customFields: type: array items: type: object required: - currentState - serviceName - subject - app readOnly: true alertedResource: description: '' type: object x-examples: example-1: id: 336a5197-c8d8-46d0-9953-ebf95dd8046b hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' dns: '' type: Other state: active make: '' osName: '' description: '' source: ALERT agentInstalled: false status: UNDEFINED aliasName: '' tags: [] name: jmeter-pv-us-ctl-vm01 resourceName: '' generalInfo: name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 resourceType: Other resourcePath: Other resourceName: '' aliasName: '' createdTime: '2021-05-23T13:39:12+0000' updatedTime: '' assetManagedTime: '2021-05-23T13:39:12+0000' firstAssetManagedTime: '2021-05-23T13:39:12+0000' consoles: [] clientUniqueId: client_22568 resourceType: Other resourcePath: Other alternateIp: '' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 properties: id: type: string minLength: 1 hostName: type: string minLength: 1 ipAddress: type: string dns: type: string type: type: string minLength: 1 state: type: string minLength: 1 make: type: string osName: type: string description: type: string source: type: string minLength: 1 agentInstalled: type: boolean status: type: string minLength: 1 aliasName: type: string tags: type: array items: type: object name: type: string minLength: 1 resourceName: type: string generalInfo: type: object properties: name: type: string minLength: 1 hostName: type: string minLength: 1 resourceType: type: string minLength: 1 resourcePath: type: string minLength: 1 resourceName: type: string aliasName: type: string createdTime: type: string minLength: 1 updatedTime: type: string assetManagedTime: type: string minLength: 1 firstAssetManagedTime: type: string minLength: 1 consoles: type: array items: type: object clientUniqueId: type: string minLength: 1 resourceType: type: string minLength: 1 resourcePath: type: string minLength: 1 alternateIp: type: string frequency: type: number paused: type: boolean deleted: type: boolean validateSSL: type: boolean port: type: number encrypted: type: boolean timeout: type: number ts: type: number clientId: type: number locationOffset: type: number totalLocations: type: number receiverHostPort: type: number topologyEnabled: type: boolean device: type: boolean excludeIndexing: type: boolean cloudInstance: type: boolean saId: type: number required: - id alertedDevice: description: '' type: object x-examples: example-1: id: '9297503' name: jmeter-pv-us-ctl-vm01 hostName: jmeter-pv-us-ctl-vm01 ipAddress: '' type: DEVICE aliasName: '' resourceName: '' resourceType: Other properties: id: type: string minLength: 1 name: type: string minLength: 1 hostName: type: string minLength: 1 ipAddress: type: string type: type: string minLength: 1 aliasName: type: string resourceName: type: string resourceType: type: string minLength: 1 required: - id frp: description: '' type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 enabled: type: boolean precedence: type: number firstResponseType: type: string minLength: 1 required: - id - name - enabled - precedence - firstResponseType x-examples: example-1: id: POLICY-AC-c44f4193-154a-4aa5-b8a9-e5ea5acb386b name: Policy1 enabled: true precedence: 1 firstResponseType: SUPPRESSION rosterShift: description: '' type: object x-examples: example-1: name: Evening shift schedule: type: recurring startDate: '2018-03-06T00:00:00+0000' startTime: '16:30:00' endTime: '01:30:10' pattern: type: weekly weekDays: 'Wednesday,Thursday,Friday' repeatFrequency: 5 endPattern: type: NEVER users: - id: USR0000000020 userGroups: - uniqueId: USRGRP-48965gg5-8fg6-a3aa-e288-0d3667e36f5 properties: name: type: string minLength: 1 id: type: string schedule: type: object properties: type: type: string minLength: 1 enum: - recurring - one-time startDate: type: string minLength: 1 startTime: type: string minLength: 1 endTime: type: string minLength: 1 pattern: type: object required: - type - weekDays - repeatFrequency properties: type: type: string minLength: 1 enum: - weekly weekDays: type: string minLength: 1 repeatFrequency: type: number startDate: type: string endPattern: type: string repeatType: type: string weekIndex: type: string dayOfWeek: type: string dayOfMonth: type: string endPattern: type: object required: - type properties: type: type: string minLength: 1 users: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: string minLength: 1 required: - id userGroups: type: array uniqueItems: true minItems: 1 items: type: object properties: uniqueId: type: string minLength: 1 required: - uniqueId required: - name - users filterKeystring: type: object title: filterKeystring description: '' properties: isNativeAttribute: type: boolean description: true if attributes are not custom attributes. key: type: string enum: - 'Alert : State' - 'Alert : Description' - 'Alert : Occurrence Frequency' - 'Resource : Resource Type' - 'Alert : Source' - 'Alert : Created Date' - 'Alert : Event Type' - 'Alert : Healed Time' - 'Alert : Metric' - 'Alert : No of Occurrence' - 'Alert : Subject' - 'Alert : Type' - 'Alert : Update Time' - 'Resource : Aws Instance Name' - 'Resource : Instance Id' - 'Resource : Resource IP' - 'Resource : Resource Name' - 'Alert : Description' - Business Hours - test_cutom_attribute description: Supports enum values as key along with any string value defined for custom attributes. operator: type: string enum: - CONTAINS - MATCH - Contains - GREATERTHANOREQUALTO - IS - Is value: type: string filterKeyObject: type: object title: filterKeystring additionalProperties: false description: '' properties: isNativeAttribute: type: boolean default: true description: true if attributes are not custom attributes. key: type: string operator: type: string enum: - CONTAINS - MATCH - Contains - GREATERTHANOREQUALTO value: type: object properties: frequency: type: string occurrences: type: string frequencyType: type: string valRObj: description: '' oneOf: - type: object properties: occurrences: type: string minLength: 1 frequency: type: string minLength: 1 frequencyType: type: string minLength: 1 - type: string alertView: description: '' type: object properties: id: type: number name: type: string description: type: string createdOn: type: string createdBy: type: object properties: id: type: string minLength: 1 loginName: type: string minLength: 1 lastName: type: string minLength: 1 firstName: type: string minLength: 1 email: type: string phoneNumber: type: string userPreferences: type: object properties: dateFormat: type: string minLength: 1 displayMode: type: string minLength: 1 viewType: type: string minLength: 1 partners: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: number uniqueId: type: string minLength: 1 name: type: string minLength: 1 activated: type: boolean featureFlags: type: object clients: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: number uniqueId: type: string minLength: 1 name: type: string minLength: 1 activated: type: boolean offlineAlertstoThirdPartyTool: type: boolean uuid: type: string minLength: 1 addOns: type: array uniqueItems: true minItems: 1 items: type: string packages: type: array uniqueItems: true minItems: 1 items: type: string webConsoles: type: boolean locations: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: number name: type: string minLength: 1 clientId: type: number mspId: type: number city: type: string minLength: 1 path: type: string minLength: 1 uuid: type: string minLength: 1 alertTimestamp: type: string minLength: 1 duration: type: string minLength: 1 resourceOrgin: type: string minLength: 1 availability: type: string minLength: 1 defaultView: type: boolean requestBodies: {} responses: {}