debian-mirror-gitlab/doc/api/metadata.md
2022-08-13 15:12:31 +05:30

46 lines
1.8 KiB
Markdown

---
stage: Ecosystem
group: Integrations
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
# Metadata API **(FREE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357032) in GitLab 15.2.
Retrieve metadata information for this GitLab instance.
```plaintext
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.version` | string or null | Version of KAS. It's `null` if `kas.enabled` is `false`. |
Example request:
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/metadata"
```
Example response:
```json
{
"version": "15.2-pre",
"revision": "c401a659d0c",
"kas": {
"enabled": true,
"externalUrl": "grpc://gitlab.example.com:8150",
"version": "15.0.0"
}
}
```