Skip to content
FeedbackDashboard

List project branches

$ stl projects:branches list
GET/v0/projects/{project}/branches

Retrieve a project branch by name.

ParametersExpand Collapse
--project: optional string

Path param

--cursor: optional string

Query param: Pagination cursor from a previous response

--limit: optional number

Query param: Maximum number of items to return, defaults to 10 (maximum: 100).

exclusiveMinimum0
maximum100
ReturnsExpand Collapse
unnamed_schema_1: object { data, has_more, next_cursor }
data: array of object { branch, config_commit, latest_build_id, 3 more }
branch: string

Branch name

config_commit: object { repo, sha }

A Git commit that points to the latest set of config files on a given branch.

repo: object { branch, name, owner }
branch: string
name: string
owner: string
sha: string
latest_build_id: string
object: "project_branch"
org: string
project: string

Project name

has_more: boolean
next_cursor: optional string

List project branches

stl projects:branches list \
  --project project
{
  "data": [
    {
      "branch": "branch",
      "config_commit": {
        "repo": {
          "branch": "branch",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha"
      },
      "latest_build_id": "latest_build_id",
      "object": "project_branch",
      "org": "org",
      "project": "project"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
Returns Examples
{
  "data": [
    {
      "branch": "branch",
      "config_commit": {
        "repo": {
          "branch": "branch",
          "name": "name",
          "owner": "owner"
        },
        "sha": "sha"
      },
      "latest_build_id": "latest_build_id",
      "object": "project_branch",
      "org": "org",
      "project": "project"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}