Get job runs | Jobs | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Jobs /

Get job runs

Fetches run history for the given job

Required permission

Project > Jobs > General > Read

Path parameters

    • projectId

      string required

      ID of the project

    • jobId

      string required

      ID of the job

Query parameters

    • per_page

      integer

      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer

      The page number to access.

    • cursor

      string

      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • runs

        [array] required

        An array of job run objects.

        • {object}

          • id

            string required

            The ID of the job run

          • active

            integer required

            Whether the run is currently in progress

            one of
            0, 1

          • backoffLimit

            integer required

            The number of attempts to retry this job run before it is marked as failed.

          • completions

            integer required

            The number of times this job run has concluded successfully or with an error.

          • concluded

            boolean required

            Has the job run finished?

          • failed

            integer required

            Whether this job run failed to complete successfully

            one of
            0, 1

          • runName

            string required

            The name of the job run

          • status

            string required

            A string representing the status of the job. Either SUCCESS, RUNNING or FAILED

            one of
            SUCCESS, RUNNING, FAILED

          • succeeded

            integer required

            Whether this job run completed successfully

            one of
            0, 1

          • startedAt

            string required

            The timestamp when the job run started.

          • concludedAt

            string required

            The timestamp when the job run concluded.

    • pagination

      {object} required

      Data about the endpoint pagination.

      • hasNextPage

        boolean required

        Is there another page of results available?

      • cursor

        string

        The cursor to access the next page of results.

      • count

        number required

        The number of results returned by this request.

API
CLI
JS Client

GET /v1/projects/{projectId}/jobs/{jobId}/runs

Example response

200 OK

A list of runs for this job.

JSON

{
  "data": {
    "runs": [
      {
        "id": "d34582a4-35bd-4c71-8e7c-e36999b88723",
        "active": 0,
        "backoffLimit": 0,
        "completions": 1,
        "concluded": true,
        "failed": 0,
        "runName": "example-job-5fcf67bc56e1913e21d49504",
        "status": "SUCCESS",
        "succeeded": 0,
        "startedAt": "2020-12-08T11:47:08Z",
        "concludedAt": "2020-12-08T11:52:08Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com