debian-mirror-gitlab/doc/api/releases/links.md

199 lines
6.8 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Release
2021-02-22 17:27:13 +05:30
group: Release
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
2020-06-23 00:09:42 +05:30
---
2019-02-15 15:39:39 +05:30
# Release links API
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) in GitLab 11.7.
2019-02-15 15:39:39 +05:30
2021-02-22 17:27:13 +05:30
Using this API you can manipulate GitLab [Release](../../user/project/releases/index.md) links. For manipulating other Release assets, see [Release API](index.md).
2020-04-22 19:07:51 +05:30
GitLab supports links to `http`, `https`, and `ftp` assets.
2019-02-15 15:39:39 +05:30
## Get links
Get assets as links from a Release.
2020-04-08 14:13:33 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
GET /projects/:id/releases/:tag_name/assets/links
```
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | --------------------------------------- |
2019-07-07 11:18:12 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). |
2019-02-15 15:39:39 +05:30
| `tag_name` | string | yes | The tag associated with the Release. |
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-03-08 18:12:59 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
[
{
"id":2,
"name":"awesome-v0.2.msi",
"url":"http://192.168.10.15:3000/msi",
2020-06-23 00:09:42 +05:30
"external":true,
"link_type":"other"
2019-02-15 15:39:39 +05:30
},
{
"id":1,
"name":"awesome-v0.2.dmg",
"url":"http://192.168.10.15:3000",
2020-06-23 00:09:42 +05:30
"external":true,
"link_type":"other"
2019-02-15 15:39:39 +05:30
}
]
```
## Get a link
Get an asset as a link from a Release.
2020-04-08 14:13:33 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
GET /projects/:id/releases/:tag_name/assets/links/:link_id
```
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | --------------------------------------- |
2019-07-07 11:18:12 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). |
2019-02-15 15:39:39 +05:30
| `tag_name` | string | yes | The tag associated with the Release. |
2020-05-24 23:13:21 +05:30
| `link_id` | integer | yes | The ID of the link. |
2019-02-15 15:39:39 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-03-08 18:12:59 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
{
"id":1,
"name":"awesome-v0.2.dmg",
"url":"http://192.168.10.15:3000",
2020-06-23 00:09:42 +05:30
"external":true,
"link_type":"other"
2019-02-15 15:39:39 +05:30
}
```
## Create a link
Create an asset as a link from a Release.
2020-04-08 14:13:33 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
POST /projects/:id/releases/:tag_name/assets/links
```
2021-02-22 17:27:13 +05:30
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). |
| `tag_name` | string | yes | The tag associated with the Release. |
| `name` | string | yes | The name of the link. Link names must be unique within the release. |
| `url` | string | yes | The URL of the link. Link URLs must be unique within the release. |
| `filepath` | string | no | Optional path for a [Direct Asset link](../../user/project/releases/index.md#permanent-links-to-release-assets). |
| `link_type` | string | no | The type of the link: `other`, `runbook`, `image`, `package`. Defaults to `other`. |
2019-02-15 15:39:39 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST \
2021-03-08 18:12:59 +05:30
--header "PRIVATE-TOKEN: <your_access_token>" \
2021-01-29 00:20:46 +05:30
--data name="hellodarwin-amd64" \
--data url="https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64" \
--data filepath="/bin/hellodarwin-amd64" \
"https://gitlab.example.com/api/v4/projects/20/releases/v1.7.0/assets/links"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
{
2021-01-29 00:20:46 +05:30
"id":2,
"name":"hellodarwin-amd64",
"url":"https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64",
"direct_asset_url":"https://gitlab.example.com/mynamespace/hello/-/releases/v1.7.0/downloads/bin/hellodarwin-amd64",
"external":false,
2020-06-23 00:09:42 +05:30
"link_type":"other"
2019-02-15 15:39:39 +05:30
}
```
## Update a link
Update an asset as a link from a Release.
2020-04-08 14:13:33 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
PUT /projects/:id/releases/:tag_name/assets/links/:link_id
```
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | --------------------------------------- |
2019-07-07 11:18:12 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). |
2019-02-15 15:39:39 +05:30
| `tag_name` | string | yes | The tag associated with the Release. |
2020-06-23 00:09:42 +05:30
| `link_id` | integer | yes | The ID of the link. |
2019-02-15 15:39:39 +05:30
| `name` | string | no | The name of the link. |
2020-06-23 00:09:42 +05:30
| `url` | string | no | The URL of the link. |
2021-01-29 00:20:46 +05:30
| `filepath` | string | no | Optional path for a [Direct Asset link](../../user/project/releases/index.md#permanent-links-to-release-assets).
2020-06-23 00:09:42 +05:30
| `link_type` | string | no | The type of the link: `other`, `runbook`, `image`, `package`. Defaults to `other`. |
2019-02-15 15:39:39 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2019-02-15 15:39:39 +05:30
You have to specify at least one of `name` or `url`
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request PUT --data name="new name" --data link_type="runbook" \
--header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
{
"id":1,
"name":"new name",
"url":"http://192.168.10.15:3000",
2020-06-23 00:09:42 +05:30
"external":true,
"link_type":"runbook"
2019-02-15 15:39:39 +05:30
}
```
## Delete a link
Delete an asset as a link from a Release.
2020-04-08 14:13:33 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
DELETE /projects/:id/releases/:tag_name/assets/links/:link_id
```
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | --------------------------------------- |
2019-07-07 11:18:12 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding). |
2019-02-15 15:39:39 +05:30
| `tag_name` | string | yes | The tag associated with the Release. |
2020-05-24 23:13:21 +05:30
| `link_id` | integer | yes | The ID of the link. |
2019-02-15 15:39:39 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-03-08 18:12:59 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
{
"id":1,
"name":"new name",
"url":"http://192.168.10.15:3000",
2020-06-23 00:09:42 +05:30
"external":true,
"link_type":"other"
2019-02-15 15:39:39 +05:30
}
```