Skip to content
GitHub

Branches of one repository the connection can read.

GET
/api/v1/git/connections/{connection}/branches
curl --request GET \
  --url 'https://example.com/api/v1/git/connections/example/branches?repository=example'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
connection
required
string

Connection id

Query Parameters

Section titled “Query Parameters”
repository
required
string

owner/name.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>
object
name
required
string
commit

The head commit.

string | null
protected
required
boolean
default
required
boolean
Examplegenerated
[
  {
    "name": "example",
    "commit": "example",
    "protected": true,
    "default": true
  }
]

403

Section titled “403”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

404

Section titled “404”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

422

Section titled “422”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

502

Section titled “502”

The provider refused or failed

Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}

503

Section titled “503”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}