Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Create a cron job in a project

Tool details

FieldValue
Namecreate_cron_job
GroupJobs

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "name": {
      "type": "string",
      "description": "Cron job name"
    },
    "target": {
      "type": "string",
      "description": "Target to run (e.g. container image or script path)"
    },
    "environment_id": {
      "type": "string",
      "description": "Environment ID to scope this cron job to"
    },
    "branch_id": {
      "type": "string",
      "description": "Branch ID for the project source snapshot (omit for main)"
    },
    "schedule": {
      "type": "string",
      "pattern": "^(\\S+\\s+){4}\\S+$",
      "description": "Cron schedule expression (e.g. \"*/5 * * * *\")"
    },
    "timezone": {
      "type": "string",
      "description": "Timezone for the schedule (default: UTC)"
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values supplied to the tool."
      },
      "description": "Job configuration / environment variables"
    },
    "timeout_seconds": {
      "type": "number",
      "description": "Timeout in seconds per run (default: 300)"
    },
    "backoff_limit": {
      "type": "number",
      "description": "Number of retries on failure (default: 3)"
    },
    "concurrency_policy": {
      "type": "string",
      "enum": [
        "Allow",
        "Forbid",
        "Replace"
      ],
      "description": "Concurrency policy (default: Forbid)"
    }
  },
  "required": [
    "project_reference",
    "name",
    "target",
    "schedule"
  ],
  "additionalProperties": false,
  "description": "Input schema for the create_cron_job tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Cron job identifier."
    },
    "project_id": {
      "type": "string",
      "description": "Project identifier that owns the cron job."
    },
    "environment_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Environment identifier used when scheduled runs execute."
    },
    "branch_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Branch identifier whose source snapshot the cron job uses."
    },
    "name": {
      "type": "string",
      "description": "Human-readable cron job name."
    },
    "status": {
      "type": "string",
      "description": "Lifecycle status of the cron job, such as active or paused."
    },
    "target": {
      "type": "string",
      "description": "Execution target invoked on each schedule."
    },
    "schedule": {
      "type": "string",
      "description": "Cron expression that defines when the job can run."
    },
    "timezone": {
      "type": "string",
      "description": "Timezone applied when evaluating the cron schedule."
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      },
      "description": "Resolved configuration payload passed to scheduled executions."
    },
    "timeout_seconds": {
      "type": "number",
      "description": "Execution timeout for each scheduled run in seconds."
    },
    "backoff_limit": {
      "type": "number",
      "description": "Maximum retry count for each scheduled run."
    },
    "concurrency_policy": {
      "type": "string",
      "description": "Concurrency policy that controls overlapping scheduled runs."
    },
    "last_scheduled_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when the cron job most recently created a run."
    },
    "last_successful_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when the cron job most recently completed successfully."
    },
    "created_at": {
      "type": "string",
      "description": "Timestamp when the cron job was created."
    },
    "updated_at": {
      "type": "string",
      "description": "Timestamp when the cron job was last updated."
    }
  },
  "required": [
    "id",
    "project_id",
    "environment_id",
    "branch_id",
    "name",
    "status",
    "target",
    "schedule",
    "timezone",
    "config",
    "timeout_seconds",
    "backoff_limit",
    "concurrency_policy",
    "last_scheduled_at",
    "last_successful_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Scheduled cron job definition returned by MCP cron tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}