List GitHub branches for deployment

Returns the available GitHub branches and the current auto-deploy branch.

Returns the list of available GitHub branches for the storefront repository, along with the currently configured auto-deploy branch.

Requires the storefront:deployments:read or storefront.read permission.

Request

GET /storefront/deployments/github/branches

Headers

HeaderValue
AuthorizationBearer <token>

Response

Response Body

FieldTypeDescription
auto_deploy_branchstringThe branch currently configured for automatic deployment.
branchesarrayList of available branch names in the connected GitHub repository.

Example Response

{
  "auto_deploy_branch": "main",
  "branches": [
    "main",
    "develop",
    "feature/new-homepage"
  ]
}
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json