git.merge-queue.get

Show a branch queue: settings, entries in order, recent results and events

GET /git/api/repositories/{repoId}/merge-queueIAM git:GetMergeQueueRead

Request syntax

GET /git/api/repositories/{repoId}/merge-queue

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Query parameters

  • branchRequired

    string

    The target branch whose queue to show

    Constraints: 1-255 chars

Response

200 with `branch`, `required` (whether a rule requires a queue), `config`, `entries` (live entries with state and `position`, null while waiting), `finished` (the last 20) and `events` (the last 100).

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

Fields of data

  • branchAlways

    string

    The branch whose queue this is
  • requiredAlways

    boolean

    A protection rule requires a merge queue on it
  • configAlways

    object, may be null

    The queue settings; null when none
  • config.​ruleIdAlways

    string

    The branch protection rule that requires the queue
  • config.​methodAlways

    one of merge, squash, rebase

    How queued pull requests are merged
  • config.​buildConcurrencyAlways

    number

    Builds that may run at once
  • config.​minGroupSizeAlways

    number

    Fewest pull requests merged together
  • config.​maxGroupSizeAlways

    number

    Most pull requests merged together
  • config.​waitMinutesAlways

    number

    Minutes to wait for the minimum group to fill
  • config.​checkTimeoutMinutesAlways

    number

    Minutes a build may take before it counts as failed
  • config.​onlyNonFailingAlways

    boolean

    A failed build removes its pull request at once, rather than waiting on later builds
  • entriesAlways

    array of object

    The entries still in the queue, in order
  • entries[].​idAlways

    string

    The queue entry id
  • entries[].​orgIdAlways

    string

    The organization that owns it
  • entries[].​repoIdAlways

    string

    The repository
  • entries[].​prIdAlways

    string

    The pull request queued
  • entries[].​baseBranchAlways

    string

    The protected branch the queue merges into
  • entries[].​stateAlways

    one of waiting, queued, building, passed, failed, merged, removed

    waiting (for approvals and checks), queued, building, passed, failed, merged or removed
  • entries[].​positionAlways

    number, may be null

    1-based place in line; null while waiting
  • entries[].​headOidAlways

    string, may be null

    Pull request head when it joined the line; null while waiting
  • entries[].​baseOidAlways

    string, may be null

    The commit its build sits on; null until built
  • entries[].​groupOidAlways

    string, may be null

    The commit built: the base, every entry ahead, and this one; null until built
  • entries[].​tempRefAlways

    string, may be null

    The temporary branch built; null until built
  • entries[].​mergeMethodAlways

    one of merge, squash, rebase, may be null

    How it will be merged
  • entries[].​enqueuedByIamUserIdAlways

    string, may be null

    Who added it; null when that IAM user is gone
  • entries[].​removalReasonAlways

    string, may be null

    Why it left the queue; null unless removed
  • entries[].​queuedAtAlways

    string, may be null

    When it joined the line; null while waiting
  • entries[].​buildStartedAtAlways

    string, may be null

    When its build started; null until then
  • entries[].​finishedAtAlways

    string, may be null

    When it merged or left; null while in the queue
  • entries[].​createdAtAlways

    string

    When it was added
  • entries[].​updatedAtAlways

    string

    When it last changed
  • entries[].​prAlways

    object

    The pull request of the entry
  • entries[].​pr.​numberAlways

    number

    The pull request number
  • entries[].​pr.​titleAlways

    string

    Its title
  • entries[].​pr.​sourceBranchAlways

    string

    Its source branch
  • entries[].​pr.​stateAlways

    one of open, closed, merged, draft

    Its state
  • entries[].​pr.​authorIamUserIdAlways

    string

    Who opened it
  • entries[].​pr.​sourceOidAlways

    string, may be null

    Its head commit, as last recorded
  • finishedAlways

    array of object

    The last 20 entries that merged or left, newest first
  • finished[].​idAlways

    string

    The queue entry id
  • finished[].​orgIdAlways

    string

    The organization that owns it
  • finished[].​repoIdAlways

    string

    The repository
  • finished[].​prIdAlways

    string

    The pull request queued
  • finished[].​baseBranchAlways

    string

    The protected branch the queue merges into
  • finished[].​stateAlways

    one of waiting, queued, building, passed, failed, merged, removed

    waiting (for approvals and checks), queued, building, passed, failed, merged or removed
  • finished[].​positionAlways

    number

    Sort key in the queue: a larger one is further back
  • finished[].​headOidAlways

    string, may be null

    Pull request head when it joined the line; null while waiting
  • finished[].​baseOidAlways

    string, may be null

    The commit its build sits on; null until built
  • finished[].​groupOidAlways

    string, may be null

    The commit built: the base, every entry ahead, and this one; null until built
  • finished[].​tempRefAlways

    string, may be null

    The temporary branch built; null until built
  • finished[].​mergeMethodAlways

    one of merge, squash, rebase, may be null

    How it will be merged
  • finished[].​enqueuedByIamUserIdAlways

    string, may be null

    Who added it; null when that IAM user is gone
  • finished[].​removalReasonAlways

    string, may be null

    Why it left the queue; null unless removed
  • finished[].​queuedAtAlways

    string, may be null

    When it joined the line; null while waiting
  • finished[].​buildStartedAtAlways

    string, may be null

    When its build started; null until then
  • finished[].​finishedAtAlways

    string, may be null

    When it merged or left; null while in the queue
  • finished[].​createdAtAlways

    string

    When it was added
  • finished[].​updatedAtAlways

    string

    When it last changed
  • finished[].​prAlways

    object

    The pull request of the entry
  • finished[].​pr.​numberAlways

    number

    The pull request number
  • finished[].​pr.​titleAlways

    string

    Its title
  • finished[].​pr.​sourceBranchAlways

    string

    Its source branch
  • finished[].​pr.​stateAlways

    one of open, closed, merged, draft

    Its state
  • finished[].​pr.​authorIamUserIdAlways

    string

    Who opened it
  • finished[].​pr.​sourceOidAlways

    string, may be null

    Its head commit, as last recorded
  • eventsAlways

    array of object

    The last 100 queue events, newest first
  • events[].​idAlways

    string

    The event id
  • events[].​orgIdAlways

    string

    The organization
  • events[].​repoIdAlways

    string

    The repository
  • events[].​baseBranchAlways

    string

    The queue, by its branch
  • events[].​entryIdAlways

    string, may be null

    The queue entry concerned; null for the queue as a whole
  • events[].​prIdAlways

    string, may be null

    The pull request concerned; null for the queue as a whole
  • events[].​kindAlways

    one of waiting, queued, build_started, checks_passed, checks_failed, conflict, rebuild, merged, removed

    What happened
  • events[].​detailAlways

    string, may be null

    A sentence on what happened and why
  • events[].​actorIamUserIdAlways

    string, may be null

    Who acted; null when the queue itself did
  • events[].​commitOidAlways

    string, may be null

    The commit concerned, if any
  • events[].​createdAtAlways

    string

    When it happened
  • events[].​prNumberAlways

    number, may be null

    The pull request number; null when none
  • events[].​actorAlways

    string, may be null

    The actor's username; null when the queue acted

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:GetMergeQueue 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 merge-queue get repoId --branch example

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