Skip to content
Pando

The CI tab's top - services, connections, pipelines, required checks

GET
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/ci
View as Markdown

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}$

Returns

200

OK

JSON
  • servicesarray ofobjectrequired

    The services Pando can connect.

    2 properties
    • serviceoptionalstring
    • nameoptionalstring
  • connectionsarray ofobjectrequired
    10 properties
    • idstringrequired
    • servicebuildkiterequired
    • organizationstringrequired
    • web_urlstringrequired

      The organization on the service.

    • webhook_urlstringrequired

      The URL to paste into the service's webhook settings.

    • tokenworker_secretorstoredrequired

      Where its REST token comes from: the Worker secret BUILDKITE_API_TOKEN at launch.

    • created_atstringrequired
      format: date-time
    • created_bystringrequired
    • last_eventobject | nullrequired

      The last webhook that passed its check.

      3 properties
      • atoptionalstring
        format: date-time
      • eventoptionalstring | null
      • resultoptionalstring | null

        recorded, or ignored: <reason>.

    • last_refusedobject | nullrequired

      The last webhook refused (a wrong token or signature), recorded at most every 10 s.

      2 properties
      • atoptionalstring
        format: date-time
      • reasonoptionalstring | null
  • pipelinesarray ofobjectrequired

    Each connection's pipelines - those its builds named, and those a buildkite hook names.

    11 properties
    • connectionstringrequired
    • servicestringrequired
    • slugstringrequired
    • namestringrequired
    • repostring | nullrequired

      The repo it builds.

    • web_urlstringrequired
    • last_buildCiBuildornullrequired
      2 variants

      One of the following:

      • CiBuild
        View CiBuild schema →
        19 properties
        • 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
        • 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.

      • null
    • repo_pathoptionalstring | null
    • default_branchoptionalstring | null
    • hook_idoptionalstring | null

      The buildkite hook that starts its builds on push, if any.

    • required_checksoptionalarray | null

      Its repo's required checks (from .pando/pando.toml); null while unknown.

  • required_checksarray ofobjectrequired

    Every repo's required checks, read from .pando/pando.toml (a repo with no pipeline is here too).

    3 properties
    • repooptionalstring
    • pathoptionalstring
    • checksoptionalarray | null

      Null while unknown (pando.toml unreadable or broken).

403

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