debian-mirror-gitlab/doc/api/metadata.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2 KiB
Markdown
Raw Normal View History

2022-08-13 15:12:31 +05:30
---
2023-06-20 00:43:36 +05:30
stage: Deploy
group: Environments
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2022-08-13 15:12:31 +05:30
---
# Metadata API **(FREE)**
2023-03-17 16:20:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/357032) in GitLab 15.2.
> - `enterprise` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103969) in GitLab 15.6.
2022-08-13 15:12:31 +05:30
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`. |
2023-01-13 00:05:48 +05:30
| `enterprise` | boolean | Indicates whether GitLab instance is Enterprise Edition. |
2022-08-13 15:12:31 +05:30
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"
2023-01-13 00:05:48 +05:30
},
"enterprise": true
2022-08-13 15:12:31 +05:30
}
```