Skip to content

A build and its jobs

GET
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/ci/builds/{build}

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • ownerstringrequired

    The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
  • monorepostringrequired

    The monorepo's name within its owner (or an old name). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
  • buildstringrequired

    Pando's build id (cib_<16 hex>).

Returns

200

OK

JSON
  • idstringrequired

    Pando's id (cib_...).

  • servicestringrequired
  • connectionstringrequired
  • pipelinestringrequired
  • numberintegerrequired
  • repostringrequired
  • shastring | nullrequired

    Null when the service built no fixed commit.

  • statequeuedorrunningorblockedorpassedorfailedorcanceled+1 morerequired

    One vocabulary for every service. Buildkite's scheduled and waiting are queued, failing and canceling are running, not_run and broken are skipped; service_state keeps the service's own word.

  • service_statestringrequired
  • created_atstring | nullrequired
    format: date-time
  • jobsarray ofobjectrequired

    First scheduled first. Wait steps are left out.

    16 properties
    • idstringrequired

      The service's job id.

    • buildstringrequired
    • typestringrequired

      script, trigger or manual.

    • statequeuedorrunningorblockedorpassedorfailedorcanceled+1 morerequired

      One vocabulary for every service. Buildkite's scheduled and waiting are queued, failing and canceling are running, not_run and broken are skipped; service_state keeps the service's own word.

    • service_statestringrequired
    • checkstring | nullrequired

      The check (status context) it reports, its step key; null for jobs that report none.

    • nameoptionalstring | null
    • step_keyoptionalstring | null
    • exit_statusoptionalinteger | null
    • soft_failedoptionalboolean
    • retriedoptionalboolean

      A newer job replaced it (Retry).

    • web_urloptionalstring | null
    • created_atoptionalstring | null
      format: date-time
    • started_atoptionalstring | null
      format: date-time
    • finished_atoptionalstring | null
      format: date-time
    • duration_soptionalinteger | null
  • repo_pathoptionalstring | null
  • branchoptionalstring | null
  • messageoptionalstring | null
  • web_urloptionalstring | null
  • pushed_byoptionalstring | null

    Who pushed the commit (a login), from Pando's own records; never the service's creator.

  • started_atoptionalstring | null
    format: date-time
  • finished_atoptionalstring | null
    format: date-time
  • duration_soptionalinteger | null
  • rebuilt_fromoptionalstring | null

    The service's id of the build this one rebuilt.

404

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      6 properties
      • shastring | nullrequired
      • statesuccessorpendingorfailureorerrorormissingorunknownrequired

        success when the merge gate passes; missing when a required context has not reported; unknown while the required checks are (an unforced merge is refused).

      • requiredarray | nullrequired

        Null while unknown.

      • checks_unknownstring | nullrequired

        Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.

      • statusesarray ofobjectrequired

        The latest status per context.

        8 properties
        • shastringrequired
        • contextstringrequired
        • statependingorsuccessorfailureorerrorrequired
        • created_atstringrequired
          format: date-time
        • target_urloptionalstring | null
        • descriptionoptionalstring | null
        • creatoroptionalstring

          The member who posted it (a login); app:<slug> for a status posted with a status token or by a CI integration; hook:<hook id> for a status token from a web hook with no app.

        • appoptionalstring | null

          The CI service that reported it (buildkite, github-actions, ...), stamped by Pando from a status token or a CI integration, never from the body or target_url. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.

      • missingoptionalarray ofstring
Navigation

Type to search…

↑↓ navigate↵ selectEsc close