Skip to content
Pando
Search
Ctrl
K
Pando API
Deployment
Copy page
|
View as Markdown
Fields
id
string
required
repo
string
required
environment
string
required
sha
string
required
release
string | null
required
state
in_progress
or
success
or
failure
required
url
string | null
required
description
string | null
required
created_by
string
required
created_at
string
required
format:
date-time
Navigation
git
sessions
GET
The repositories and projects you do not record, on every machine you sign in on
PUT
Replace that list (at most 200)
PUT
This machine (the calling credential) says whether it records sessions and which stores it reads
GET
Each of your machines, as it last reported its recording (Settings)
GET
Sessions by last activity, newest first (deleted ones are not listed)
GET
A branch's sessions, numbered 1, 2, 3 by their earliest commit there, and each commit's session numbers
GET
One session, or the stub a deleted one leaves (who deleted it, when)
DEL
Delete at once and for good (its person or an owner); its pieces leave R2 now
POST
Append whole lines at the session's end (the first piece makes it)
GET
A page of the conversation, parsed on read, about 2 MB of lines at a time
DEL
Remove prompt n's turn (its person or an owner); a mark keeps its number, who and when
POST
Read every stored piece again and rebuild the session's numbers (how a parser fix reaches stored sessions)
agents
GET
The repository's agent sessions, newest first
POST
Launch an agent session acting as the caller
POST
Address with agent
GET
The caller's own chats with the repository assistant, newest first
POST
A new chat with the repository assistant
POST
Review with agent
GET
The models a session may use here
GET
One agent session
GET
Its transcript, oldest first
GET
The live view's socket (Upgrade, websocket)
POST
A follow-up, from the person who launched it
POST
Abort the run and stop the sandbox (its launcher or an owner)
issues
GET
A page of issues, and the open and closed counts for the same filters
POST
Open an issue
GET
One issue, with its body, links, participants and reactions
PATCH
Edit, label, assign, link, close or reopen an issue
GET
Comments and events together, oldest first
POST
Comment on an issue
GET
One comment, whole (a live event leaves a body over 16 KB out)
DEL
Delete a comment (yours, or anyone's as an owner); it leaves the timeline
PATCH
Edit your comment
PUT
React to an issue (once per person and reaction)
DEL
Take your reaction back
PUT
React to a comment
DEL
Take your reaction back
GET
The monorepo's labels, by name, each with its open issues
POST
Make a label (owners)
DEL
Delete a label (owners); it leaves every issue, with no timeline items
PATCH
Rename, recolour or describe a label (owners); a rename moves it on every issue in one step
releases
GET
The project's main (its commit, checks or not built, the newest build on main) and its latest release
GET
The project's tags, newest first
GET
Releases, newest first (a draft by when it was made, a published one by when it was published), 30 a page
POST
Make a release (published at once unless draft)
GET
One release, with its commit's checks
DEL
Delete a release and its files; its tag stays, and git can move or delete it again
PATCH
Edit its title or notes
POST
Publish a draft
GET
A release's notes, or (generate=1) notes written from the merges since the last published release
GET
Download a file
PUT
Upload a file (a name sent again replaces it)
DEL
Delete a file
GET
Deployments, newest first
POST
Record a deployment (the CI or a deploy script deploys; Pando records)
artifacts
GET
The branch's artifacts, newest first
POST
Upload an artifact, or the next version of one with the same name
GET
Every artifact's threads on the branch (the panel's All files)
GET
One artifact with every version
DEL
Delete it (any member), every version, its bytes and comments
GET
One file's bytes
GET
The version's document, its images written in as data addresses
GET
Its threads on every version
POST
A thread, or a reply
GET
One comment, whole
DEL
Delete your own
PATCH
Edit your own, or resolve or reopen its thread
ci
GET
The CI tab's top - services, connections, pipelines, required checks
POST
Connect a CI service (owners)
DEL
Disconnect a CI service (owners)
GET
Stored builds, newest first
GET
A build and its jobs
GET
A job's log, from the service (its last 1 MiB)
GET
A build's annotations, from the service (first 100)
GET
A build's artifacts, from the service (first 100)
GET
Download an artifact of this build
POST
Build the same commit again, with fresh tokens
POST
Cancel a running build (passed through)
POST
Retry a job (passed through)
GET
A pipeline - its configuration (pipeline.yml) and its builds
POST
New build - the pipeline builds a branch's head as Pando has it
POST
Buildkite's webhooks (the URL a connection shows)
users
POST
Make a user and a first credential (bootstrap secret only; self-hosted, one person)
POST
pando login, step 1: a code to confirm in the browser
POST
pando login, step 2 (polled): the user and a new machine credential
GET
Sign in a browser (redirects to AuthKit)
GET
Where AuthKit sends the browser back (sets the session cookie)
GET
Opened in a browser, goes to the app
POST
Sign out this browser (and end its WorkOS session)
GET
The user behind the credential, and the credential itself
PATCH
Change your profile's header (Edit profile)
GET
This user's credentials (no secrets)
POST
Make a credential for this user (another machine, a cloud sandbox)
DEL
Revoke one of this user's credentials
GET
Whose namespace this is, a person or an organization (what `/{name}` shows)
GET
A person's contribution graph and timeline for the last year
orgs
GET
The organizations this user is in, with their role, by login
POST
Create an organization; the caller is its first owner
GET
An organization's header (anyone signed in)
PATCH
Change an organization's details (owners)
GET
An organization's people, by login (its people only)
PUT
Add a person to the organization by login, or change their role (owners)
DEL
Remove a person from the organization (owners), or leave it (yourself)
GET
Invites still waiting (its people)
POST
Add a person to the organization by email (owners)
DEL
Withdraw an invite (owners)
monorepos
GET
The monorepos this user belongs to (their own, by membership, and by organization)
POST
Create a monorepo; the caller becomes its owner
GET
The activity log across the person's monorepos (JSON pages, or the person's WebSocket)
GET
Get a monorepo (members); an old name answers with the current one
DEL
Delete a monorepo, its repos and their history (owners)
PATCH
Rename or transfer a monorepo (owners)
GET
The monorepo's event stream (JSON pages, or a WebSocket)
GET
The monorepo's members
GET
Invites still waiting
POST
Invite a person by email (owners)
DEL
Withdraw an invite (owners)
PUT
Add a user to the monorepo, or change their role (owners)
DEL
Remove a user's own row from the monorepo (owners; a person's monorepo keeps one owner)
branches
GET
"Needs you": open branches that are ready, conflicting or failing, and issues assigned to the person, across their monorepos
GET
List branches with head, base, author, ahead and behind, mergeable and checks
POST
Create a branch on the server, off main by default
GET
One branch, as in the list
DEL
Delete a branch (not the default one)
PATCH
Set the branch's title and description
GET
The branch's own commits, newest first, with Pando's trailers parsed
GET
The branch diff (GitHub's three-dot diff, merge base to head)
repos
GET
Every code repo's main head (for followers; no Artifacts read)
GET
List repos
POST
Create a repo in a monorepo
GET
Get a repo
PATCH
A project's settings (owners)
GET
A folder at any ref
GET
The last commit that changed each entry of a folder
GET
Commits that changed one path, newest first
GET
One file's bytes at a ref
reviews
GET
The branch's reviews, oldest first
POST
Review a branch (a comment or an approval; not a gate)
merges
POST
Land the branch on the default branch with a merge commit (any member)
statuses
POST
Report a commit status (GitHub's body)
GET
The combined status of a commit (latest per context)
GET
One commit, the branch it came from, and its checks (the web's commit page)
GET
What a commit changed against its first parent, streamed as Files changed is
hooks
GET
List hooks
POST
Register a hook (owners)
DEL
Remove a hook (owners)
GET
The hook's deliveries, newest first (last 100)
POST
Replay a hook from a seq, after an outage (owners)
POST
Send a delivery again (owners)
worktrees
GET
The Machines tab, one row per machine (a credential), latest activity first
GET
Every worktree in the monorepo, across machines
GET
One worktree
PUT
Report a worktree (creates it, or replaces the one with this id)
DEL
Remove a worktree from the registry
Esc
Type to search…
↑↓ navigate
↵ select
Esc close
