Scopes

See which scopes cover the files of a directory, and simulate a change to them.


Get which scopes cover the files of a directory #

GET /orgs/{owner}/repositories/{repository}/scopes/coverage

For one directory of the repository's default branch, which of its files the committed scopes hold, as the merge queue matches a pull request's changed files, in total and for each of its entries. The files are read from the branch once an hour at most.

Application key permission: configuration: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
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\-]+$

path string

The directory to describe, from the repository's root; empty for the root

max length: 4096

200 Successful Response
branchstringrequired

The default branch the files are read from

commit_shastringrequired

The commit of the branch the files are read from

listed_atstring <date-time>required

When the files were read from the branch: they are read again once an hour at most

truncatedbooleanrequired

Whether the repository holds more than the forge lists of a tree in one response (100,000 entries, directories included, or 7 MB on GitHub): the counts then cover only the files it listed

pathstringrequired

The directory described: empty for the root, else ending with /

filesintegerrequired

The files under the directory

files_without_scopeintegerrequired

Of those, the files no scope holds

files_in_all_scopesintegerrequired

Of those, the files barrier_files matches

entriesScopesCoverageEntry[]required

The directory's entries, directories first, then by name, up to 1000

namestringrequired

The entry's name in its directory

pathstringrequired

The entry's path from the repository's root

type"directory" | "file"required

Whether the entry is a directory or a file

Enum: directory file
patternstring | nullrequired

A scope glob holding this entry alone: the file, or every file under the directory. Null for a path holding a \, which a glob always reads as a separator

filesintegerrequired

The files it holds: 1 for a file

files_without_scopeintegerrequired

Of its files, those no scope holds and barrier_files leaves out: a pull request changing only such files belongs to no scope

files_in_all_scopesintegerrequired

Of its files, those barrier_files matches: a pull request changing one impacts every scope

scopesstring[]required

The scopes that hold at least one of its files, in the order of the configuration, up to 1000

scopes_omittedintegerrequired

The scopes holding its files beyond the ones listed

entries_omittedintegerrequired

The entries beyond the ones listed

Example Response
                          {
  "branch": "string",
  "commit_sha": "string",
  "listed_at": "2024-01-15T09:00:00Z",
  "truncated": true,
  "path": "string",
  "files": 0,
  "files_without_scope": 0,
  "files_in_all_scopes": 0,
  "entries": [
    {
      "name": "string",
      "path": "string",
      "type": "directory",
      "pattern": "string",
      "files": 0,
      "files_without_scope": 0,
      "files_in_all_scopes": 0,
      "scopes": null,
      "scopes_omitted": 0
    }
  ],
  "entries_omitted": 0
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 Forbidden
404 SCOPES_COVERAGE_PATH_NOT_FOUND: No file of the default branch is under the path, or the branch has no file yet.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 SCOPES_COVERAGE_MANUAL_SOURCE: The scopes come from CI reports (source: manual), so no file belongs to a scope by its path.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
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. SCOPES_COVERAGE_GLOB_TOO_COSTLY: The globs of the scopes are too costly to match against the paths of the repository.
Variant 1
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
extended_repositorystring | null
Variant 2
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "extended_repository": "string"
}
                        
503 SCOPES_COVERAGE_UNAVAILABLE: The files of the repository are still being listed.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/orgs/:owner/repositories/:repository/scopes/coverage" \
  -H "Authorization: Bearer <token>"

Simulate which scopes would cover the files of a directory #

POST /orgs/{owner}/repositories/{repository}/scopes/coverage/simulate

What GET …/scopes/coverage would answer if the repository's scopes were the one submitted, without committing it.

Application key permission: simulators: write.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
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\-]+$

path string

The directory to describe, from the repository's root; empty for the root

max length: 4096

scopesScopes | nullrequired

The scopes section to match, as .mergify.yml writes it; null for none

sourceSourceFilesAndManual | SourceFiles | SourceManual | null

Where scopes come from. files derives scopes from the pull request's changed files using file-pattern rules, and its all_scopes barrier flag from barrier_files; on its own it ignores the scopes and barrier sent via API or mergify ci scopes-send. manual uses only the scopes sent via API or mergify ci scopes-send, and waits for them. Declaring both (files and manual: null in the same mapping) adds the scopes and all_scopes flag reported for the head commit to those matched from files (through PUT /v1/repos/{owner}/{repository}/commits/{sha}/scopes, which mergify ci scopes-send calls when it knows that commit), and waits for that report, as manual does, except while the merge queue checks the pull request in place, where the head commits it pushes are not waited for. A report addressed by pull request number does not count. Leaving it unset (or null) disables scoping: the scopes and barrier sent via API or mergify ci scopes-send neither scope the merge queue nor fill the scope attribute, and only scopes-available still turns true once one is sent.

barrier_filesBarrierFileFilters | null

File filters marking files that impact every scope. Only valid with a files source (alone or with manual); with manual beside files, an all_scopes flag reported for the head commit also makes a pull request a barrier (see source), and a manual source alone reports the flag via the API instead. A pull request changing a matching file becomes a merge-queue barrier: it runs alone and serializes the queue at that point. A renamed file counts at both of its paths, so moving a file out of a matching pattern is a barrier too. At least one include pattern is required. Examples: ('.github/workflows/**', 'Makefile')

includestring[]required

Glob patterns of files that impact every scope. At least one pattern is required. Examples: ('.github/workflows/**', 'Makefile')

excludestring[]

