{ "opencollection": "1.0.0", "info": { "name": "SAP HANA Cloud REST Alerts API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{subdomain}.authentication.{region}.hana.ondemand.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Alerts", "type": "folder" }, "items": [ { "info": { "name": "List Alert Events for a Service Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.cf.{region}.hana.ondemand.com/alerts/v1/serviceInstances/:serviceInstanceId/events", "params": [ { "name": "serviceInstanceId", "value": "", "type": "path", "description": "The unique identifier of the SAP HANA Cloud service instance for which to retrieve alerts, metrics, or metering data." }, { "name": "alertState", "value": "Active", "type": "query", "description": "Filter alerts by their current state. Use Active to retrieve currently triggered alerts, or Resolved for previously triggered alerts that have returned to normal." }, { "name": "severity", "value": "High", "type": "query", "description": "Filter alerts by severity level. High severity alerts indicate critical conditions requiring immediate attention." }, { "name": "fromTimestamp", "value": "2026-01-15T10:30:00Z", "type": "query", "description": "Start timestamp for the alert event query window in ISO 8601 format. Only alerts triggered on or after this timestamp are returned." }, { "name": "toTimestamp", "value": "2026-01-15T10:30:00Z", "type": "query", "description": "End timestamp for the alert event query window in ISO 8601 format. Only alerts triggered on or before this timestamp are returned." } ] }, "docs": "Retrieves a list of triggered alert events for a specific SAP HANA Cloud service instance. Alerts monitor database health, resource utilization, availability, and operational thresholds. Results can be filtered by alert state and severity to focus on active or critical alerts." }, { "info": { "name": "List Alert Rules for a Service Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.cf.{region}.hana.ondemand.com/alerts/v1/serviceInstances/:serviceInstanceId/rules", "params": [ { "name": "serviceInstanceId", "value": "", "type": "path", "description": "The unique identifier of the SAP HANA Cloud service instance for which to retrieve alerts, metrics, or metering data." } ] }, "docs": "Retrieves all configured alert rules for a specific SAP HANA Cloud service instance. Alert rules define the conditions and thresholds that trigger alerts, including both cloud-native rules and embedded statistics server (ESS) rules." }, { "info": { "name": "Update Alert Rules for a Service Instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cf.{region}.hana.ondemand.com/alerts/v1/serviceInstances/:serviceInstanceId/rules", "params": [ { "name": "serviceInstanceId", "value": "", "type": "path", "description": "The unique identifier of the SAP HANA Cloud service instance for which to retrieve alerts, metrics, or metering data." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of alert rules for a specific SAP HANA Cloud service instance. This allows administrators to modify alert thresholds, enable or disable specific rules, and customize alerting behavior for both cloud-native rules and ESS rules." } ] } ], "bundled": true }