git.github.mirror

Mirror a GitHub repository the installation covers (no token kept)

POST /git/api/github/installations/{id}/mirrorIAM git:ConnectGithubChanges state

Answers 202. Needs git:CreateRepository as well as git:ConnectGithub.

Request syntax

POST /git/api/github/installations/{id}/mirror
{
  "repository": "string",
  "name": "string",
  "shadowCi": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • repositoryRequired

    string

    owner/name on GitHub

  • nameOptional

    string

    Name here; GitHub’s name when omitted

  • shadowCiOptional

    boolean

    Run its workflows here on every push to the default branch (capped)

Response

202 with `id` and `name` of the new private repository; the import is queued and `get-import` follows it, then every push on GitHub syncs it. 404 when the installation is not yours or does not cover the repository, 409 when it is suspended or a repository of that name exists, 502 when GitHub could not be asked.

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

Fields of data

  • idAlways

    string

    The new mirror repository
  • nameAlways

    string

    Its name here

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:ConnectGithub 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 mirror id --repository example

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