Back to Gitlabhq

Geo API

doc/development/geo/api.md

18.11.21.3 KB
Original Source

{{< 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 >}}

{{< /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:

AttributeTypeRequiredDescription
gl_repositorystringYesThe gl_repository ID of the repository to query

If successful, returns 200 and the following response attributes:

AttributeTypeDescription
attribute'array'An array of ids matching refs/pipeline/X created for running pipelines.