Set database external access

Enable or disable external connections for a supported database.

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

Request & response examples

Request example Server-side

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

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/db/access",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "external": false
    })
  }
);
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/access",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "external": False
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 200

{
  "externalAccess": false,
  "redeploying": true
}

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 or bucket service id.

Request body application/json

external boolean required

true to publish the port to the internet, false to keep it private to the project.

Response 200

Returns the saved external access flag. The database is redeployed to apply it; support depends on the database and runtime.

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

externalAccess boolean

Whether external database access is enabled.

redeploying boolean

Whether the operation applied or queued a redeployment.

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.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`set_db_external_access`

Required MCP arguments: id, external. 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/access' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "external": false }'

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