リリースリンク API

GitLab15.1で導入された GitLab CI/CDジョブトークン認証に対応しました。

GitLabReleaseリンクを操作するには、このAPIを使用してください。その他のリリースアセットの操作については、Release APIを参照してください。

GitLabはhttp,https,ftp アセットへのリンクをサポートしています。

リリースリンクのexternal フィールドは GitLab 15.9 で非推奨となり、16.0 で削除されました。

リリースからアセットをリンクとして取得します。

GET /projects/:id/releases/:tag_name/assets/links
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
tag_name文字列です。yesリリースに関連付けられたタグ。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links"

応答例

[
   {
      "id":2,
      "name":"awesome-v0.2.msi",
      "url":"http://192.168.10.15:3000/msi",
      "link_type":"other"
   },
   {
      "id":1,
      "name":"awesome-v0.2.dmg",
      "url":"http://192.168.10.15:3000",
      "link_type":"other"
   }
]

リリースリンクのexternal フィールドは GitLab 15.9 で非推奨となり、16.0 で削除されました。

リリースからアセットをリンクとして取得します。

GET /projects/:id/releases/:tag_name/assets/links/:link_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
tag_name文字列です。yesリリースに関連付けられたタグ。
link_id整数。yesリンクのID。

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"

応答例

{
   "id":1,
   "name":"awesome-v0.2.dmg",
   "url":"http://192.168.10.15:3000",
   "link_type":"other"
}

リリースリンクのexternal フィールドは GitLab 15.9 で非推奨となり、16.0 で削除されました。

リリースからのリンクとしてアセットを作成します。

POST /projects/:id/releases/:tag_name/assets/links
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
tag_name文字列です。yesリリースに関連付けられたタグ。
name文字列です。yesリンクの名前。リンク名はリリース内で一意でなければなりません。
url文字列です。yesリンクのURL。リンクURLはリリース内で一意でなければなりません。
filepath文字列です。いいえ非推奨：代わりにdirect_asset_path を使ってください。
direct_asset_path文字列です。いいえ アセットへの直接リンクのためのオプションのパス。
link_type文字列です。いいえリンクのタイプ：other runbook,image,package.デフォルトはotherです。

リクエストの例

curl --request POST \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --data name="hellodarwin-amd64" \
    --data url="https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64" \
    --data direct_asset_path="/bin/hellodarwin-amd64" \
    "https://gitlab.example.com/api/v4/projects/20/releases/v1.7.0/assets/links"

応答例

{
   "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",
   "link_type":"other"
}

リリースリンクのexternal フィールドは GitLab 15.9 で非推奨となり、16.0 で削除されました。

リリースからのリンクとしてアセットを更新します。

PUT /projects/:id/releases/:tag_name/assets/links/:link_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
tag_name文字列です。yesリリースに関連付けられたタグ。
link_id整数。yesリンクのID。
name文字列です。いいえリンクの名前。
url文字列です。いいえリンクのURL
filepath文字列です。いいえ非推奨：代わりにdirect_asset_path を使ってください。
direct_asset_path文字列です。いいえ アセットへの直接リンクのためのオプションのパス。
link_type文字列です。いいえリンクのタイプ：other runbook,image,package.デフォルトはotherです。
note
name またはurl

リクエストの例

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"

応答例

{
   "id":1,
   "name":"new name",
   "url":"http://192.168.10.15:3000",
   "link_type":"runbook"
}

リリースリンクのexternal フィールドは GitLab 15.9 で非推奨となり、16.0 で削除されました。

アセットをリリースからリンクとして削除します。

DELETE /projects/:id/releases/:tag_name/assets/links/:link_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
tag_name文字列です。yesリリースに関連付けられたタグ。
link_id整数。yesリンクのID。

リクエストの例

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"

応答例

{
   "id":1,
   "name":"new name",
   "url":"http://192.168.10.15:3000",
   "link_type":"other"
}