git.branch-protection.list

List branch protection rules

GET /git/api/repositories/{repoId}/branch-protectionIAM git:GetRepositoryRead

Request syntax

GET /git/api/repositories/{repoId}/branch-protection

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Response

200 with the rules: id, branchPattern, every setting with its current value, createdAt and updatedAt.

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

Fields of data

  • [].​idAlways

    string

    The rule's id
  • [].​orgIdAlways

    string

    Your organization
  • [].​repoIdAlways

    string

    The repository the record belongs to
  • [].​branchPatternAlways

    string

    The branch name or glob the rule covers
  • [].​requirePullRequestAlways

    boolean

    Changes must land through a pull request
  • [].​requiredApprovalsAlways

    number

    Approvals a pull request needs to merge
  • [].​dismissStaleApprovalsAlways

    boolean

    A new push withdraws earlier approvals
  • [].​requireCodeOwnerReviewAlways

    boolean

    Every changed file CODEOWNERS assigns needs an approval from one of its owners
  • [].​requireStatusChecksAlways

    boolean

    Required checks must pass before a merge
  • [].​requiredChecksAlways

    array of string

    Checks that must pass, by workflow or status context name; empty means every workflow a pull request triggers
  • [].​blockForcePushAlways

    boolean

    Pushes that rewrite the branch history are refused
  • [].​blockDeletionAlways

    boolean

    Deleting the branch is refused
  • [].​requireMergeQueueAlways

    boolean

    The branch moves only through the merge queue; direct pushes and merges are refused
  • [].​mergeQueueMethodAlways

    one of merge, squash, rebase

    How the queue merges each pull request
  • [].​mergeQueueBuildConcurrencyAlways

    number

    How many queued pull requests may be building at once
  • [].​mergeQueueMinGroupSizeAlways

    number

    Fewest pull requests to wait for before the first build starts
  • [].​mergeQueueMaxGroupSizeAlways

    number

    Most pull requests landed by one fast-forward
  • [].​mergeQueueWaitMinutesAlways

    number

    Minutes to wait for the minimum group size before building anyway
  • [].​mergeQueueCheckTimeoutMinutesAlways

    number

    Minutes a queue build may wait for its checks before it fails
  • [].​mergeQueueOnlyNonFailingAlways

    boolean

    Only pull requests whose own build passed land; off lets a later passing build carry them
  • [].​createdAtAlways

    string

    When the rule was added (ISO 8601)
  • [].​updatedAtAlways

    string

    When the rule was last changed (ISO 8601)

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:GetRepository 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 branch-protection list repoId

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