Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Clockrook Jobs API
version: 0.1.0
contact:
email: info@apievangelist.com
license:
name: Apache-2.0
description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: clockrook-openapi.json, clockrook-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://clockrook.com
security:
- apiKey: []
tags:
- name: Jobs
paths:
/v1/jobs:
post:
operationId: create_job
summary: Schedule a job
description: 'Run something later or repeatedly. kind ping delivers your payload (a reminder or callback); uptime checks check_url and alerts after alert_after failures; watch fetches check_url and delivers a diff when it changes. schedule is one of {at}, {every_seconds} or {cron (5-field), timezone}. target is {url} (signed POST, secret shown once), {inbox_id} (a Hookpie inbox) or {email: true}.'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: A label
kind:
type: string
enum:
- ping
- uptime
- watch
schedule:
type: object
target:
type: object
payload:
description: JSON delivered with a ping
check_url:
type: string
description: URL for uptime or watch
alert_after:
type: integer
description: Uptime failures before alerting (default 3)
json_path:
type: string
description: Watch only part of a JSON response, e.g. $.data.price
required:
- schedule
- target
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
get:
operationId: list_jobs
summary: List jobs
description: Your jobs, their schedules and last run.
parameters: []
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
/v1/jobs/{id}:
get:
operationId: get_job
summary: One job
description: A job and its state.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
delete:
operationId: delete_job
summary: Delete a job
description: Remove the job and its schedule.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
/v1/jobs/{id}/run:
post:
operationId: run_job
summary: Run a job now
description: Run it immediately, outside its schedule (metered like any run).
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
/v1/jobs/{id}/runs:
get:
operationId: list_runs
summary: Run history
description: 'Recent runs: outcome, status, latency, delivery.'
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
description: 1-100
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
/v1/jobs/{id}/pause:
post:
operationId: pause_job
summary: Pause a job
description: Stop it running until resumed.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
/v1/jobs/{id}/resume:
post:
operationId: resume_job
summary: Resume a job
description: Start a paused job again.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Invalid (problem details)
'401':
description: API key required
'402':
description: 'The owner must act: see account_url'
'404':
description: Not found
tags:
- Jobs
servers:
- url: https://clockrook.com
components:
securitySchemes:
apiKey:
type: http
scheme: bearer
description: An API key from POST /v1/accounts (shown once).
x-refined-from:
- clockrook-openapi.json
- clockrook-openapi.yml
x-provenance:
method: harvested
publisher: Clockrook
source: https://clockrook.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)