git.github.list-installations

List connected GitHub accounts and the repositories each covers

GET /git/api/github/installationsIAM git:ListGithubInstallationsRead

Request syntax

GET /git/api/github/installations

Response

200 with `app` (the platform's GitHub App, null while it is not registered) and `installations`: each with its account, whether it is suspended, the repositories it covers and which of them are mirrored here already. An installation GitHub would not list answers with `error` set and no repositories, not a failed request.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • appAlways

    object, may be null

    The platform's GitHub App; null while it is not registered, and then `installations` is empty
  • app.​slugAlways

    string

    The App's slug on GitHub (github.com/apps/{slug})
  • app.​nameAlways

    string

    The App's name
  • app.​hostAlways

    string

    The GitHub host it is registered on (github.com)
  • installationsAlways

    array of object

    The organization's connected installations, by account name
  • installations[].​idAlways

    string

    The installation here: the `{id}` of the other github operations
  • installations[].​installationIdAlways

    number

    GitHub's id of the installation
  • installations[].​accountAlways

    string

    The GitHub user or organization it is installed on
  • installations[].​accountTypeAlways

    string

    User or Organization, as GitHub says
  • installations[].​repositorySelectionAlways

    one of all, selected

    Whether it covers all of the account’s repositories or a chosen few
  • installations[].​suspendedAlways

    boolean

    Suspended on GitHub; nothing is listed or mirrored through it
  • installations[].​errorAlways

    string, may be null

    Why its repositories could not be listed (suspended, GitHub's answer); null when they were
  • installations[].​repositoriesAlways

    array of object

    The repositories the installation covers now; empty when `error` is set
  • installations[].​repositories[].​fullNameAlways

    string

    owner/name on GitHub
  • installations[].​repositories[].​privateAlways

    boolean

    Private on GitHub
  • installations[].​repositories[].​archivedAlways

    boolean

    Archived on GitHub
  • installations[].​repositories[].​defaultBranchAlways

    string, may be null

    Its default branch; null when GitHub did not say
  • installations[].​repositories[].​htmlUrlAlways

    string

    Its page on GitHub
  • installations[].​repositories[].​mirroredAsAlways

    object, may be null

    The repository here that mirrors it; null when none does
  • installations[].​repositories[].​mirroredAs.​idAlways

    string

    The mirror repository here
  • installations[].​repositories[].​mirroredAs.​nameAlways

    string

    Its name here
  • installations[].​repositories[].​mirroredAs.​shadowCiAlways

    boolean

    Shadow CI is on for it
  • installations[].​repositories[].​mirroredAs.​shadowPausedAlways

    string, may be null

    Why shadow CI is paused (a cap reached); null when it is not

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:ListGithubInstallations on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git github list-installations

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_github_list-installations.