git.github.set-push-back

Push a repository back to GitHub after every push, through the App

PUT /git/api/github/repositories/{repoId}/push-backIAM git:ConfigurePushMirrorChanges stateDestructive

Replaces any push mirror the repository had. Needs git:ConnectGithub as well.

Request syntax

PUT /git/api/github/repositories/{repoId}/push-back
{
  "installation": "string",
  "repository": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • installationRequired

    string

    The installation (its id here)

    Constraints: uuid

  • repositoryRequired

    string

    owner/name on GitHub to push to

Response

200 with `id` and `url`, the GitHub page of the repository it pushes to; a first push is queued and the repository's `pushMirror` shows how it went. 404 when the installation is not yours or does not cover the repository, 409 for a mirror (it follows GitHub) or a suspended installation, 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 repository that pushes back
  • urlAlways

    string

    The GitHub page of the repository it pushes to

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:ConfigurePushMirror 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 set-push-back repoId --installation 00000000-0000-0000-0000-000000000000 --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_set-push-back.