Skip to content

api-server.md

Latest commit

 

History

History
136 lines (96 loc) · 1.99 KB

api-server.md

File metadata and controls

136 lines (96 loc) · 1.99 KB
Raw

REST API Server

Run HANA CLI as an HTTP server for programmatic access.

Starting the Server

# Start on default port 3010
hana-cli server

# Equivalent command
hana-cli ui

# Start on custom port
hana-cli server --port 8080

# Start on specific host
hana-cli server --host 0.0.0.0 --port 8080

Configuration

Server Options

Option Type Description
--port, -p number Server port (default: 3010)
--host string Server host (default: localhost)

Accessing the API

Swagger UI

http://localhost:3010/api-docs

OpenAPI JSON

http://localhost:3010/api-docs.json

Base URL

All routes are served from the root path:

http://localhost:3010/

Example Requests

Get Current Configuration

curl http://localhost:3010/

Response:

{
  "schema": "MYSCHEMA",
  "table": "EMPLOYEES",
  "view": "",
  "port": 3010
}

The response reflects the current runtime prompt/configuration object and may include additional properties.

Update Configuration

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

Response:

{
  "status": "ok"
}

Access Web UI

The server also provides a browser-based UI:

http://localhost:3010/ui/#Shell-home

Error Handling

The server returns standard HTTP status codes:

  • 200 - Success
  • 404 - Route not found
  • 500 - Internal server error

Error responses include a JSON body:

404 (not found):

{
  "error": {
    "message": "Route not found",
    "status": 404,
    "path": "/invalid-path"
  }
}

500 (and other server errors):

{
  "message": "Internal server error",
  "status": 500
}

See Also