Skip to content
Pando

Report a worktree (creates it, or replaces the one with this id)

Each call also refreshes last_seen_at.

PUT
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/worktrees/{worktree_id}
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}$
  • worktree_idstringrequired

    Made by the client, wt_ and 16 hex characters.

    pattern: ^[A-Za-z0-9_-]{1,64}$

Request bodyJSONrequired

  • repostringrequired

    The repo path (projects/web, or .).

  • branchstringrequired
  • pathstringrequired

    The worktree path from the root.

  • machinestringrequired
  • kindfuseorsparseorfskitrequired
  • agentoptionalstring | null

    The agent working in it, if any (PANDO_AGENT).

Returns

200

The worktree as stored.

JSON
  • idstringrequired
  • repostringrequired
  • branchstringrequired
  • pathstringrequired
  • machinestringrequired
  • kindfuseorsparseorfskitrequired
  • reported_bystringrequired

    The user whose credential reported it.

  • created_atstringrequired
    format: date-time
  • last_seen_atstringrequired
    format: date-time
  • agentoptionalstring | null

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