diff options
Diffstat (limited to 'doc/development/geo/api.md')
| -rw-r--r-- | doc/development/geo/api.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/development/geo/api.md b/doc/development/geo/api.md new file mode 100644 index 00000000000..b9f3f7ce5c9 --- /dev/null +++ b/doc/development/geo/api.md @@ -0,0 +1,32 @@ +--- +stage: Systems +group: Geo +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Geo API **(PREMIUM SELF)** + +The Geo API is used internally by GitLab components to assist in coordinating Geo actions. It is inaccessible to admins or users. + +## Fetch pipeline refs + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415179) in GitLab 16.7. + +This method returns a list of branches matching `pipeline/refs/X` that exist on the repository for `gl_repository` on the current Geo node. This endpoint is used by runners registered with a secondary Geo instance to check if a repository is up to date. + +```plaintext +GET /geo/repositories/:gl_repository/pipeline_refs +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +|--------------------------|----------|----------|-----------------------| +| `gl_repository` | string | Yes | The `gl_repository` ID of the repository to query | + +If successful, returns [`200`](../../api/rest/index.md#status-codes) and the following +response attributes: + +| Attribute | Type | Description | +|--------------------------|----------|-----------------------| +| `attribute` | 'array' | An array of ids matching `refs/pipeline/X` created for running pipelines. | |