Metadata API

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

Retrieve metadata information for this GitLab instance.

GET /metadata

Response body attributes:

AttributeTypeDescription
versionstringVersion of the GitLab instance.
revisionstringRevision of the GitLab instance.
kasobjectMetadata about the GitLab agent server for Kubernetes (KAS).
kas.enabledbooleanIndicates whether KAS is enabled.
kas.externalUrlstring or nullURL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
kas.externalK8sProxyUrlstring or nullURL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy. It’s null if kas.enabled is false.
kas.versionstring or nullVersion of KAS. It’s null if kas.enabled is false or when GitLab instance failed to fetch server info from KAS.
enterprisebooleanIndicates 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": "15.2-pre",
  "revision": "c401a659d0c",
  "kas": {
    "enabled": true,
    "externalUrl": "grpc://gitlab.example.com:8150",
    "externalK8sProxyUrl": "https://gitlab.example.com:8150/k8s-proxy",
    "version": "15.0.0"
  },
  "enterprise": true
}