Skip to content

index.md

Latest commit

 

History

History
75 lines (51 loc) · 1.41 KB

index.md

File metadata and controls

75 lines (51 loc) · 1.41 KB
Raw

API Reference

Access HANA CLI programmatically through REST APIs.

Overview

HANA CLI can run as an HTTP server, exposing all commands through REST endpoints. This enables:

  • Programmatic Access - Integrate with external applications
  • Web Dashboards - Build UI on top of HANA operations
  • Microservices - Use as a service component
  • CI/CD Integration - Automate database operations

Available Resources

Starting the API Server

hana-cli UI

You can also use aliases:

hana-cli ui
hana-cli server

The server runs on http://localhost:3010 by default.

Access Swagger UI:

http://localhost:3010/api-docs

Quick Example

# Start the server
hana-cli UI

# In another terminal, get current configuration
curl http://localhost:3010/

# Update configuration
curl -X PUT http://localhost:3010/ \
  -H "Content-Type: application/json" \
  -d '{
    "schema": "MYSCHEMA",
    "table": "EMPLOYEES"
  }'

Configuration Options

Customize the server with command-line options:

# Custom port
hana-cli UI --port 8080

# Custom host
hana-cli UI --host 0.0.0.0 --port 8080

See Swagger documentation for API details.

Next Steps