Cycle Docs | API Reference

List Jobs

Use this API call to fetch a list of jobs.

Requires the jobs-view permission.

Returns

Returns a collection of job resources, otherwise returns an Error.

GET /v1/jobs

Example Request

$ curl https://api.cycle.io/v1/jobs \
  -H "Authorization: Bearer  API_KEY"
 \
  -H "X-HUB-ID:  HUB_ID"

Example Response

{
  "data": [
    {
      "id": "5d543ec1db2ab00001078d04",
      "queue": "environment-5cec602e4146380001934759",
      "caption": "Starting Container 'Environment Discovery (DNS)'",
      "events": {
        "queued": "2019-08-14T17:02:57.324Z",
        "started": "2019-08-14T17:02:57.324Z",
        "completed": "2019-08-14T17:02:57.352Z"
      },
      "schedule": "0001-01-01T00:00:00Z",
      "expires": "2019-08-14T18:02:57.316Z",
      "tasks": [
        {
          "id": "5d543ec1db2ab00001078d05",
          "caption": "Starting Container 'Environment Discovery (DNS)'",
          "header": "container.start",
          "action": "task-action",
          "events": {
            "queued": "2019-08-14T17:02:57.324Z",
            "started": "0001-01-01T00:00:00Z",
            "completed": "0001-01-01T00:00:00Z"
          },
          "error": null,
          "steps": [],
          "state": {
            "current": "completed",
            "changed": "2019-08-14T17:02:57.352Z"
          },
          "input": {
            "id": "5cec602edb2ab00001777d1e"
          },
          "output": {
            "id": "5cec602edb2ab00001777d1e"
          },
          "failable": false
        }
      ],
      "hash": "51e6f489a1eb20f425994bb8fe24b361",
      "limit_duplicates": true,
      "creator": {
        "id": "59dafefe91238b0001ba0ccc",
        "type": "account"
      },
      "hub_id": "5a14ddd8b6393d0001976f44",
      "state": {
        "current": "completed",
        "changed": "2019-08-14T17:02:57.352Z"
      }
    }
  ]
}