apikeys
jobs
- GETList all jobs
- POSTTries to create a new Job Definition
- GETReturns list of jobs that must be executed
- POSTMarks pending job execution as complete
- GETSend job executions over Server Sent Events
- GETReturns a list of executions for a job
- PATCHUpdate a job's muted status
- PATCHTemporary stops a job from running
- PATCHResumes job execution
- POSTImmediately triggers a job
- GETRetrieve a job by its ID
- DELRemoves schedule for a job and removes its execution logs
org
Retrieve a job by its ID
curl --request GET \
--url https:/api.schedo.dev/api/jobs/{jobId} \
--header 'X-API-ENVIRONMENT: <x-api-environment>'{
"job": {
"blocking": true,
"command": "<string>",
"created_at": "<string>",
"cron_expression": "<string>",
"environment_id": 123,
"id": 123,
"key": "<string>",
"last_run_at": "<string>",
"max_retries": 123,
"metadata": {},
"muted": true,
"name": "<string>",
"next_run_at": "<string>",
"paused": true,
"retry_count": 123,
"status": "<string>",
"timeout": "<string>",
"timeout_seconds": 123,
"updated_at": "<string>"
},
"last_run": {
"duration": 123,
"end_time": "<string>",
"error": "<string>",
"exit_code": 123,
"id": 123,
"job_code": "<string>",
"output": "<string>",
"pick_up_time": "<string>",
"start_time": "<string>",
"status": "<string>"
}
}Headers
1
Path Parameters
1
Response
Blocking holds the value of the "blocking" field.
Command to execute
Time when the job was created
Cron expression for job scheduling
ID of the user who owns this job
ID of the ent.
Key holds the value of the "key" field.
Time when the job was last executed
Maximum number of retry attempts
Additional metadata for the job
Whether notifications for this job are muted
Name of the job
Scheduled time for next execution
Paused holds the value of the "paused" field.
Number of retry attempts
Current job status (pending, running, completed, failed)
Maximum execution time before job is terminated
Maximum execution time before job is terminated
Time when the job was last updated
Duration holds the value of the "duration" field.
Time when execution completed
Error message if execution failed
Exit code of the executed command
ID of the ent.
JobCode holds the value of the "job_code" field.
Output of the executed command
Time when execution was picked up by a worker
Time when execution started
Execution status (running, completed, failed, skipped, expired)
curl --request GET \
--url https:/api.schedo.dev/api/jobs/{jobId} \
--header 'X-API-ENVIRONMENT: <x-api-environment>'{
"job": {
"blocking": true,
"command": "<string>",
"created_at": "<string>",
"cron_expression": "<string>",
"environment_id": 123,
"id": 123,
"key": "<string>",
"last_run_at": "<string>",
"max_retries": 123,
"metadata": {},
"muted": true,
"name": "<string>",
"next_run_at": "<string>",
"paused": true,
"retry_count": 123,
"status": "<string>",
"timeout": "<string>",
"timeout_seconds": 123,
"updated_at": "<string>"
},
"last_run": {
"duration": 123,
"end_time": "<string>",
"error": "<string>",
"exit_code": 123,
"id": 123,
"job_code": "<string>",
"output": "<string>",
"pick_up_time": "<string>",
"start_time": "<string>",
"status": "<string>"
}
}