openapi: 3.0.0 info: title: Monitoring Management version: 2.0.0 description: Monitoring Management API Documentation contact: name: OpsRamp Support email: support@opsramp.com url: 'https://www.opsramp.com/about-opsramp/contact-us/' tags: - name: monitoring description: Monitoring API Documentation. externalDocs: url: 'https://develop.opsramp.com/monitoring/' 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: '/monitoring/api/v3/tenants/{tenantId}/templates': x-new-path: true summary: templates description: Create templates post: summary: Create monitors tags: - monitoring operationId: templates_create description: |- Creating monitoring template - Pre-requisites - Existing Metrics - Existing Monitors - For Synthetic templates - Protocol info is must requestBody: $ref: '#/components/requestBodies/templateReq' responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string name: type: string examples: example-templates: value: id: d4b52bf1-c89f-4eaa-b089-8d0a2f1b48c5 template-name: Test Monitor Template '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string message: type: string examples: example-failed: value: code: '1205405' message: 'Template creation failed :- Invalid Monitor' parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{clientId}/templates/{id}': x-new-path: true summary: 'templates/{id}' description: 'Get,Update and delete client scoped Templates' parameters: - schema: type: string name: id in: path required: true description: Template uuid - $ref: '#/components/parameters/clientId' delete: summary: '' operationId: delete-api-v2-tenants-clientId-monitoring-monitors-id responses: '200': description: OK '400': description: Bad Request content: application/json: schema: type: object properties: code: type: string message: type: string examples: example-failed: value: code: code message: Delete failed description: | Deletes a template or removes template attributes ### Notes - Users cannot delete assigned templates. - Removes unassigned templates only. put: summary: '' operationId: put-api-v2-tenants-clientId-monitoring-monitors-id responses: '200': $ref: '#/components/responses/template-response' requestBody: content: application/json: schema: $ref: '#/components/schemas/update-template' examples: example-monitor-update: value: name: OpsRamp Gateway Performance Template description: 'Monitors basic UNIX parameters like UNIXCPU, UNIXSTORAGE, UNIXUPTIME, UNIXMEMORY, UNIXLOAD and UNIXStats' status: state: ACTIVE eolDate: DATE tags: Performance Monitors templateFamily: Performance Monitors Family notes: Sample notes related to performance monitors monitors: - name: CPU Stats - UCD-SNMP-MIB frequency: 1 thresholdType: Static metricName: system.unix.cpu.stats.idle operation: REMOVE - name: Host System Uptime frequency: 5 thresholdType: Static metricName: system.uptime operation: UPDATE thresholds: - criticalThreshold: 1800 warningThreshold: 10 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: NONE raiseAlert: true availability: true levelType: TEMPLATE example-synthetics-monitor-update: value: monitors: - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.time unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 200 warningThreshold: 100 repeatCount: 1 raiseAlert: true levelType: TEMPLATE_COMPONENT location: synthetic-public operation: remove - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: availability.down.locations.count unit: count thresholds: - criticalThreshold: 90 warningThreshold: 60 repeatCount: 3 raiseAlert: true levelType: TEMPLATE_COMPONENT location: ALL operation: update - criticalThreshold: 100 warningThreshold: 80 repeatCount: 2 raiseAlert: true levelType: TEMPLATE_COMPONENT location: synthetic-public operation: update example-multiple-threshold-type-update-example-request: $ref: ./models/opsramp-monitoring-management/multiple-threshold-type-example-update-request-v1.yaml description: '' tags: - monitoring description: Update a template configuration get: summary: '' operationId: get-api-v2-tenants-clientId-monitoring-monitors-id responses: '200': $ref: '#/components/responses/template-response' tags: - monitoring description: Get template details '/monitoring/api/v3/tenants/{tenantId}/templates/clone': x-new-path: true summary: templates/clone description: Post request to clone the given template and update thresholds. post: tags: - monitoring responses: '201': description: OK content: application/json: schema: type: object properties: templateId: type: string examples: example-cloned-template: value: templateId: 1463daa4-9c75-4911-8994-09cac072374a summary: '' description: |- ### Notes - Applicable for G2 Templates Only. - By default the cloned template attributes value will be assigned unless an overridden value is explictly assigned. - All level attribute values can be customized i..e Resource, Template or component. - Frequencies can be customized only when different monitors with same metric. operationId: templates_clone requestBody: content: application/json: schema: $ref: '#/components/schemas/cloneTemplate' examples: example-cloned-template: value: clonedTemplateId: 1ecf993f-9b54-4ce3-9581-c365188f7e58 name: OpsRamp Gateway Performance Template - Clone description: 'Monitors basic UNIX parameters like UNIXCPU, UNIXSTORAGE, UNIXUPTIME, UNIXMEMORY, UNIXLOAD and UNIXStats' monitors: - name: Host System Uptime frequency: 5 thresholdType: Static metricName: system.uptime thresholds: - criticalThreshold: 1800 warningThreshold: 1 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: NONE raiseAlert: true availability: true levelType: TEMPLATE - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.idle thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component1 example-synthetics-clone: value: clonedTemplateId: 80724599-90e9-4055-bc95-b9316671f941 name: Template_api_clonedSyntheticsTemplate monitors: - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.time unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 3 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 200 warningThreshold: 90 repeatCount: 4 raiseAlert: true levelType: TEMPLATE_COMPONENT location: synthetic-public multiple-threshold-type-example-clone-request-v1: $ref: ./models/opsramp-monitoring-management/multiple-threshold-type-example-clone-request-v1.yaml parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{clientId}/resource/{resourceId}/thresholds': x-new-path: true summary: 'resource/{resourceId}/thresholds' description: Updates resource thresholds at given levels. put: tags: - monitoring requestBody: content: application/json: schema: type: array x-examples: Example 1: - templateId: 1ecf993f-9b54-4ce3-9581-c365188f7e58 monitors: - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.idle thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true availability: false levelType: COMPONENT compName: component1 operation: UPDATE - levelType: COMPONENT compName: component2 operation: REMOVE - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false levelType: RESOURCE operation: UPDATE - templateId: b3eaceb6-413e-459c-a420-779a48c3e562 monitors: - name: OpsRamp Gateway webProbe Performance frequency: 5 thresholdType: Static metricName: webmon.open.fd thresholds: - criticalThreshold: '1000' warningThreshold: '700' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: COMPONENT compName: component1 operation: UPDATE - levelType: COMPONENT compName: component2 operation: REMOVE - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false levelType: RESOURCE operation: UPDATE items: type: object properties: templateId: type: string monitors: type: array items: type: object properties: name: type: string frequency: type: integer thresholdType: type: string metricName: type: string thresholds: type: array items: $ref: '#/components/schemas/template-metrics-thresholds' examples: example-component-thresholds: value: - templateId: 1ecf993f-9b54-4ce3-9581-c365188f7e58 monitors: - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.idle thresholds: - criticalThreshold: '5' warningThreshold: '10' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component1 operation: UPDATE - levelType: COMPONENT compName: component2 operation: REMOVE - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true levelType: RESOURCE operation: UPDATE - templateId: b3eaceb6-413e-459c-a420-779a48c3e562 monitors: - name: OpsRamp Gateway webProbe Performance frequency: 5 thresholdType: Static metricName: webmon.open.fd thresholds: - criticalThreshold: '1000' warningThreshold: '700' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component1 operation: UPDATE - levelType: COMPONENT compName: component2 operation: REMOVE - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true levelType: RESOURCE operation: UPDATE multiple-threshold-type-example-update-thresholds-request-v1: $ref: ./models/opsramp-monitoring-management/multiple-threshold-type-example-update-thresholds-request-v1.yaml responses: '200': $ref: '#/components/responses/template-response' operationId: create_monitor description: Create a resource monitor with threshold configurations parameters: - name: clientId in: path required: true schema: type: string description: 'Describes the client unique identifier of the tenant ' - schema: type: string name: resourceId in: path required: true '/monitoring/api/v3/tenants/{tenantId}/syslog/rules': x-new-path: true x-internal: true summary: syslog/rules description: |- User can create syslog rules with given attributes in their tenancy scope. ### Notes Users needs to be aware of the below properties of Syslog APIs - Rules or Profiles uniqueness is defined by uniqueId. - API endpoints need a uniqueId for reference. - It's recommended that users should not delete a profile associated with a single rule in the filter. - Deleting profiles and rules are exclusive and are not dependent on each other. - Only the rules within the same tenant can be associated with the profile. get: tags: - monitoring responses: '200': content: application/json: schema: type: object x-examples: example-config: results: - name: TEST_RULES_2_PR_LG-123 uniqueId: dc7ae817-9fa4-4c4a-a401-6f7131a8c99d ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing - name: TEST_RULES_2_PR_LG uniqueId: 5051fc52-5318-460f-94f7-f87d05957d74 ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing totalResults: 2 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true properties: results: type: array items: $ref: '#/components/schemas/rules' 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: examples-syslog-rules: value: results: - name: TEST_RULES_2_PR_LG-123 uniqueId: dc7ae817-9fa4-4c4a-a401-6f7131a8c99d ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing - name: TEST_RULES_2_PR_LG uniqueId: 5051fc52-5318-460f-94f7-f87d05957d74 ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing totalResults: 2 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true description: Get the rules queried for a given scope operationId: get_rules summary: Query the created rules description: List the created rules for given tenant parameters: - schema: type: string enum: - include - exclude in: query name: action description: Query based on action i..e INCLUDE or EXCLUDE rules - schema: type: string in: query name: tags description: Query/search the rules based on tags at each scope - schema: type: string in: query name: uuid description: rule uuid post: requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/rules' examples: example-syslog-rule: value: - name: TEST_RULES_2_PR_LG-123 uniqueId: dc7ae817-9fa4-4c4a-a401-6f7131a8c99d ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing - name: TEST_RULES_2_PR_LG uniqueId: 5051fc52-5318-460f-94f7-f87d05957d74 ruleAction: INCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test additionalProperties: component: testing required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/filterResponse' examples: example-created-rules: value: createdList: - name: TEST_RULES_2_PR_LG-123 uuid: fc9d8f19-30b7-4bef-8b19-ca01b53e0d70 - name: TEST_RULES_3_PR_LG-124 uuid: bc9d6f19-30b8-4bef-8b19-ca01b53e0d70 createdCount: 2 example-rules-fail: value: failedCount: 1 createdList: - name: test-101 uuid: b2e6d13e-2754-41a2-a6f2-e4bf78dfc892 createdCount: 1 description: Creating the rule sets summary: Creates the syslog rules operationId: post_rules description: Create config rule for given tenant tags: - monitoring parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{tenantId}/syslog/rules/{id}': x-new-path: true x-internal: true summary: 'syslog/rules/{id}' description: User can update or delete a syslog rule parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant - schema: type: string name: id in: path required: true description: Describes the rule uuid delete: summary: Deletes a rule operationId: delete-api-v2-tenants-tenantId-monitoring-syslog-rules responses: '200': description: OK content: application/json: schema: type: object properties: code: type: string message: type: string examples: example-rule-deleted: value: message: Deleted successfully example-failed: value: code: '2354366' message: Deletion failed description: Deletes the given rule. tags: - monitoring put: summary: Update syslog rules operationId: put-api-v2-tenants-tenantId-monitoring-syslog-rules responses: '200': description: OK content: application/json: schema: type: object properties: name: type: string uuid: type: string examples: example-rules-updates: value: name: TEST_RULES_2_PR_LG-123 uuid: dc7ae817-9fa4-4c4a-a401-6f7131a8c99d requestBody: content: application/json: schema: $ref: '#/components/schemas/rules' examples: example-rule-update: value: name: TEST_RULES_2_PR_LG-123 uuid: 15800304-18fe-44fd-b9bb-6ce90ec1fbb8 ruleAction: EXCLUDE pattern: chrome metricName: Test3Partener2Metric10 alertSub: TEST SUBJECT alertDesc: TEST SUBJECT alertServerity: Critical tags: test-1 additionalProperties: component: testing description: Update syslog rule tags: - monitoring '/monitoring/api/v3/tenants/{tenantId}/syslog/profiles': x-new-path: true x-internal: true summary: syslog/profiles description: 'Creates,gets tenant syslog profiles' get: responses: '200': content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/profiles' totalResults: type: integer orderBy: type: string enum: - id pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-syslog-profiles: value: results: - name: Test_Config_1 uniqueId: 0014a45b-f332-4bfc-85f6-34b8b0fc1efc properties: severity: - emergency facility: - system_daemons description: '' managementGatewayProfilesUUID: - 44e36310-9e07-490a-bda9-4b19539b82f9 syslogConfResourceFilters: - name: Filter Resource - 1 ipRange: 1.2.3.6-2.2.2.2 uniqueId: 2e6e47f2-62cc-4877-9eaa-b9637e38ba02 syslogRuleIds: - Test_Rule_1 - Test_Rule_2_CL - Test_Rule_3_CL totalResults: 1 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true description: Get the details of the required configurations operationId: profiles summary: Getting the syslog profiles description: |- List the profiles by query parameters - {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?uuid={gatewayprofuuid} - {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?name={profile-name} - {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?id={sysloguuid} tags: - monitoring parameters: - schema: type: string in: query name: uuid description: Search by applicable gateway management profiles - schema: type: string in: query name: name description: Search profiles by it's name - schema: type: string in: query name: id description: Search by syslog profile id post: requestBody: content: application/json: schema: $ref: '#/components/schemas/profiles' examples: example-profiles-rules-id: value: name: Syslog config policy uniqueId: 0014a45b-f332-4bfc-85f6-34b8b0fc1efc description: '' managementGatewayProfilesUUID: - 44e36310-9e07-490a-bda9-4b19539b82f9 properties: severity: - emergency facility: - system_daemons syslogConfResourceFilters: - name: Filter Resource - 1 ipRange: 214.2.100.6-215.2.200.2 uniqueId: 2e6e47f2-62cc-4877-9eaa-b9637e38ba02 syslogRuleIds: - 5c622ce3-31c6-4378-b143-a21c265338cd - 6eb8560c-15eb-477e-9cb0-0cc60c8aaa15 - name: Filter Resource - 2 ipRange: 10.20.30.61-12.62.12.12 uniqueId: 3e6e57f2-62cf-4878-9eaa-c9637e39ba12 syslogRuleIds: - b33e9b6e-33a5-4016-966e-4ea8cca00bb8 - 965d2fa3-2bcb-46f5-a82f-834c68ca7d90 - 1b74deb2-0d7e-49c4-a3df-e9dc1f20ff7f required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/profilesResponse' examples: example-profiles-with-invalid-rules: value: name: Test_Config_1 uuid: fc9d8f19-30b7-4bef-8b19-ca01b53e0d70 invalidRulesList: - 5c622ce3-31c6-4378-b143-a21c265338cd example-profiles: value: name: Test_Config_1 uuid: fc9d8f19-30b7-4bef-8b19-ca01b53e0d70 description: Global profiles created summary: Creates the syslog profiles description: Create syslog profile configurations operationId: post_profiles tags: - monitoring parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{tenantId}/syslog/profiles/{id}': x-new-path: true x-internal: true summary: 'syslog/profiles/{id}' description: Update or deletes the tenant syslog profiles parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant - schema: type: string name: id in: path required: true description: Describes the profile id of syslog put: summary: Update the syslog profile operationId: put-api-v2-tenants-tenantId-monitoring-syslog-profiles responses: '200': description: OK content: application/json: schema: type: object properties: uuid: type: string name: type: string invalidRulesList: type: array items: type: string examples: example-updated-profile: value: uuid: fc9d8f19-30b7-4bef-8b19-ca01b53e0d70 name: test-profile example-invalid-rules-updated-profile: value: name: Test_Config_1 uuid: fc9d8f19-30b7-4bef-8b19-ca01b53e0d70 invalidRulesList: - 5c622ce3-31c6-4378-b143-a21c265338cd description: Update syslog configuration attributes requestBody: content: application/json: schema: $ref: '#/components/schemas/profiles' examples: example-profile-update: value: name: Test_Config_1 uniqueId: 0014a45b-f332-4bfc-85f6-34b8b0fc1efc description: '' managementGatewayProfilesUUID: - 44e36310-9e07-490a-bda9-4b19539b82f9 properties: severity: - emergency facility: - system_daemons syslogConfResourceFilters: - name: Filter Resource - 1 ipRange: 1.2.3.6-2.2.2.2 uniqueId: 2e6e47f2-62cc-4877-9eaa-b9637e38ba02 syslogRuleIds: - 5c622ce3-31c6-4378-b143-a21c265338cd - 6eb8560c-15eb-477e-9cb0-0cc60c8aaa15 example-profile-update-mgmt-profile: value: uniqueId: fbefa70e-04d0-4c29-8de9-e05da51628d8 additionalPropertiesDto: facility: - kernel_messages managementGatewayProfilesUUID: - 3e2facfe-f5e9-4e9f-834d-c030636e20d5 delete: summary: Deletes the syslog profile operationId: delete-api-v2-tenants-tenantId-monitoring-syslog-profiles responses: '200': description: OK content: application/json: schema: type: object properties: code: type: string description: Internal code on failure message: type: string description: Status message examples: example-successful-delete: value: message: Profiles delete successfully description: Deletes given profile. '/monitoring/api/v3/tenants/{tenantId}/syslog/profiles/export': x-new-path: true x-internal: true summary: syslog/profiles/export description: Exporting tenant syslog profiles with rules as JSON file post: responses: '200': content: multipart/form-data: schema: type: string examples: example-exported-json: value: json text description: Export data as JSON file operationId: export_profiles summary: Exports the Syslog profiles description: |- Export syslog profile. ### Notes - Payload is optional. In order to export all profiles execute the endpoint. - To export selected profiles use the payload with their uuids. tags: - monitoring requestBody: content: application/json: schema: type: array description: Export specific profiles by id items: type: string examples: example-export-profiles: value: - 02dec53f-b5fe-435d-925c-bc2e8fd90a6b - c3781a0a-bea5-4d97-b2ed-e52ae8b6132d - ec210450-4f17-4508-b51c-63468962fb89 description: '' parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{tenantId}/syslog/profiles/import': x-new-path: true x-internal: true summary: syslog/profiles/import description: Import syslog profiles. Import is limited to maximum 50 profiles. post: requestBody: description: File to be imported content: multipart/form-data: schema: type: string examples: example-imported-json: value: input-json required: true responses: '200': content: application/json: schema: type: object properties: message: type: string examples: example-import-request: value: message: import is in progress description: Profile and Rules Created operationId: post_import summary: Importing the syslog profiles description: |- Import a syslog profile. ### Notes - Profile with incorrect gateway profiles will get imported to create syslog profiles. - User needs to ensure that imported json has the right reference to tenant gateway profile uuid. - This is an asynchronous request and the endpoint just posts the request to import profile. - User needs to query and check if profiles are getting imported by using GET profiles. - User needs to wait for few minutes and execute the GET profile in the given tenant. - For a successful import and execution of rules user need to ensure below: - Gateway profiles are correct w.r.t to tenant where import was done - Only the valid tenant scope profiles will get imported. tags: - monitoring parameters: - in: path name: tenantId schema: type: string required: true description: Describes the clientId or mspId of tenant '/monitoring/api/v3/tenants/{mspId}/snmp-traps/search': x-new-path: true summary: snmp-traps/search description: List all SNMP traps configuration for the tenant parameters: - schema: type: string name: mspId in: path required: true description: 'Partner uuid ' get: summary: '' operationId: get-api-v2-tenants-tenantId-monitoring-snmp-traps-search responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/partner-snmp-traps-configs' readOnly: true totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean readOnly: true examples: example-list-snmp-configs: value: results: - clientId: b5461c7b-bf7d-4e02-b591-36ccb4ea6d77 snmp-configuration: id: 28bc2699-6d92-42c2-ac95-d40433a7cef3 include-all-trap-interfaces: true monitor-name: snmp-trap-monitor oid-rules: rule: include oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: all - clientId: f997bd4f-f53d-4cad-ba2c-40e6111d4ba8 snmp-configuration: id: 7300209b-3f38-4e73-bc70-921e6acabcb3 include-all-trap-interfaces: false monitor-name: snmp-trap-second-monitor oid-rules: rule: exclude oids: - 1.2.6.1.4.1.9.2.1.8.0 - 1.6.6.1.2.1.1.3.0 - 1.7.6.1.4.1.9.2.1.2.0 resources: rule: all totalResults: 2 orderBy: id pageNo: 1 pageSize: 2 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true tags: - monitoring '/monitoring/api/v3/tenants/{clientId}/snmp-traps': x-new-path: true summary: snmp-traps description: SNMP traps configuration for the client parameters: - name: clientId in: path required: true schema: type: string description: 'Describes the client unique identifier of the tenant ' post: summary: '' operationId: post-api-v2-tenants-tenantId-monitoring-snmp-traps responses: '200': description: OK content: application/json: schema: type: object properties: code: type: string message: type: string readOnly: true examples: example-invalid-oids: value: code: '213155' message: All the OIDs was not valid '201': description: Created content: application/json: schema: type: object x-examples: example-snmp-config: name: snmp-trap-monitor invalid-objs: invalid-oids: - a.b.3.4.5.6 invalid-resources: - fr622ce3-45wd-3845-91jk-a34dwe34r55 properties: monitor-name: type: string invalid-objs: type: object properties: invalid-oids: type: array items: type: string invalid-resources: type: array items: type: string examples: example-snmp-config: value: monitor-name: snmp-trap-monitor example-snmp-invalid-config: value: monitor-name: snmp-trap-monitor invalid-objs: invalid-oids: - a.b.3.4.5.6 invalid-resources: - fr622ce3-45wd-3845-91jk-a34dwe34r55 description: Create snmp trap configurations for the client tags: - monitoring requestBody: content: application/json: schema: $ref: '#/components/schemas/snmp-traps-config' examples: example-snmp-traps-include-default-config: value: monitor-name: snmp-trap-monitor oid-rules: rule: include oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 example-snmp-traps-exclude-specific-config: value: monitor-name: snmp-trap-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: specific-resources traps-resources: - 6d1b9848-7d18-42d4-88d2-05fade687033 - 6c433998-fd55-4543-b023-4f5d872ee845 - 5ed4283f-495c-491e-91a6-8de5828a4f81 example-snmp-traps-include-specific-rg-config: value: monitor-name: snmp-trap-monitor oid-rules: rule: include oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: specific-resource-group resource-group: - Res-Grp1 - Res-Grp2 - Res-Grp1 description: '' '/monitoring/api/v3/tenants/{clientId}/snmp-traps/{name}': x-new-path: true summary: 'snmp-traps/{name}' description: 'Get, Update and delete snmp traps configuration for the client' parameters: - name: clientId in: path required: true schema: type: string description: 'Describes the client unique identifier of the tenant ' - schema: type: string name: name in: path required: true description: SNMP configuration name get: summary: Get snmp trap conifguration details tags: - monitoring responses: '200': $ref: '#/components/responses/snmp-trap-configs' operationId: get-api-v2-tenants-tenantId-monitoring-snmp-traps description: Get the details of the given snmp configuration put: summary: Update SNMP configuration operationId: put-api-v2-tenants-tenantId-monitoring-snmp-traps responses: '200': $ref: '#/components/responses/snmp-trap-configs' '400': $ref: '#/components/responses/invalid-snmp-configuration' description: Update snmp trap configuration rules tags: - monitoring requestBody: $ref: '#/components/requestBodies/snmp-trap-config-update' delete: summary: '' operationId: delete-api-v2-tenants-tenantId-monitoring-snmp-traps responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string examples: example-snmp-traps-deleted: value: message: snmp-trap-monitor deleted successfully description: Delete snmp trap configuration tags: - monitoring 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 tenant resourceId: name: resourceId in: path required: true schema: type: string description: Describes the uuid of the resource clientId: name: clientId in: path required: true schema: type: string description: 'Describes the client unique identifier of the tenant ' schemas: monitoringTemplate: title: monitoringTemplate type: object properties: id: type: integer uniqueId: type: string name: type: string description: type: string templateType: type: string collectorType: type: string status: type: string generation: type: integer tags: type: string createdDate: type: string format: date-time updatedDate: type: string format: date-time monitors: type: array items: $ref: '#/components/schemas/monitor' customThresholds: type: array items: $ref: '#/components/schemas/thresholds' assignedInterfaces: type: array items: $ref: '#/components/schemas/interface' configParameters: type: array items: $ref: '#/components/schemas/configParameter' assignedTime: type: string appliedTime: type: string template: title: configured-template type: object properties: id: type: string description: Template uuid name: type: string description: Template name description: type: string description: Template details collectorType: type: string description: Collector Type example: agent resourceType: type: string description: Template applicable for native type resources. generation: type: integer description: Template generation example: 2 readOnly: true tags: type: string description: Tag createdDate: type: string format: date-time updatedDate: type: string format: date-time templateFamily: type: string description: Template family notes: type: string description: Brief details monitors: type: array description: Template monitors items: $ref: '#/components/schemas/template-monitors' status: type: object properties: state: type: string example: ACTIVE eol-date: type: string required: - name - collectorType - resourceType - generation req-template: title: request-template type: object properties: name: type: string description: Template name description: type: string description: Template details collectorType: type: string description: Collector Type enum: - Synthetics - OpsRamp Agent - OpsRamp Gateway example: OpsRamp Agent resourceType: type: string description: Template applicable for native type resources. enum: - DEVICE - SYNTHETIC default: DEVICE example: DEVICE checkType: type: string default: HTTPS enum: - HTTPS - HTTP - DNS - IMAP - PING - RTT - POP3 - SCRIPT - SMTP - SSL - TCP - UDP - FTP - SIP description: |- Support Synthetics protocol for which template is configured for monitoring. This attribute is must have a value when synthetic templates are created. status: type: object description: Template activity status properties: state: type: string enum: - ACTIVE - INACTIVE example: ACTIVE eolDate: type: string tags: type: string description: Tag generation: type: integer description: Template generation example: 2 format: int32 default: 2 templateFamily: type: string description: Template family notes: type: string description: Brief details monitors: type: array description: Template monitors items: $ref: '#/components/schemas/template-monitors' required: - name - collectorType - resourceType - status - generation description: '' template-monitors: title: template-monitors type: object properties: name: type: string description: Monitor name frequency: type: integer enum: - 1 - 2 - 5 - 15 - 10 - 30 - 60 - 120 - 1440 description: Metric frequency example: 2 thresholdType: type: string enum: - ChangeDetection - Forecast - Static description: Alerting conditions example: static metricName: type: string description: Metric name thresholds: type: array items: $ref: '#/components/schemas/template-metrics-thresholds' required: - name - frequency template-metrics-thresholds: type: object description: Metric thresholds properties: criticalThreshold: type: integer criticalRepeatCount: type: integer warningThreshold: type: integer warningRepeatCount: type: integer warningOperator: type: string criticalOperator: type: string raiseAlert: type: boolean default: true description: 'Alerted ' availability: type: boolean default: false description: Availability levelType: type: string enum: - TEMPLATE - TEMPLATE_COMPONENT - RESOURCE - COMPONENT example: TEMPLATE compName: type: string operation: type: string enum: - UPDATE - REMOVE example: UPDATE default: UPDATE interface: title: interface type: object properties: id: type: integer networkName: type: string status: type: string ifName: type: string ifAlias: type: string ifDescription: type: string ifTxType: type: string ifType: type: string macAddress: type: string speed: type: string confLinkSpeed: type: string adminStatus: type: string operationalStatus: type: string configParameter: title: configParameter type: object properties: parameter: type: object properties: name: type: string description: type: string type: type: string value: type: string profiles: type: object properties: name: type: string description: Profile name uniqueId: type: string description: Profile uuid description: type: string description: Profile description managementGatewayProfilesUUID: type: array description: Gateway profile uuid items: type: string properties: type: object description: Syslog message properties to be mapped properties: severity: type: array description: | Severity as shouwn in the ui. items: type: string enum: - emergency - alert - critical - error - warning - notice - informational - debug example: emergency facility: type: array description: Facility details as visible in ui items: type: string enum: - kernel_messages - user_level_messages - mail_system - system_daemons - security_authorization_messages_4 - messages_generated_internally_by_syslogd - line_printer_subsystem - network_news_subsystem - UUCP_subsystem - clock_daemon - security_authorization_messages_10 - FTP_daemon - NTP_subsystem - log_audit - log_alert - clock_daemon_note_2 - local_use_0 - local_use_1 - local_use_2 - local_use_3 - local_use_4 - local_use_5 - local_use_6 - local_use_7 example: kernel_messages syslogConfResourceFilters: type: array description: Filters items: type: object properties: name: type: string description: filter name ipRange: type: string description: IP Range uniqueId: type: string syslogRuleIds: type: array description: Included syslog rule uuids in the profiles items: type: string filterResponse: type: object properties: failedCount: type: integer updatedCount: type: integer createdList: type: array items: type: object properties: name: type: string uuid: type: string createdCount: type: integer rules: type: object properties: name: type: string description: Syslog rule name uniqueId: type: string description: Rule uuid ruleAction: type: string description: Include or exclude the expression rule while filtering syslog messages pattern: type: string description: Filter pattern to filter syslog messages metricName: type: string description: Custom metric name for the alert generated alertSub: type: string description: Alert Subject alertDesc: type: string description: Alert Description alertServerity: type: string enum: - Critical - Warning example: Critical description: Alert Severity tags: type: string description: Group Tag name of the rule additionalProperties: type: object description: Additional details for alerts. Eg Resource Component. properties: component: type: string description: Resource component name cloneTemplate: type: object properties: clonedTemplateId: type: string description: uuid of source template for clone. name: type: string description: Name given to the new cloned template. description: type: string description: Description to be added to the new cloned template. monitors: type: array items: type: object properties: name: type: string description: Monitor name from the source template which is getting overridden. metricName: type: string description: Metric Name thresholdType: type: string description: ThresholdType supported values enum: - STATIC - CHANGE_DETECTION - FORECAST example: STATIC frequency: type: integer enum: - 1 - 2 - 5 - 10 - 15 - 30 - 60 - 120 - 1440 example: 1 description: Polling frequencies in minutes. thresholds: type: array items: $ref: '#/components/schemas/template-metrics-thresholds' description: '' thresholds: type: object properties: warningThreshold: type: string warningOperator: type: string enum: - GREATER_THAN_EQUAL warningRepeatCount: type: integer criticalThreshold: type: string criticalOperator: type: string enum: - GREATER_THAN_EQUAL criticalRepeatCount: type: integer compName: type: string raiseAlert: type: boolean default: true levelType: type: string enum: - resource - component example: component description: Type on which the thresholds are defined. Component level or Resource level thresholds. compNameOperator: type: string enum: - EQUALS profilesResponse: type: object properties: name: type: string description: Profile name uuid: type: string description: profile uuid invalidRulesList: type: array description: List of rules which are invalid for the tenant items: type: string code: type: string description: Error code message: type: string description: Error Message title: '' snmp-traps-config: type: object properties: monitor-name: type: string description: unique snmp-trap config name include-all-trap-interfaces: type: boolean description: Include monitoring and non monitoring trap interfaces. default: false oid-rules: type: object description: oid rules additionalProperties: false properties: rule: type: string oids: type: array items: type: string resources: type: object description: snmp resources properties: rule: type: string enum: - all - specific-resources - discard-specific-resources - specific-resource-group example: all description: Inculsion rules for snmp resources or resource groups traps-resources: type: array description: Include-exclude list of resources items: type: string resource-group: type: array description: List of resource group items: type: string required: - monitor-name - oid-rules snmp-traps-config-update: type: object properties: monitor-name: type: string description: unique snmp-trap config name include-all-trap-interfaces: type: boolean description: Include monitoring and non monitoring trap interfaces. default: false oid-rules: type: object description: oid rules additionalProperties: false properties: rule: type: string oids: type: array items: type: string resources: type: object description: snmp resources properties: rule: type: string enum: - all - specific-resources - discard-specific-resources - specific-resource-group example: all description: Inculsion rules for snmp resources or resource groups traps-resources: type: array description: Include-exclude list of resources items: type: string resource-group: type: array description: List of resource group items: type: string required: - monitor-name partner-snmp-traps-configs: type: object properties: clientId: type: string snmp-configuration: type: object properties: include-all-trap-interfaces: type: boolean monitor-name: type: string oid-rules: type: object properties: rule: type: string oids: type: array items: type: string resources: type: object properties: traps-resources: type: array items: type: string resource-group: type: array items: type: string rule: type: string monitor: type: object properties: name: type: string metricName: type: string frequency: type: integer warningOperator: type: string warningRepeatCount: type: integer criticalOperator: type: string criticalRepeatCount: type: integer raiseAlert: type: boolean availability: type: boolean state: type: string monitorType: type: string scriptUserType: type: integer uniqueId: type: string alertSub: type: string alertBody: type: string oid: type: string type: type: string monitorNonExistingServices: type: boolean delete-template: title: delete-template oneOf: - additionalProperties: false properties: metrics: type: array items: type: string - additionalProperties: false properties: monitors: type: array items: type: string - additionalProperties: false properties: monitor-metrics: type: array items: type: object properties: monitor: type: string metric: type: array items: type: string type: object update-template: type: object properties: name: type: string description: Template name description: type: string description: Template Details status: type: object properties: value: type: string description: Template status example: ACTIVE enum: - ACTIVE - EOL - INACTIVE default: ACTIVE eolDate: type: string description: EOL date tags: type: string description: Template tag templateFamily: type: string description: Template family notes: type: string monitors: type: array description: Template monitors items: $ref: '#/components/schemas/template-monitors' resource-templates: title: resource-templates type: object properties: id: type: string name: type: string templates: type: array items: $ref: '#/components/schemas/monitoringTemplate' x-examples: {} templates-search: title: templates-search x-stoplight: id: 4ijxjijh9l7qf type: object x-examples: {} properties: type: type: string enum: - resource - template - metric - monitor default: resource description: 'Filter type attribute of the configuration i..e template,metric,monitor,resource' filter: type: object description: Filtering criteria for selected attribute type properties: criteria: type: string enum: - LIKE - IN - CONTAINS - EQUALS default: LIKE description: Filtering condition value: type: string description: Filtering matching values objectsList: type: array description: List of objects requested for configurations items: type: string pageNo: type: integer default: 1 description: Resultset required upto pages pageSize: type: integer default: 100 description: Resultset page size orderBy: type: string default: id description: Resultset group by isDescendingOrder: type: boolean default: false description: Resultset ordering required: - type monitor-config: title: monitor-config type: object x-examples: {} x-stoplight: id: 3be3d7aea423d properties: objectsList: type: array description: List of objects requested for configurations items: type: string pageNo: type: integer default: 1 description: Resultset required upto pages pageSize: type: integer default: 100 description: Resultset page size orderBy: type: string default: id description: Resultset group by isDescendingOrder: type: boolean default: false description: Resultset ordering description: '' requestBodies: templateReq: content: application/json: schema: $ref: '#/components/schemas/req-template' examples: example-template-monitor-metric: value: name: Test Monitor Template description: Test template collectorType: OpsRamp Gateway resourceType: DEVICE status: state: ACTIVE generation: 2 tags: tag-1 templateFamily: monitor-family notes: template-notes monitors: - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.nice thresholds: - criticalThreshold: 99 warningThreshold: 98 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component2 - name: monitor-name-1 frequency: 15 thresholdType: Static metricName: pages.per.sec thresholds: - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false availability: false levelType: TEMPLATE - name: monitor-name-2 frequency: 15 thresholdType: Static metricName: total.physical.memory.mb thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component1 example-template-monitors: value: name: template-name-2 description: tempplate-example collectorType: OpsRamp Agent resourceType: DEVICE status: state: ACTIVE tags: performance-monitoring generation: 2 templateFamily: perf-monitoring notes: notes monitors: - name: performance-monitor frequency: 10 - name: Memory Monitoring frequency: 15 - name: TCP Port frequency: 15 example-template: value: name: OpsRamp Gateway Performance Template description: 'Monitors basic UNIX parameters like UNIXCPU, UNIXSTORAGE, UNIXUPTIME, UNIXMEMORY, UNIXLOAD and UNIXStats' resourceType: DEVICE collectorType: OpsRamp Gateway status: state: ACTIVE generation: 2 tags: Performance Monitors templateFamily: Performance Monitors Family notes: Sample notes related to performance monitors monitors: - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory.used thresholds: - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false availability: false levelType: TEMPLATE - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.idle thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component1 - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.nice thresholds: - criticalThreshold: 99 warningThreshold: 98 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component2 - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.interrupt thresholds: - criticalThreshold: 99 warningThreshold: 98 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component3 - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory thresholds: - criticalThreshold: 95 warningThreshold: 90 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory.free thresholds: - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false availability: false levelType: TEMPLATE - name: Storage Utilization - HR-MIB frequency: 15 thresholdType: Static metricName: system.disk.util.percent thresholds: - criticalThreshold: 90 warningThreshold: 80 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component4 - name: Host System Uptime frequency: 5 thresholdType: Static metricName: system.uptime thresholds: - criticalThreshold: 1800 warningThreshold: 11 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: NONE raiseAlert: true availability: true levelType: TEMPLATE - name: CPU Load - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.load.5min thresholds: - criticalThreshold: 12 warningThreshold: 6 criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false levelType: TEMPLATE_COMPONENT compName: component5 example-synthetics-template: value: name: Test_synthetics_template description: test resourceType: SYNTHETIC collectorType: Synthetics checkType: HTTPS status: state: ACTIVE generation: 2 tags: '' createdDate: '2023-02-08T09:27:21+0000' updatedDate: '2023-02-08T10:31:51+0000' scope: Partner templateFamily: Synthetics allowed notes: '' monitors: - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.time unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 20 warningThreshold: 10 repeatCount: 1 raiseAlert: true levelType: TEMPLATE_COMPONENT location: synthetic-public - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.redirecttime unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: ssl.cert.expiry.check unit: Days thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: availability.down.locations.count unit: count thresholds: - criticalThreshold: 1 warningThreshold: 0 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 80 warningThreshold: 50 repeatCount: 1 raiseAlert: true levelType: TEMPLATE_COMPONENT location: ALL example-template-with-component-thresholds: value: name: Template_client_agent01 description: monitor_client_agent01 resourceType: DEVICE collectorType: OpsRamp Agent status: state: ACTIVE generation: 2 tags: '' createdDate: '2022-12-15T09:40:32+0000' updatedDate: '2023-01-09T06:43:20+0000' scope: Client templateFamily: Thresholds value notes: '' monitors: - name: Monitor_client_agent01 frequency: 1 thresholdType: Static metricName: system.memory.usage.utilization unit: '%' thresholds: - criticalThreshold: 70 warningThreshold: 60 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: true state: Active levelType: TEMPLATE - criticalThreshold: 100 warningThreshold: 90 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: TEMPLATE_COMPONENT compOperator: GREATER_THAN_EQUAL compName: system.memory.cache.utilization example-multiple-threshold-type-create-example-request: $ref: ./models/opsramp-monitoring-management/multiple-threshold-type-example-create-request-v1.yaml snmp-trap-config-update: content: application/json: schema: $ref: '#/components/schemas/snmp-traps-config-update' examples: example-snmp-config-update-default: value: monitor-name: snmp-trap-new-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 example-snmp-exclude-update: value: monitor-name: snmp-trap-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: discard-specific-resources traps-resources: - 6d1b9848-7d18-42d4-88d2-05fade687033 - 6c433998-fd55-4543-b023-4f5d872ee845 - 5ed4283f-495c-491e-91a6-8de5828a4f81 example-snmpinclude-all-trap-resources: value: monitor-name: string include-all-trap-interfaces: true description: '' delete-monitors: content: application/json: schema: $ref: '#/components/schemas/delete-template' examples: example-delete-metrics: value: metrics: - metric-1 - metric-2 - metric-3 example-delete-monitors: value: monitors: - monitor-1 - monitor-2 - monitor-3 example-delete-monitor-metrics: value: monitor-metrics: - monitor: monitor-1 metric: - metric-1 - metric-2 description: '' template-search-reqs: content: application/json: schema: $ref: '#/components/schemas/monitor-config' examples: example-search-by-resources-ids: value: objectsList: - d5b487cb-328c-4fc8-ae8b-ba6b9f4ef291 - f185ca1a-b0a7-4cbf-b2d6-81ac7bc14587 - 5f09e924-46df-4bd2-8dd0-e8c7f5b47807 - 5c3f9098-f376-4f96-b464-55b517a58cad - ca1bf26e-b78c-42df-9f68-5a7b65c1c7cf example-default-search: value: {} description: '' responses: snmp-trap-configs: description: Example response content: application/json: schema: $ref: '#/components/schemas/snmp-traps-config' examples: example-snmp-config-default-all: value: monitor-name: snmp-trap-monitor oid-rules: rule: include oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 example-snmp-config-include-exclude-specific: value: monitor-name: snmp-trap-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: specific-resource-group resource-group: - Res-Grp1 - Res-Grp2 - Res-Grp1 example-snmp-config-exclude-rg: value: monitor-name: snmp-trap-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: specific-resource-group resource-group: - Res-Grp1 - Res-Grp2 - Res-Grp1 example-snmp-include-all-trap-interfaces: value: monitor-name: snmp-trap-monitor oid-rules: rule: exclude oids: - 1.3.6.1.4.1.9.2.1.8.0 - 1.3.6.1.2.1.1.3.0 - 1.3.6.1.4.1.9.2.1.2.0 resources: rule: specific-resource-group resource-group: - Res-Grp1 - Res-Grp2 - Res-Grp1 include-all-trap-interfaces: true template-response: description: Example response content: application/json: schema: $ref: '#/components/schemas/template' examples: example-synthetics-template: value: id: 80724599-90e9-4055-bc95-b9316671f942 name: Test_synthetics_template description: test resourceType: SYNTHETIC collectorType: Synthetics checkType: HTTPS status: state: ACTIVE generation: 2 tags: '' createdDate: '2023-02-08T09:27:21+0000' updatedDate: '2023-02-08T10:31:51+0000' scope: Partner templateFamily: Synthetics notes: '' monitors: - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.time unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 20 warningThreshold: 10 repeatCount: 1 raiseAlert: true levelType: TEMPLATE_COMPONENT location: synthetic-public - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: synthetic.response.redirecttime unit: ms thresholds: - criticalThreshold: 200 warningThreshold: 100 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: ssl.cert.expiry.check unit: Days thresholds: - criticalThreshold: 5 warningThreshold: 10 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - name: Synthetics - HTTPS frequency: 1 thresholdType: Static metricName: availability.down.locations.count unit: count thresholds: - criticalThreshold: 1 warningThreshold: 0 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalThreshold: 80 warningThreshold: 50 repeatCount: 1 raiseAlert: true levelType: TEMPLATE_COMPONENT location: ALL example-template-component-thresholds: value: id: a3e835b5-9228-4e0e-8ca0-8c9dd5945f96 name: Template_client_agent01 description: monitor_client_agent01 resourceType: DEVICE collectorType: OpsRamp Agent status: state: ACTIVE generation: 2 tags: '' createdDate: '2022-12-15T09:40:32+0000' updatedDate: '2023-01-09T06:43:20+0000' scope: Client templateFamily: Template Thresholds notes: '' monitors: - name: Monitor_client_agent01 frequency: 1 thresholdType: Static metricName: system.memory.usage.utilization unit: '%' thresholds: - criticalThreshold: 70 warningThreshold: 60 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: true state: Active levelType: TEMPLATE - criticalThreshold: 100 warningThreshold: 90 criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: TEMPLATE_COMPONENT compOperator: GREATER_THAN_EQUAL compName: system.memory.cache.utilization example-component-thresholds: value: - templateId: 1ecf993f-9b54-4ce3-9581-c365188f7e58 name: OpsRamp Gateway Performance Template description: 'Monitors basic UNIX parameters like UNIXCPU, UNIXSTORAGE, UNIXUPTIME, UNIXMEMORY, UNIXLOAD and UNIXStats' resourceType: DEVICE collectorType: OpsRamp Gateway status: state: ACTIVE generation: 2 createdDate: '2022-10-09T15:03:44+0000' updatedDate: '2022-10-09T15:23:40+0000' monitors: - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory.used thresholds: - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false availability: false state: Active levelType: TEMPLATE - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false levelType: TEMPLATE_COMPONENT compOperator: NOT_EQUALS_IGNORE_CASE compName: util - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false levelType: RESOURCE - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.idle thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '5' warningThreshold: '10' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component1 - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true levelType: RESOURCE - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.nice thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '99' warningThreshold: '98' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component2 - name: CPU Stats - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.cpu.stats.interrupt thresholds: - criticalThreshold: '95' warningThreshold: '90' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false levelType: TEMPLATE_COMPONENT compOperator: NOT_EQUALS_IGNORE_CASE compName: C - criticalThreshold: '99' warningThreshold: '98' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component3 - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory thresholds: - criticalThreshold: '95' warningThreshold: '90' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true levelType: RESOURCE - name: Memory Utilization - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.memory.free thresholds: - criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: NONE warningOperator: NONE raiseAlert: false availability: false state: Active levelType: TEMPLATE - name: Storage Utilization - HR-MIB frequency: 15 thresholdType: Static metricName: system.disk.util.percent thresholds: - criticalThreshold: '90' warningThreshold: '80' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true state: Active levelType: TEMPLATE - name: Host System Uptime frequency: 5 thresholdType: Static metricName: system.uptime thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '1800' warningThreshold: '' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: LESS_THAN_EQUAL warningOperator: NONE raiseAlert: true levelType: RESOURCE - name: CPU Load - UCD-SNMP-MIB frequency: 5 thresholdType: Static metricName: system.unix.load.5min thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '12' warningThreshold: '6' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true availability: false state: Active levelType: COMPONENT compName: component5 - templateId: b3eaceb6-413e-459c-a420-779a48c3e562 name: OpsRamp Gateway webProbe Performance Template description: OpsRamp Gateway webProbe Performance resourceType: DEVICE collectorType: OpsRamp Gateway status: state: ACTIVE generation: 2 createdDate: '2020-12-21T06:46:18+0000' updatedDate: '2020-12-21T06:46:18+0000' monitors: - name: OpsRamp Gateway webProbe Performance frequency: 5 thresholdType: Static metricName: webmon.open.fd thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '1000' warningThreshold: '700' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN_EQUAL warningOperator: GREATER_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component1 - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN levelType: RESOURCE - name: OpsRamp Gateway webProbe Performance frequency: 5 thresholdType: Static metricName: webmon.mem.util thresholds: - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true availability: false state: Active levelType: TEMPLATE - criticalThreshold: '5' warningThreshold: '10' criticalRepeatCount: 2 warningRepeatCount: 2 criticalOperator: LESS_THAN_EQUAL warningOperator: LESS_THAN_EQUAL raiseAlert: true levelType: COMPONENT compName: component1 - criticalThreshold: '80' warningThreshold: '70' criticalRepeatCount: 1 warningRepeatCount: 1 criticalOperator: GREATER_THAN warningOperator: GREATER_THAN raiseAlert: true levelType: RESOURCE multiple-threshold-type-example-update-thresholds-response-v1: $ref: ./models/opsramp-monitoring-management/multiple-threshold-type-example-update-thresholds-response-v1.yaml invalid-snmp-configuration: description: Example response content: application/json: schema: type: object properties: monitor-name: type: string invalid-objs: type: object properties: invalid-oids: type: array items: type: string invalid-resources: type: array items: type: string examples: example-snmp-invalid-oids: value: monitor-name: snmp-trap-monitor invalid-objs: invalid-oids: - a.b.3.4.5.6 example-snmp-invalid-resources: value: monitor-name: snmp-trap-monitor invalid-objs: invalid-resources: - fr622ce3-45wd-3845-91jk-a34dwe34r55