Rotate database credentials

Change a managed database’s password and invalidate the previous credential.

POST/api/services/{id}/db/passwordHTTPS

Request & response examples

Request exampleServer-side

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

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

Response example200

{
  "status": "password changed"
}

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

idstringrequired

Database or bucket service id.

Request bodyapplication/json

passwordstringrequired

New password (databases) or secret key (buckets, min 8 characters).

accessKeystringoptional

Buckets only: a new S3 access key. Omit to keep the current one.

Response 200

Returns confirmation after changing the database password. Update clients that hold the old credential; do not publish the replacement password.

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

statusstring

Current state of the resource or operation.

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

`rotate_db_credentials`

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

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