scopes

Get which scopes cover the files of a directory

Changed on

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.

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

Request

  • Base URL
    https://api.mergify.com/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Path parameters

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Query parameters

pathstring

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

Headers

Mergify-Versionstring nullable

The API version the request is written against, a date (YYYY-MM-DD). Without it, a request made with an application key is served its organization's API version, and any other request 2026-11-16. A version this server does not serve is refused with a 400, the error code API_VERSION_UNKNOWN and the versions it serves in served_versions.

Example:2026-11-16

Response

Successful Response

branchstring required

The default branch the files are read from

commit_shastring required

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

truncatedboolean required

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

pathstring required

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

filesinteger required

The files under the directory

files_without_scopeinteger required

Of those, the files no scope holds

files_in_all_scopesinteger required

Of those, the files barrier_files matches

entries_omittedinteger required

The entries beyond the ones listed

Changes

    • warning

      added the new PIPELINE_CACHE_STATS_INVALID_TIME_RANGE enum value to the / response property for the response status

    • warning

      added the new PIPELINE_CACHE_STATS_INVALID_TIME_RANGE enum value to the / response property for the response status

    • warning

      added the new PIPELINE_CACHE_STATS_INVALID_TIME_RANGE enum value to the response property for the response status

    15 more changes in this revision