Glob patterns of files to exclude from this scope. Evaluated after include and takes precedence. Examples: ('/tests/', '*.md')

merge_queue_scopestring

Scope name automatically applied to merge queue PRs.

min length: 2 · pattern: ^[A-Za-z0-9_-]+$
capacitiesobject

How many speculative checks each scope may run at the same time, as a map of scope name to capacity. Works for a files or manual source (the source only decides membership; capacity is declared here); with no source there is no scope to cap. A key may be any scope name the scopes API accepts, such as //lib/core or @acme/web; a files source without manual ignores reported scopes, so only its own scope names can match there. A key containing *, ?, [ or { is a glob pattern with the syntax of files filters, such as @acme/* or //lib/**: * and ? stay within one /-separated segment and only a whole ** segment crosses them, so //lib/** matches the packages below //lib but not //lib itself. In YAML, quote any key starting with @, *, ?, [ or {. A pattern gives every scope it matches its own budget, not one budget shared by all of them. A key equal to a scope's name wins over any pattern; when several patterns match a scope, the smallest capacity applies; default_capacity only covers scopes no key matches. A PR in several capped scopes consumes one slot from each. While a PR waits only for room in a full scope, a slot that frees in any of its capped scopes is kept for it rather than given to a PR behind it in the queue; an all_scopes PR waits this way in every capped scope. A PR that also waits for something else, such as its closed merge schedule, the PR it is stacked on or a bisection in its scope, keeps no slot. PRs whose scopes match no key share the repo-wide merge_queue.max_parallel_checks pool, unless default_capacity gives every scope a budget. In serial mode, PRs queued behind one waiting for room in its scope can go ahead of it when they fit, and merge before it. Strict branch protection still forces an effective capacity of 1.

default_capacityinteger | null

How many speculative checks a scope that no capacities key matches may run at the same time. Applies to every scope observed on queued pull requests, so dynamic scope sets (e.g. sent by a monorepo build tool through the scopes API) get a per-scope budget without enumerating names; a matching capacities key or pattern still wins for its scope. merge_queue.max_parallel_checks remains the global ceiling on the total. When unset, scopes no capacities key matches are unlimited, and pull requests with no scopes always draw from the repo-wide pool. In serial mode, PRs can go ahead of one waiting for room in its scope, as with capacities. Strict branch protection still forces an effective capacity of 1.

200 Successful Response
branchstringrequired

The default branch the files are read from

commit_shastringrequired

The commit of the branch the files are read from

listed_atstring <date-time>required

When the files were read from the branch: they are read again once an hour at most

truncatedbooleanrequired

Whether the repository holds more than the forge lists of a tree in one response (100,000 entries, directories included, or 7 MB on GitHub): the counts then cover only the files it listed

pathstringrequired

The directory described: empty for the root, else ending with /

filesintegerrequired

The files under the directory

files_without_scopeintegerrequired

Of those, the files no scope holds

files_in_all_scopesintegerrequired

Of those, the files barrier_files matches

entriesScopesCoverageEntry[]required

The directory's entries, directories first, then by name, up to 1000

namestringrequired

The entry's name in its directory

pathstringrequired

The entry's path from the repository's root

type"directory" | "file"required

Whether the entry is a directory or a file

Enum: directory file
patternstring | nullrequired

A scope glob holding this entry alone: the file, or every file under the directory. Null for a path holding a \, which a glob always reads as a separator

filesintegerrequired

The files it holds: 1 for a file

files_without_scopeintegerrequired

Of its files, those no scope holds and barrier_files leaves out: a pull request changing only such files belongs to no scope

files_in_all_scopesintegerrequired

Of its files, those barrier_files matches: a pull request changing one impacts every scope

scopesstring[]required

The scopes that hold at least one of its files, in the order of the configuration, up to 1000

scopes_omittedintegerrequired

The scopes holding its files beyond the ones listed

entries_omittedintegerrequired

The entries beyond the ones listed

Example Response
                          {
  "branch": "string",
  "commit_sha": "string",
  "listed_at": "2024-01-15T09:00:00Z",
  "truncated": true,
  "path": "string",
  "files": 0,
  "files_without_scope": 0,
  "files_in_all_scopes": 0,
  "entries": [
    {
      "name": "string",
      "path": "string",
      "type": "directory",
      "pattern": "string",
      "files": 0,
      "files_without_scope": 0,
      "files_in_all_scopes": 0,
      "scopes": null,
      "scopes_omitted": 0
    }
  ],
  "entries_omitted": 0
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 REPOSITORY_WRITE_ROLE_REQUIRED: The caller has read access to this private repository, not write access.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 SCOPES_COVERAGE_PATH_NOT_FOUND: No file of the default branch is under the path, or the branch has no file yet.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 SCOPES_COVERAGE_MANUAL_SOURCE: The scopes come from CI reports (source: manual), so no file belongs to a scope by its path.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
422 SCOPES_COVERAGE_GLOB_TOO_COSTLY: The globs of the scopes are too costly to match against the paths of the repository.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
503 SCOPES_COVERAGE_UNAVAILABLE: The files of the repository are still being listed.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X POST "https://api.mergify.com/v1/orgs/:owner/repositories/:repository/scopes/coverage/simulate" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "scopes": {
    "source": {
      "files": {},
      "manual": null
    },
    "barrier_files": {
      "include": null,
      "exclude": null
    },
    "merge_queue_scope": "merge-queue",
    "capacities": {},
    "default_capacity": 1
  }
}'

Was this page helpful?