gitlab-foss/doc/api/metadata.md

stage, group, info, title

stage	group	info	title
Deploy	Environments	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	Metadata API

{{< details >}}

• Tier: Free, Premium, Ultimate
• Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduced in GitLab 15.2.
• enterprise introduced in GitLab 15.6.
• kas.externalK8sProxyUrl introduced in GitLab 17.6.

{{< /history >}}

Retrieve metadata information for this GitLab instance.

GET /metadata

Response body attributes:

Attribute	Type	Description
version	string	Version of the GitLab instance.
revision	string	Revision of the GitLab instance.
kas	object	Metadata about the GitLab agent server for Kubernetes (KAS).
kas.enabled	boolean	Indicates whether KAS is enabled.
kas.externalUrl	string or null	URL used by the agents to communicate with KAS. It's null if kas.enabled is false.
kas.externalK8sProxyUrl	string or null	URL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy. It's null if kas.enabled is false.
kas.version	string or null	Version of KAS. It's null if kas.enabled is false or when GitLab instance failed to fetch server info from KAS.
enterprise	boolean	Indicates whether GitLab instance is Enterprise Edition.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/metadata"

Example response:

{
  "version": "18.1.1-ee",
  "revision": "ceb07b24cb0",
  "kas": {
    "enabled": true,
    "externalUrl": "grpc://gitlab.example.com:8150",
    "externalK8sProxyUrl": "https://gitlab.example.com:8150/k8s-proxy",
    "version": "18.1.1"
  },
  "enterprise": true
}