Skip to content

deployment_vcs_connection_list

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth.

Tool

deployment_vcs_connection_list

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth.

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth. A connection is working when status is active and needsReauth is false. Pass repoFullName ("owner/repo") to also learn, per connection, whether it can read that repo (repoAccess) — use it to choose the connection for deployment_service_update after a deploy failed with source_connection_unavailable. repoAccess is false for a connection that is not working or cannot read the repo, and absent when the check failed transiently; without repoFullName it is never set.

Behavior

HTTP
GET /deployment/vcs/connections

Arguments

Name
Type
Required
Description
repoFullName
string
—
Optional "owner/repo". When given, each connection also carries repoAccess: true when it can read the repo; false when it cannot, or is not working (status not active, or awaiting re-auth); absent when the check failed transiently (try again).

Try it

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth.

When to use

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth. A connection is working when status is active and needsReauth is false. Pass repoFullName ("owner/repo") to also learn, per connection, whether it can read that repo (repoAccess) — use it to choose the connection for deployment_service_update after a deploy failed with source_connection_unavailable. repoAccess is false for a connection that is not working or cannot read the repo, and absent when the check failed transiently; without repoFullName it is never set.

Example

Ask your agent something like this:

List the GitHub connections available to the current product: their kind (provider github = GitHub App, github-token = GitHub key), account, status and needsReauth.

The agent will invoke deployment_vcs_connection_list with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select