{ "openapi": "3.1.0", "info": { "title": "Cron Ping HTTP Scheduler API", "version": "1.1.0", "description": "Bearer keys are workspace-scoped (read/write). 120 requests/minute/key. Shared plan quotas; Free 5-minute minimum / 10s timeout, paid plans 1-minute minimum / 30s or 60s timeout. Only public HTTP(S) ports 80/443; redirects rejected. Response previews are limited to 4096 bytes. Retries are opt-in. Interrupted requests are not automatically replayed. All timestamps use ISO 8601." }, "servers": [ { "url": "https://cron-ping.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/jobs": { "get": { "operationId": "listJobs", "summary": "List workspace jobs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobList" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] }, "post": { "operationId": "createJob", "summary": "Create a scheduled HTTP job", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobInput" } } } } } }, "/jobs/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "getJob", "summary": "Read job settings (header values hidden)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "updateJob", "summary": "Update supplied settings or pause/resume", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPatch" } } } } }, "delete": { "operationId": "deleteJob", "summary": "Delete job and retained history", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/jobs/{id}/run": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "operationId": "runJob", "summary": "Queue one manual execution without changing the schedule", "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedRun" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "maxLength": 128 } } ] } }, "/jobs/{id}/runs": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "listRuns", "summary": "List retained execution results", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunList" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] } }, "/jobs/{id}/runs/{runId}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "runId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "getRun", "summary": "Read an execution result", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Job already running", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit; Retry-After: 60", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/receipts/key": { "get": { "summary": "Public Ed25519 verification key", "security": [], "responses": { "200": { "description": "Pin this key independently over HTTPS before verifying receipts" }, "503": { "description": "Signing not configured" } } } }, "/jobs/{id}/runs/{runId}/receipt": { "get": { "summary": "Download a signed, portable execution receipt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Signed JSON receipt (attachment), no request secrets", "content": { "application/json": { "schema": { "type": "object", "required": [ "algorithm", "keyId", "payload", "signature" ], "properties": { "algorithm": { "const": "Ed25519" }, "keyId": { "type": "string" }, "publicKey": { "type": "string" }, "payload": { "type": "object" }, "signature": { "type": "string" } } } } } }, "401": { "description": "Invalid key" }, "404": { "description": "Run not found" }, "409": { "description": "No receipt for this run" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "cp_ followed by 64 hexadecimal characters" } }, "schemas": { "JobInput": { "type": "object", "required": [ "name", "url" ], "properties": { "name": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD" ], "default": "GET" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "body": { "type": [ "string", "null" ], "maxLength": 32768 }, "scheduleType": { "type": "string", "enum": [ "cron", "period" ], "default": "cron" }, "cronExpr": { "type": [ "string", "null" ], "default": "0 * * * *" }, "timezone": { "type": "string", "default": "Europe/Paris" }, "periodSeconds": { "type": "integer", "minimum": 60, "maximum": 31536000 }, "timeoutSeconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "retries": { "type": "integer", "minimum": 0, "maximum": 2, "default": 0 }, "notes": { "type": "string", "maxLength": 4000 }, "paused": { "type": "boolean" }, "workspaceId": { "type": "string", "format": "uuid" } } }, "JobPatch": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD" ], "default": "GET" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "body": { "type": [ "string", "null" ], "maxLength": 32768 }, "scheduleType": { "type": "string", "enum": [ "cron", "period" ], "default": "cron" }, "cronExpr": { "type": [ "string", "null" ], "default": "0 * * * *" }, "timezone": { "type": "string", "default": "Europe/Paris" }, "periodSeconds": { "type": "integer", "minimum": 60, "maximum": 31536000 }, "timeoutSeconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "retries": { "type": "integer", "minimum": 0, "maximum": 2, "default": 0 }, "notes": { "type": "string", "maxLength": 4000 }, "action": { "enum": [ "pause", "resume" ] } } }, "Job": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD" ], "default": "GET" }, "body": { "type": [ "string", "null" ], "maxLength": 32768 }, "scheduleType": { "type": "string", "enum": [ "cron", "period" ], "default": "cron" }, "cronExpr": { "type": [ "string", "null" ], "default": "0 * * * *" }, "timezone": { "type": "string", "default": "Europe/Paris" }, "periodSeconds": { "type": "integer", "minimum": 60, "maximum": 31536000 }, "timeoutSeconds": { "type": "integer", "minimum": 1, "maximum": 60 }, "retries": { "type": "integer", "minimum": 0, "maximum": 2, "default": 0 }, "notes": { "type": "string", "maxLength": 4000 }, "paused": { "type": "boolean" }, "id": { "type": "string" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "status": { "enum": [ "new", "up", "down", "paused", "running" ] }, "nextRunAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastRunAt": { "type": [ "string", "null" ], "format": "date-time" }, "lastDurationMs": { "type": [ "integer", "null" ] }, "downReason": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "Run": { "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "source": { "enum": [ "scheduled", "manual" ] }, "status": { "enum": [ "queued", "running", "success", "failed", "interrupted", "missed" ] }, "scheduledFor": { "type": "string", "format": "date-time" }, "startedAt": { "type": [ "string", "null" ], "format": "date-time" }, "finishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "attempts": { "type": "integer" }, "httpStatus": { "type": [ "integer", "null" ] }, "durationMs": { "type": [ "integer", "null" ] }, "responseBody": { "type": [ "string", "null" ] }, "truncated": { "type": "boolean" }, "error": { "type": [ "string", "null" ] } } }, "JobResponse": { "type": "object", "properties": { "job": { "$ref": "#/components/schemas/Job" } } }, "RunResponse": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/Run" } } }, "JobList": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "nextCursor": { "type": [ "string", "null" ] } } }, "RunList": { "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "#/components/schemas/Run" } }, "nextCursor": { "type": [ "string", "null" ] }, "totals": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "QueuedRun": { "type": "object", "properties": { "run": { "$ref": "#/components/schemas/Run" }, "resultUrl": { "type": "string" } } }, "Error": { "type": "object", "properties": { "error": { "type": "string" } } }, "Ok": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }