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:
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": "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
}
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support