v1beta
ApplicationAPI & CLI
Double column
curl
API
CLI

Jobs /

Get run details

Returns data about the given job run

URL parameters

    • project

      string required

      ID of the project

    • job

      string required

      ID of the job

    • run

      string required

      ID of the job run

Response attributes

  • object

    • runId

      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.

API
CLI

GET /v1beta/projects/{project}/jobs/{job}/runs/{run}

Example response

200 OK

Details about the given job run.

JSON

{
  "runId": "d34582a4-35bd-4c71-8e7c-e36999b88723",
  "active": 0,
  "backoffLimit": 0,
  "completions": 1,
  "concluded": true,
  "failed": 0,
  "runName": "cron-job-5fcf67bc56e1913e21d49504",
  "status": "SUCCESS",
  "succeeded": 0,
  "startedAt": "2020-12-08T11:47:08Z"
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com