Execute a SQL query

Run a SQL query against a managed database. Queries can modify data; inspect the response for execution errors.

POST /api/services/{id}/db/console HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/db/console' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "query": "SELECT 1;"
}'

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/db/console",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "SELECT 1;"
    })
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "POST",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/db/console",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "query": "SELECT 1;"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 200

{
  "output": "1\n"
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access to the resource. Project and service keys do not authorize this operation.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Database service id.

Request body application/json

query string required

SQL to execute.

Response 200

Returns console output as text. Inspect error even on HTTP 200: a SQL execution failure is returned in the response body. Query execution can modify data.

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

output string

Database console output as text.

Errors

400

Invalid parameters. Check the required fields, types, and resource configuration.

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

`db_query`

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

Connect your agent ↗

curl --fail-with-body --request POST \ 'https://app.helicarrier.xyz/api/services/YOUR_ID/db/console' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "query": "SELECT 1;" }'

import os import requests response = requests.request( "POST", "https://app.helicarrier.xyz/api/services/YOUR_ID/db/console", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, json={ "query": "SELECT 1;" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.