Rotate workload identity key

Rotate a service’s workload identity signing key. The previous key stays published until every token it signed has expired.

POST/api/services/{id}/workload-identity/rotateHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/workload-identity/rotate' \
  -H "Authorization: Bearer $HELI_API_KEY"

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

Response example200

{
  "kid": "kid_example",
  "note": "the previous key stays published until every token it signed has expired"
}

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

Service id.

Response 200

Returns the new key id. Tokens signed by the previous key keep verifying until they expire; no trust policy change is needed.

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

kidstring

notestring

Additional information about the result; can be empty.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

409

The current resource state prevents the operation. Inspect it before retrying.

503

The request could not be completed.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`rotate_workload_identity_key`

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

Connect your agent

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