Skip to content
Helicarrier Developers

List engines

Discover supported database engines, versions, and provisioning capabilities.

GET /api/hangar/engines HTTPS
Request & response examples
Request example Server-side
curl --fail-with-body --request GET \
'https://app.helicarrier.xyz/api/hangar/engines' \
-H "Authorization: Bearer $HELI_API_KEY"
Response example 200
[
{
"engine": "postgres",
"name": "PostgreSQL",
"port": 5432,
"hasUser": true,
"hasDatabase": true,
"storage": false
}
]

Illustrative values · selected fields

Authorization

Any valid API key. Catalog and identity reads do not require a capability category.

Authorization: Bearer <key> Key setup ↗

Parameters

This request does not require path, query, or body parameters.

Response 200

Returns the database engine catalog. Use an engine key from this list when creating a database; available versions and capabilities differ by engine.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

engine string

Database engine key.

name string

Human-readable resource name.

port integer

Port number for the resource.

hasUser boolean
hasDatabase boolean
storage boolean

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

Error handling and safe retries
ALSO AVAILABLE VIA MCP

list_engines

Required MCP arguments: none. Send path, query, and body fields together as tool arguments.

Connect your agent ↗