API
Settings → API でキーを作成し、X-Api-Key ヘッダーで送ります。
GET https://taskbeacon.io/api/v1/jobs list your jobs
POST https://taskbeacon.io/api/v1/jobs create one: {"name": "Sales", "period_minutes": 1440}
GET https://taskbeacon.io/api/v1/jobs/ID one job
DELETE https://taskbeacon.io/api/v1/jobs/ID delete (owner only)
ジョブの ping_url は、そのジョブを編集できる人にだけ含まれます。
alerts_on は、監視はされているがアラートを送らないジョブでは false です。ジョブを作成するときに "alerts_on": false
を送ると、その状態で始まります(既定は true)。
ping のアドレス
ping にキーは不要です。アドレスそのものが秘密情報です。GET でも POST でも動きます(POST の本文は 10 KB まで保存され、失敗の場合は最後の 10 KB が保存されます)。
https://taskbeacon.io/ping/ID finished (numbers after ?, e.g. ?rows=15234, or a JSON body) https://taskbeacon.io/ping/ID/start started https://taskbeacon.io/ping/ID/fail failed (?exit_code=, ?rc=, ?error=, the output as the body) https://taskbeacon.io/ping/ID/0 finished, by exit code https://taskbeacon.io/ping/ID/N failed with exit code N (any other number)
HEAD リクエスト(リンクのプレビュー)には応答しますが、実行としては数えません。終了コード と出力内の単語も参照してください。