Queues

Configure and inspect merge queues for your repositories.


Get merge queues configuration #

GET /repos/{owner}/{repository}/queues/configuration
Deprecated

Get the list of all merge queues configuration sorted by processing order

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
configurationQueueRule[]required

The queues configuration of the repository

namestringrequired

The name of the queue rule

configobjectrequired

The configuration of the queue rule

Example Response
                          {
  "configuration": [
    {
      "name": "string",
      "config": {}
    }
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/queues/configuration" \
  -H "Authorization: Bearer <token>"

Pause the merge queue #

PUT /repos/{owner}/{repository}/queue/pause
Deprecated

Pause the merge of the requested repository

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

reasonstringrequired

The reason of the queue pause

max length: 255
200 Successful Response
queue_pauseQueuePause[]required

The pause of the repository

reasonstringrequired

The reason of the queue pause

max length: 255
pause_datestring <date-time>required

The date and time of the freeze

Example Response
                          {
  "queue_pause": [
    {
      "reason": "string",
      "pause_date": "2024-01-15T09:00:00Z"
    }
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X PUT "https://api.mergify.com/v1/repos/:owner/:repository/queue/pause" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Unpause merge queue #

DELETE /repos/{owner}/{repository}/queue/pause
Deprecated

Unpause the merge queue of the requested repository

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

204 Successful Response
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X DELETE "https://api.mergify.com/v1/repos/:owner/:repository/queue/pause" \
  -H "Authorization: Bearer <token>"

Get queue pause data #

GET /repos/{owner}/{repository}/queue/pause
Deprecated

Checks if the merge queue is paused and get the queue pause data

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
queue_pauseQueuePause[]required

The pause of the repository

reasonstringrequired

The reason of the queue pause

max length: 255
pause_datestring <date-time>required

The date and time of the freeze

Example Response
                          {
  "queue_pause": [
    {
      "reason": "string",
      "pause_date": "2024-01-15T09:00:00Z"
    }
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/queue/pause" \
  -H "Authorization: Bearer <token>"

Unpause merge queue #

POST /repos/{owner}/{repository}/queue/pause/delete
Deprecated

Unpause the merge queue of the requested repository

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

204 Successful Response
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X POST "https://api.mergify.com/v1/repos/:owner/:repository/queue/pause/delete" \
  -H "Authorization: Bearer <token>"

Get merge queues #

GET /repos/{owner}/{repository}/queues
Deprecated

Get the list of pull requests queued in a merge queue of a repository

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
queuesQueue[]required

The queues of the repository

branchBranchrequired

The branch of this queue

namestringrequired

The name of the branch

pull_requestsPullRequestQueued[]required

The pull requests in this queue

numberintegerrequired

The number of the pull request

min: 1 · max: 9223372036854776000
positionintegerrequired

The position of the pull request in the queue. The first pull request in the queue is at position 0

priorityintegerrequired

The priority of this pull request

effective_priorityintegerrequired

The effective priority of this pull request

priority_aliasstringrequired

The priority textual value of this pull request

queue_ruleQueueRulerequired

The queue rule associated to this pull request

namestringrequired

The name of the queue rule

configobjectrequired

The configuration of the queue rule

queued_atstring <date-time>required

The timestamp when the pull requested has entered in the queue

speculative_check_pull_requestQueues_SpeculativeCheckPullRequest | nullrequired

Use `mergeability_check` instead

in_placebooleanrequired

Whether the pull request has been checked in-place

numberintegerrequired

The number of the pull request used by the speculative check

min: 1 · max: 9223372036854776000
started_atstring <date-time> | nullrequired

The timestamp when the checks have started for this pull request

ended_atstring <date-time> | nullrequired

The timestamp when the checks have ended for this pull request

checksQueueCheck[]required

The list of pull request checks

namestringrequired

Check name

descriptionstringrequired

Check description

urlstring | nullrequired

Check detail url

details_urlstring | null

External integrator's direct URL (e.g. Jenkins build URL)

state"failure" | "error" | "cancelled" | "action_required" | "timed_out" | "pending" | "neutral" | "skipped" | "stale" | "success"required

Check state

Enum: failure error cancelled action_required timed_out pending neutral skipped stale success
avatar_urlstring | nullrequired

Check avatar_url

evaluated_conditionsstringrequired

The queue rule conditions evaluation report

state"failure" | "error" | "cancelled" | "action_required" | "timed_out" | "pending" | "neutral" | "skipped" | "stale" | "success"required

The global state of the checks

Enum: failure error cancelled action_required timed_out pending neutral skipped stale success
mergeability_checkBriefMergeabilityCheck | nullrequired

Information about the mergeability check currently processed

check_type"in_place" | "draft_pr" | "branch" | "trusted"required

The type of queue check: `in_place` (checks run on the pull request itself), `draft_pr` (checks run on a Mergify draft pull request), `branch` (checks run on a merge queue branch, with no draft pull request), or `trusted` (no queue CI run is required: the merge relies on the pull request's own green CI, either because it already contains the base branch tip or because the base commits it is missing do not affect its scopes — the latter is Direct Merge, see https://docs.mergify.com/merge-queue/direct-merge).

Enum: in_place draft_pr branch trusted
pull_request_numberinteger | nullrequired

The number of the pull request the queue checks run on: the draft pull request, or the pull request itself when it is checked in place or the check is `trusted`. Null when they run on a merge queue branch with no draft pull request: `head_sha` and `queue_branch_name` name it then.

started_atstring <date-time> | nullrequired

The timestamp when the checks have started for this pull request

ended_atstring <date-time> | nullrequired

The timestamp when the checks have ended for this pull request

state"failure" | "error" | "cancelled" | "action_required" | "timed_out" | "pending" | "neutral" | "skipped" | "stale" | "success"required

The global state of the checks

Enum: failure error cancelled action_required timed_out pending neutral skipped stale success
run_idstring <uuid> | nullrequired

The id of the queue check run: the `run_id` of its `action.queue.checks_start` and `action.queue.checks_end` events.

head_shastring | null

The commit the queue check is about: the head of the merge queue branch the checks run on, or of the pull request itself when it is checked in place or the check is `trusted`. A `trusted` check runs no queue CI: that commit's own green CI stands in for it.

queue_branch_namestring | null

The merge queue branch the queue checks run on. Null when the pull request is checked in place, or when the check is `trusted`.

estimated_time_of_mergestring <date-time> | nullrequired

The estimated timestamp when this pull request will be merged

partition_namestringrequired

The name of the partition, if any, in which the pull request is queued

Example Response
                          {
  "queues": [
    {
      "branch": {
        "name": "main"
      },
      "pull_requests": [
        {
          "number": 5678,
          "position": 1,
          "priority": 100,
          "effective_priority": 100,
          "priority_alias": "low",
          "partition_name": "__default__",
          "queue_rule": {
            "name": "default",
            "config": {
              "priority": 100,
              "batch_size": 1,
              "batch_max_wait_time": 0,
              "allow_inplace_checks": true,
              "allow_queue_branch_edit": false,
              "checks_timeout": 60,
              "draft_bot_account": "",
              "queue_branch_prefix": "mergify/merge-queue/",
              "queue_branch_merge_method": "fast-forward",
              "batch_max_failure_resolution_attempts": 10,
              "commit_message_template": "",
              "merge_bot_account": "",
              "merge_method": "merge",
              "update_bot_account": "",
              "update_method": "rebase"
            }
          },
          "speculative_check_pull_request": {
            "in_place": true,
            "number": 5678,
            "started_at": "2021-10-14T14:19:12+00:00",
            "ended_at": "2021-10-14T15:00:42+00:00",
            "checks": [],
            "evaluated_conditions": "",
            "state": "success"
          },
          "mergeability_check": {
            "check_type": "in_place",
            "pull_request_number": 5678,
            "started_at": "2021-10-14T14:19:12+00:00",
            "ended_at": "2021-10-14T15:00:42+00:00",
            "state": "success",
            "run_id": "0b3f6c2e-5a4d-4e1b-9c7a-2d8e6f1a3b5c",
            "head_sha": "8f2e4b1c9d3a7e6f5b0c2d4e6f8a1b3c5d7e9f0a"
          },
          "queued_at": "2021-10-14T14:19:12+00:00",
          "estimated_time_of_merge": "2021-10-14T15:19:12+00:00"
        },
        {
          "number": 4242,
          "position": 1,
          "priority": 100,
          "effective_priority": 100,
          "priority_alias": "low",
          "partition_name": "__default__",
          "queue_rule": {
            "name": "default",
            "config": {
              "priority": 100,
              "batch_size": 1,
              "batch_max_wait_time": 0,
              "allow_inplace_checks": true,
              "allow_queue_branch_edit": false,
              "checks_timeout": 60,
              "draft_bot_account": "",
              "queue_branch_prefix": "mergify/merge-queue/",
              "queue_branch_merge_method": "fast-forward",
              "batch_max_failure_resolution_attempts": 10,
              "commit_message_template": "",
              "merge_bot_account": "",
              "merge_method": "merge",
              "update_bot_account": "",
              "update_method": "rebase"
            }
          },
          "speculative_check_pull_request": {
            "in_place": false,
            "number": 7899,
            "started_at": "2021-10-14T14:19:12+00:00",
            "ended_at": "2021-10-14T15:00:42+00:00",
            "checks": [],
            "evaluated_conditions": "",
            "state": "success"
          },
          "mergeability_check": {
            "check_type": "draft_pr",
            "pull_request_number": 7899,
            "started_at": "2021-10-14T14:19:12+00:00",
            "ended_at": "2021-10-14T15:00:42+00:00",
            "state": "success",
            "run_id": "6d1e9a4b-2c7f-4b3e-8a5d-1f0c3e7b9d2a",
            "head_sha": "1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
            "queue_branch_name": "mergify/merge-queue/3f9c1a2b7e"
          },
          "queued_at": "2021-10-14T14:19:12+00:00",
          "estimated_time_of_merge": "2021-10-14T15:19:12+00:00"
        }
      ]
    }
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 `CONFIGURATION_INVALID`: The repository's Mergify configuration is invalid. `extended_repository` names the repository its `extends` points to when the error is in that repository's configuration file, and is null otherwise, including when the error only appears once the two configurations are merged. The route's other 422s carry no `error_code`.
detailstringrequired
error_code"CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_NAME_TAKEN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "RETRY_RULE_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_OVERLAP"
Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Example Response
                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/queues" \
  -H "Authorization: Bearer <token>"

Get the base refs in the repository #

GET /repos/{owner}/{repository}/queues/branches
Deprecated

Retrieve a list of base refs branches affected by queue activity

Admin Application Key Mergify User Token GitHub Token
repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

start_at string <date-time>

Get the stats from this date: an ISO 8601 datetime with a UTC offset (e.g. `2024-01-01T00:00:00Z`); a Unix timestamp or a datetime without an offset is refused. Defaults to 1 day before `end_at`.

end_at string <date-time>

Get the stats until this date: an ISO 8601 datetime with a UTC offset (e.g. `2024-01-01T00:00:00Z`); a Unix timestamp or a datetime without an offset is refused. Defaults to now.

200 Successful Response
base_refsstring[]required
Example Response
                          {
  "base_refs": [
    "string"
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/queues/branches" \
  -H "Authorization: Bearer <token>"

Was this page helpful?