Raw Crontab

The Raw Crontab API reads and writes the full cron table for a system user as a single text blob. Use these endpoints when you need to inspect or replace the entire /var/spool/cron/{user} content at once. For structured, per-entry management — create, update, delete individual cron entries by id — use the cron:entries endpoints under /users/{user}/entries/{id} instead. Those are documented separately and are not covered here.

All requests target the cron service in a Hoody project container. The hostname follows the pattern https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com, where {projectId} and {containerId} are 24-character hexadecimal identifiers and {server} is the deployment region (for example node-us).

List all crontabs

GET /crontab

Returns the raw crontab text for every system user that has one, paginated.

Parameters

Name	In	Type	Required	Description
`page`	query	integer	No	Page number (1-based)
`limit`	query	integer	No	Items per page (max 200)

curl -X GET "https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com/crontab?page=1&limit=50" \
  -H "Authorization: Bearer <token>"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.cron.crontab.listGlobalIterator({ page: 1, limit: 50 });

{
  "items": [
    {
      "user": "root",
      "crontab": "# m h dom mon dow command\n0 * * * * /usr/local/bin/cleanup.sh\n"
    },
    {
      "user": "app",
      "crontab": ""
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 50
}

{
  "code": "BACKEND_ERROR",
  "message": "Internal server error"
}

Error Code	Title	Description	Resolution
`BACKEND_ERROR`	Backend error	Failed to read or write system crontab	Check crontab availability and permissions

Get raw crontab for a user

GET /users/{user}/crontab

Returns the raw text of the crontab for the specified system user. The response contains only the user and the full crontab text — no entry, id, or pagination metadata.

Parameters

Name	In	Type	Required	Description
`user`	path	string	Yes	System username

curl -X GET "https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com/users/app/crontab" \
  -H "Authorization: Bearer <token>"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.cron.crontab.get('app');

{
  "user": "app",
  "crontab": "# m h dom mon dow command\n*/15 * * * * /opt/app/sync.py\n"
}

{
  "code": "INVALID_USER",
  "message": "Invalid user"
}

Error Code	Title	Description	Resolution
`INVALID_USER`	Invalid user	User parameter failed validation	Provide a valid system username
`INVALID_COMMENT`	Invalid comment	Comment is empty, too long, or contains newlines	Provide a short single-line comment
`INVALID_SCHEDULE`	Invalid schedule	Schedule is not a valid cron expression	Use a standard 5-field cron expression or @daily style macros
`INVALID_COMMAND`	Invalid command	Command field is empty or contains invalid characters	Provide a command without newlines
`INVALID_PAGINATION`	Invalid pagination	Page or limit is out of range	Use page >= 1 and limit between 1 and 200

{
  "code": "USER_NOT_FOUND",
  "message": "User not found"
}

Error Code	Title	Description	Resolution
`USER_NOT_FOUND`	User not found	The requested system user does not exist	Create the user or choose an existing username
`ENTRY_NOT_FOUND`	Entry not found	No managed entry with the provided id exists	List entries and retry with a valid id

{
  "code": "BACKEND_ERROR",
  "message": "Internal server error"
}

Error Code	Title	Description	Resolution
`BACKEND_ERROR`	Backend error	Failed to read or write system crontab	Check crontab availability and permissions

Replace raw crontab for a user

PUT /users/{user}/crontab

Replaces the entire crontab for the specified system user. The request body is a single crontab string; the new content fully overwrites whatever was previously installed. The 200 response also reports how many expired scheduled runs were cleaned up as a side effect (removed_expired).

Parameters

Name	In	Type	Required	Description
`user`	path	string	Yes	System username

Request Body

Field	Type	Required	Description
`crontab`	string	Yes	Full crontab text to install for the user

curl -X PUT "https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com/users/app/crontab" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"crontab": "# m h dom mon dow command\n*/5 * * * * /opt/app/heartbeat.sh\n"}'

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-cron-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.cron.crontab.put('app', { crontab: '# m h dom mon dow command\n*/5 * * * * /opt/app/heartbeat.sh\n' });

{
  "user": "app",
  "crontab": "# m h dom mon dow command\n*/5 * * * * /opt/app/heartbeat.sh\n",
  "removed_expired": 2
}

{
  "code": "INVALID_USER",
  "message": "Invalid user"
}

Error Code	Title	Description	Resolution
`INVALID_USER`	Invalid user	User parameter failed validation	Provide a valid system username
`INVALID_COMMENT`	Invalid comment	Comment is empty, too long, or contains newlines	Provide a short single-line comment
`INVALID_SCHEDULE`	Invalid schedule	Schedule is not a valid cron expression	Use a standard 5-field cron expression or @daily style macros
`INVALID_COMMAND`	Invalid command	Command field is empty or contains invalid characters	Provide a command without newlines
`INVALID_PAGINATION`	Invalid pagination	Page or limit is out of range	Use page >= 1 and limit between 1 and 200

{
  "code": "USER_NOT_FOUND",
  "message": "User not found"
}

Error Code	Title	Description	Resolution
`USER_NOT_FOUND`	User not found	The requested system user does not exist	Create the user or choose an existing username
`ENTRY_NOT_FOUND`	Entry not found	No managed entry with the provided id exists	List entries and retry with a valid id

{
  "code": "PAYLOAD_TOO_LARGE",
  "message": "Payload too large",
  "details": null
}

Error Code	Title	Description	Resolution
`PAYLOAD_TOO_LARGE`	Payload too large	The submitted crontab body exceeded the server’s maximum size	Reduce the crontab size and retry

{
  "code": "BACKEND_ERROR",
  "message": "Internal server error"
}

Error Code	Title	Description	Resolution
`BACKEND_ERROR`	Backend error	Failed to read or write system crontab	Check crontab availability and permissions