Set database TLS

Enable or disable external TLS for a supported database.

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

Request & response examples

Request example Server-side

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

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

Response example 200

{
  "tls": true,
  "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 service id.

Request body application/json

tls boolean required

true to serve TLS on the database port.

Response 200

Returns the saved TLS flag and redeployment state. Enable only when the database supports external TLS.

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

tls boolean

Whether external database TLS 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_tls`

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

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