Get cron configuration

Read a cron service’s schedule, command, and next expected run.

GET/api/services/{id}/cronHTTPS

Request & response examples

Request exampleServer-side

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

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/cron",
  {
    method: "GET",
    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(
    "GET",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/cron",
    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

{
  "schedule": "0 9 * * *",
  "command": "npm run daily-job",
  "nextRun": "2026-10-08T09:00:00Z",
  "scheduleValid": true
}

Illustrative values · selected fields

Response details OpenAPI

Authorization

An account key with access, or a project/service key with settings:read. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key>Key setup

Path parameters

idstringrequired

Cron service id.

Response 200

Returns the saved schedule, command, next run time, and schedule validity. nextRun can be null when no next run can be calculated.

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

schedulestring

Cron expression.

commandstring

Command executed by the scheduled service.

nextRunstring

Next scheduled run timestamp, or null.

scheduleValidboolean

Whether the saved schedule can be parsed.

Errors

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

`get_cron`

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

Connect your agent

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