How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SAP HANA Alerts API

Operations for accessing and managing triggered alerts for SAP HANA Cloud instances, including alert state queries, severity filtering, and alert rule configuration.

SAP HANA Alerts API is one of 17 APIs that SAP HANA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 45 JSON Schema definitions.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 45 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cf.{region}.hana.ondemand.com.

3 operations 2 paths 6 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.cf.{region}.hana.ondemand.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

SAP HANA Alerts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authentication using SAP Business Technology Platform credentials. Obtain an access token using client credentials flow with the UAA service URL, cli…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Alerts 3

Operations for accessing and managing triggered alerts for SAP HANA Cloud instances, including alert state queries, severity filtering, and alert rule configuration.

GET
/alerts/v1/serviceInstances/{serviceInstanceId}/events
List Alert Events for a Service Instance
listAlertEvents 5 params → 200401403404429500
GET
/alerts/v1/serviceInstances/{serviceInstanceId}/rules
List Alert Rules for a Service Instance
listAlertRules 1 param → 200401403404429500
PATCH
/alerts/v1/serviceInstances/{serviceInstanceId}/rules
Update Alert Rules for a Service Instance
updateAlertRules 1 param body → 200400401403404422429500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AlertEvent (12 properties), AlertRule (10 properties), Error (3 properties), UpdateAlertRulesRequest (1 property). Each schema is shown below with its type and property counts.

AlertRuleList
object
A list of alert rules configured for an SAP HANA Cloud service instance.
1 property
AlertEvent
object
An alert event representing a triggered alert condition on an SAP HANA Cloud service instance. Alerts monitor database health, resources, and operational thres…
12 properties
Error
object
Standard error response returned by the SAP HANA Cloud REST API when a request fails.
3 properties
AlertRule
object
An alert rule defining the condition and threshold that triggers an alert for an SAP HANA Cloud service instance. Rules can be cloud-native or embedded statist…
10 properties
AlertEventList
object
A list of alert events for an SAP HANA Cloud service instance.
1 property
UpdateAlertRulesRequest
object
Request body for updating alert rules.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sap-hana-alerts-api-openapi.yml Raw ↑

Other APIs SAP HANA publishes across the network.

SAP HANA SQL API
SAP HANA XS Engine API
SAP HANA Cockpit API
SAP HANA Smart Data Integration API
SAP HANA Cloud Alerts and Metrics REST API
SAP HANA Spatial Services API
SAP HANA Cloud Data Lake Files REST API
SAP HANA Deployment Infrastructure (HDI) API
SAP HANA Predictive Analysis Library (PAL) API
SAP HANA JSON Document Store API
SAP HANA Graph Engine API
SAP HANA REST Info API
Where this information came from

This is an independent, third-party profile of SAP HANA Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.