git.branches.update-from

Bring a branch up to date with its target

POST /git/api/repositories/{repoId}/update-branchIAM git:PushRepositoryChanges stateDestructive

Request syntax

POST /git/api/repositories/{repoId}/update-branch
{
  "branch": "string",
  "target": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • branchRequired

    string

    The branch to bring up to date; it gets a merge commit

    Constraints: 1-255 chars

  • targetRequired

    string

    The branch merged into it, usually the pull request target

    Constraints: 1-255 chars

Response

200 with `commitOid`, the merge commit now at the tip of `branch`. 409 when it is already up to date or the merge conflicts.

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

Fields of data

  • commitOidAlways

    string

    The new commit, now the tip of the branch

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:PushRepository 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 branches update-from repoId --branch example --target example

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