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 Instances API

Operations for managing SAP HANA Cloud database instances including provisioning, configuration, lifecycle management, and status retrieval.

SAP HANA Instances 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 Instances. 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 6 operations across 3 paths, and defines 9 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.

6 operations 3 paths 9 schemas 1 DELETE3 GET1 PATCH1 POST

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 Instances 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 6

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

Instances 6

Operations for managing SAP HANA Cloud database instances including provisioning, configuration, lifecycle management, and status retrieval.

GET
/v1/service_instances
List All Sap Hana Cloud Service Instances
listServiceInstances 4 params → 200401403429500
POST
/v1/service_instances
Create a New Sap Hana Cloud Service Instance
createServiceInstance body → 201202400401403409422429
GET
/v1/service_instances/{instanceId}
Retrieve a Specific Sap Hana Cloud Service Instance
getServiceInstance 1 param → 200401403404429500
PATCH
/v1/service_instances/{instanceId}
Update an Sap Hana Cloud Service Instance
updateServiceInstance 1 param body → 200202400401403404409422
DELETE
/v1/service_instances/{instanceId}
Delete an Sap Hana Cloud Service Instance
deleteServiceInstance 1 param → 200202401403404409429500
GET
/inventory/v2/serviceInstances
List Sap Hana Cloud Instances in Inventory
listInventoryInstances 3 params → 200401403429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ServiceInstance (12 properties), InventoryInstance (10 properties), LastOperation (5 properties), UpdateServiceInstanceRequest (4 properties). Each schema is shown below with its type and property counts.

CreateServiceInstanceRequest
object
Request body for creating a new SAP HANA Cloud service instance.
4 properties 3 required
InventoryInstanceList
object
A paginated list of SAP HANA Cloud instances from the inventory service.
2 properties
InstanceParameters
object
Configuration parameters for an SAP HANA Cloud service instance defining resource allocation, features, and operational settings.
1 property
Error
object
Standard error response returned by the SAP HANA Cloud REST API when a request fails.
3 properties
InventoryInstance
object
An SAP HANA Cloud instance as represented in the inventory service, providing a consolidated view of instance status and configuration.
10 properties
UpdateServiceInstanceRequest
object
Request body for updating an existing SAP HANA Cloud service instance. Only include the parameters that need to be changed.
4 properties
ServiceInstance
object
An SAP HANA Cloud service instance representing a provisioned database with its configuration, status, and connection details.
12 properties
ServiceInstanceList
object
A paginated list of SAP HANA Cloud service instances in the subaccount.
3 properties
LastOperation
object
Details about the last operation performed on the service instance.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sap-hana-instances-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 Instances 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.