mirror of
https://gitlab.com/gitlab-org/gitlab-foss.git
synced 2025-07-29 12:00:32 +00:00
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
---
|
|
stage: Tenant Scale
|
|
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
|
|
title: Geo API
|
|
---
|
|
|
|
{{< details >}}
|
|
|
|
- Tier: Premium, Ultimate
|
|
- Offering: GitLab Self-Managed
|
|
- Status: Beta
|
|
|
|
{{< /details >}}
|
|
|
|
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
|
|
|
|
{{< history >}}
|
|
|
|
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/415179) in GitLab 16.7.
|
|
|
|
{{< /history >}}
|
|
|
|
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/troubleshooting.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. |
|