# Create a job (ordered pipeline of steps, cron and/or on demand) Source: https://docs.orchard.hackclub.com/api/operations/projects_jobs_create/ `POST /apiv1/projects/{projectId}/jobs` Operation ID: `projects_jobs_create` Auth: authenticated ## Parameters | Name | In | Required | Description | | --- | --- | --- | --- | | `projectId` | path | Yes | | ## Request body ```json { "additionalProperties": {}, "properties": { "concurrencyPolicy": { "description": "forbid (default) skips a scheduled fire while a run is active; allow runs them in parallel", "enum": [ "forbid", "allow" ], "type": "string" }, "description": { "type": "string" }, "enabled": { "description": "false creates the job with a paused schedule", "type": "boolean" }, "name": { "description": "Job name, unique within the project", "maxLength": 255, "type": "string" }, "runTimeoutSeconds": { "description": "Whole-run timeout in seconds (default 21600)", "maximum": 21600, "minimum": 60, "type": "integer" }, "scheduleCron": { "description": "5-field cron schedule (UTC unless timeZone is set); omit for manual-only", "type": "string" }, "steps": { "description": "Ordered pipeline steps", "items": { "additionalProperties": {}, "properties": { "command": { "description": "Shell command; required for app steps, optional for image steps (defaults to the image entrypoint)", "type": "string" }, "cpuRequestMilli": { "description": "CPU request in millicores", "maximum": 8000, "minimum": 50, "type": "integer" }, "deploymentId": { "description": "Deployment UUID (app type, must belong to the same project)", "type": "string" }, "envVars": { "description": "Environment variables (for app steps these override the deployment env)", "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" }, "image": { "description": "Container image reference (image type)", "type": "string" }, "memoryRequestBytes": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Memory request in bytes" }, "name": { "description": "Step display name", "maxLength": 255, "type": "string" }, "retries": { "description": "Retries on failure (default 0)", "maximum": 3, "minimum": 0, "type": "integer" }, "script": { "description": "Script source (script type)", "maxLength": 65536, "type": "string" }, "scriptRuntime": { "description": "Script runtime (script type)", "enum": [ "bash", "python", "node" ], "type": "string" }, "timeoutSeconds": { "description": "Per-step timeout (default 1800)", "maximum": 21600, "minimum": 30, "type": "integer" }, "type": { "description": "script = inline script in a curated runtime; app = command in an existing deployment's image+env; image = arbitrary container image", "enum": [ "script", "app", "image" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" }, "timeZone": { "description": "IANA time zone for the cron schedule (default UTC)", "type": "string" } }, "required": [ "name", "steps" ], "type": "object" } ``` ## Responses ### 200: OK ```json { "additionalProperties": {}, "properties": { "concurrencyPolicy": { "enum": [ "forbid", "allow" ], "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "lastRun": { "additionalProperties": {}, "properties": { "createdAt": { "type": "string" }, "finishedAt": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "number": { "type": "integer" }, "startedAt": { "type": [ "string", "null" ] }, "status": { "enum": [ "pending", "running", "succeeded", "failed", "canceled", "skipped", "timed_out" ], "type": "string" }, "trigger": { "enum": [ "manual", "api", "cron" ], "type": "string" } }, "required": [ "id", "number", "status", "trigger", "startedAt", "finishedAt", "createdAt" ], "type": [ "object", "null" ] }, "name": { "type": "string" }, "nextRunAt": { "type": [ "string", "null" ] }, "organizationId": { "description": "Present on detail responses, absent on list responses", "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" }, "projectSlug": { "type": "string" }, "recentRuns": { "items": { "additionalProperties": {}, "properties": { "finishedAt": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "number": { "type": "integer" }, "startedAt": { "type": [ "string", "null" ] }, "status": { "enum": [ "pending", "running", "succeeded", "failed", "canceled", "skipped", "timed_out" ], "type": "string" } }, "required": [ "id", "number", "status", "startedAt", "finishedAt" ], "type": "object" }, "type": "array" }, "runTimeoutSeconds": { "type": "integer" }, "scheduleCron": { "type": [ "string", "null" ] }, "stepCount": { "type": "integer" }, "steps": { "items": { "additionalProperties": {}, "properties": { "command": { "type": [ "string", "null" ] }, "cpuRequestMilli": { "type": [ "integer", "null" ] }, "deploymentId": { "type": [ "string", "null" ] }, "envVars": { "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "type": "array" }, "id": { "type": "string" }, "image": { "type": [ "string", "null" ] }, "memoryRequestBytes": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "name": { "type": "string" }, "retries": { "type": "integer" }, "script": { "type": [ "string", "null" ] }, "scriptRuntime": { "enum": [ "bash", "python", "node", null ], "type": [ "string", "null" ] }, "stepOrder": { "type": "integer" }, "timeoutSeconds": { "type": "integer" }, "type": { "enum": [ "script", "app", "image" ], "type": "string" } }, "required": [ "id", "stepOrder", "name", "type", "deploymentId", "image", "command", "script", "scriptRuntime", "envVars", "cpuRequestMilli", "memoryRequestBytes", "timeoutSeconds", "retries" ], "type": "object" }, "type": "array" }, "stepSummaries": { "items": { "additionalProperties": {}, "properties": { "name": { "type": "string" }, "type": { "enum": [ "script", "app", "image" ], "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" }, "timeZone": { "type": [ "string", "null" ] }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "projectId", "scheduleCron", "timeZone", "enabled", "concurrencyPolicy", "runTimeoutSeconds", "lastRun", "recentRuns", "nextRunAt", "createdAt", "updatedAt", "steps" ], "type": "object" } ```