パッケージ API

GitLab 15.3のプロジェクトレベルAPIでGitLab CI/CDジョブトークン認証のサポートを導入しました。

GitLab PackagesのAPIドキュメントです。

パッケージの一覧

プロジェクト内

プロジェクトパッケージの一覧を取得します。すべての種類のパッケージが結果に含まれます。認証なしでアクセスした場合は、公開プロジェクトのパッケージのみが返されます。デフォルトでは、default とerror のステータスのパッケージが返されます。その他のパッケージを表示するには、status パラメータを使用します。

GET /projects/:id/packages
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
order_by文字列です。いいえ順序として使用するフィールド。created_at （デフォルト）、name 、version 、type のいずれか。
sort文字列です。いいえ昇順の場合はasc (デフォルト)、降順の場合はdesc のどちらか。
package_type文字列です。いいえ返されるパッケージをタイプで絞り込みます。conan,maven,npm,pypi,composer,nuget,helm,terraform_module,golangのいずれか（GitLab 12.9 で導入）。
package_name文字列です。いいえプロジェクトパッケージを名前で絞り込み検索します。(GitLab12.9で導入)
include_versionlessbooleanいいえtrue に設定すると、バージョンレスパッケージがレスポンスに含まれます。(GitLab 13.8 で導入)
status文字列です。いいえステータスによって返されるパッケージをフィルタリングします。default (デフォルト)、hidden 、processing 、error 、pending_destructionのいずれか_(GitLab 13.9 で導入_)。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages"

応答例

[
  {
    "id": 1,
    "name": "com/mycompany/my-app",
    "version": "1.0-SNAPSHOT",
    "package_type": "maven",
    "created_at": "2019-11-27T03:37:38.711Z"
  },
  {
    "id": 2,
    "name": "@foo/bar",
    "version": "1.0.3",
    "package_type": "npm",
    "created_at": "2019-11-27T03:37:38.711Z"
  },
  {
    "id": 3,
    "name": "Hello/0.1@mycompany/stable",
    "conan_package_name": "Hello",
    "version": "0.1",
    "package_type": "conan",
    "_links": {
      "web_path": "/foo/bar/-/packages/3",
      "delete_api_path": "https://gitlab.example.com/api/v4/projects/1/packages/3"
    },
    "created_at": "2029-12-16T20:33:34.316Z",
    "tags": []
  }
]

API はページ分割されているため、デフォルトではGET リクエストは 20 件の結果を返します。

ステータスでパッケージをフィルタできますが、processing ステータスのパッケージを扱うと、不正なデータや壊れたパッケージが生成される可能性があります。

グループ内で

GitLab 12.5で導入されました。

プロジェクトパッケージの一覧をグループレベルで取得します。認証なしでアクセスすると、公開プロジェクトのパッケージのみが返されます。デフォルトでは、default とerror ステータスのパッケージが返されます。その他のパッケージを表示するには、status パラメータを使用します。

GET /groups/:id/packages
属性種類必須説明
id整数/文字列yesグループのIDまたはURLエンコードされたパス。
exclude_subgroupsbooleanfalseこのパラメータに true を指定すると、サブグループのプロジェクトのパッケージは表示されません。デフォルトはfalse です。
order_by文字列です。いいえ順序として使用するフィールド。created_at （デフォルト）、name 、version 、type 、project_pathのいずれか。
sort文字列です。いいえ昇順の場合はasc (デフォルト)、降順の場合はdesc のどちらか。
package_type文字列です。いいえ返されるパッケージをタイプでフィルタリングします。conan,maven,npm,pypi,composer,nuget,helm,golangのいずれか（GitLab 12.9 で導入）。
package_name文字列です。いいえプロジェクトパッケージを名前で絞り込み検索します。(GitLab 13.0で導入)
include_versionlessbooleanいいえtrue に設定すると、バージョンレスパッケージがレスポンスに含まれます。(GitLab 13.8 で導入)
status文字列です。いいえステータスによって返されるパッケージをフィルタリングします。default (デフォルト)、hidden 、processing 、error 、pending_destructionのいずれか_(GitLab 13.9 で導入_)。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=false"

非推奨：

レスポンスのpipeline 属性は廃止され、GitLab 13.6 で導入されたpipelines が使われるようになりました。どちらも13.7まで利用可能です。レスポンスのbuild_info 属性は非推奨となり、GitLab 12.10 で導入されたpipelineが使われるようになりました。

応答例

[
  {
    "id": 1,
    "name": "com/mycompany/my-app",
    "version": "1.0-SNAPSHOT",
    "package_type": "maven",
    "_links": {
      "web_path": "/namespace1/project1/-/packages/1",
      "delete_api_path": "/namespace1/project1/-/packages/1"
    },
    "created_at": "2019-11-27T03:37:38.711Z",
    "pipelines": [
      {
        "id": 123,
        "status": "pending",
        "ref": "new-pipeline",
        "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
        "web_url": "https://example.com/foo/bar/pipelines/47",
        "created_at": "2016-08-11T11:28:34.085Z",
        "updated_at": "2016-08-11T11:32:35.169Z",
        "user": {
          "name": "Administrator",
          "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
        }
      }
    ]
  },
  {
    "id": 2,
    "name": "@foo/bar",
    "version": "1.0.3",
    "package_type": "npm",
    "_links": {
      "web_path": "/namespace1/project1/-/packages/1",
      "delete_api_path": "/namespace1/project1/-/packages/1"
    },
    "created_at": "2019-11-27T03:37:38.711Z",
    "pipelines": [
      {
        "id": 123,
        "status": "pending",
        "ref": "new-pipeline",
        "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
        "web_url": "https://example.com/foo/bar/pipelines/47",
        "created_at": "2016-08-11T11:28:34.085Z",
        "updated_at": "2016-08-11T11:32:35.169Z",
        "user": {
          "name": "Administrator",
          "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
        }
      }
    ]
  }
]

API はページ分割されているため、デフォルトではGET リクエストは 20 件の結果を返します。

_links オブジェクトは以下のプロパティを含みます：

  • web_path:GitLab にアクセスしてパッケージの詳細を見ることができるパス。
  • delete_api_path:パッケージを削除するための API パス。リクエストユーザーに権限がある場合のみ利用可能です。

ステータスでパッケージをフィルタできますが、processing ステータスのパッケージを扱うと、不正なデータや壊れたパッケージが生成される可能性があります。

プロジェクトパッケージの取得

プロジェクトパッケージを取得します。ステータスがdefault のパッケージのみが返されます。

GET /projects/:id/packages/:package_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
package_id整数。yesパッケージのID。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"

非推奨：

レスポンスのpipeline 属性は廃止され、GitLab 13.6 で導入されたpipelines が使われるようになりました。どちらも13.7まで利用可能です。レスポンスのbuild_info 属性は非推奨となり、GitLab 12.10 で導入されたpipelineが使われるようになりました。

応答例

{
  "id": 1,
  "name": "com/mycompany/my-app",
  "version": "1.0-SNAPSHOT",
  "package_type": "maven",
  "_links": {
    "web_path": "/namespace1/project1/-/packages/1",
    "delete_api_path": "/namespace1/project1/-/packages/1"
  },
  "created_at": "2019-11-27T03:37:38.711Z",
  "last_downloaded_at": "2022-09-07T07:51:50.504Z"
  "pipelines": [
    {
      "id": 123,
      "status": "pending",
      "ref": "new-pipeline",
      "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
      "web_url": "https://example.com/foo/bar/pipelines/47",
      "created_at": "2016-08-11T11:28:34.085Z",
      "updated_at": "2016-08-11T11:32:35.169Z",
      "user": {
        "name": "Administrator",
        "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
      }
    }
  ],
  "versions": [
    {
      "id":2,
      "version":"2.0-SNAPSHOT",
      "created_at":"2020-04-28T04:42:11.573Z",
      "pipelines": [
        {
          "id": 234,
          "status": "pending",
          "ref": "new-pipeline",
          "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
          "web_url": "https://example.com/foo/bar/pipelines/58",
          "created_at": "2016-08-11T11:28:34.085Z",
          "updated_at": "2016-08-11T11:32:35.169Z",
          "user": {
            "name": "Administrator",
            "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
          }
        }
      ]
    }
  ]
}

_links オブジェクトは以下のプロパティを含みます：

  • web_path:GitLab にアクセスしてパッケージの詳細を見ることができるパス。パッケージのステータスがdefaultの場合のみ利用可能です。
  • delete_api_path:パッケージを削除するための API パス。リクエストユーザーに権限がある場合のみ利用可能です。

パッケージファイル一覧

単一パッケージのパッケージ・ファイルの一覧を取得します。

GET /projects/:id/packages/:package_id/package_files
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
package_id整数。yesパッケージのID。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/4/package_files"

応答例

[
  {
    "id": 25,
    "package_id": 4,
    "created_at": "2018-11-07T15:25:52.199Z",
    "file_name": "my-app-1.5-20181107.152550-1.jar",
    "size": 2421,
    "file_md5": "58e6a45a629910c6ff99145a688971ac",
    "file_sha1": "ebd193463d3915d7e22219f52740056dfd26cbfe",
    "file_sha256": "a903393463d3915d7e22219f52740056dfd26cbfeff321b",
    "pipelines": [
      {
        "id": 123,
        "status": "pending",
        "ref": "new-pipeline",
        "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
        "web_url": "https://example.com/foo/bar/pipelines/47",
        "created_at": "2016-08-11T11:28:34.085Z",
        "updated_at": "2016-08-11T11:32:35.169Z",
        "user": {
          "name": "Administrator",
          "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
        }
      }
    ]
  },
  {
    "id": 26,
    "package_id": 4,
    "created_at": "2018-11-07T15:25:56.776Z",
    "file_name": "my-app-1.5-20181107.152550-1.pom",
    "size": 1122,
    "file_md5": "d90f11d851e17c5513586b4a7e98f1b2",
    "file_sha1": "9608d068fe88aff85781811a42f32d97feb440b5",
    "file_sha256": "2987d068fe88aff85781811a42f32d97feb4f092a399"
  },
  {
    "id": 27,
    "package_id": 4,
    "created_at": "2018-11-07T15:26:00.556Z",
    "file_name": "maven-metadata.xml",
    "size": 767,
    "file_md5": "6dfd0cce1203145a927fef5e3a1c650c",
    "file_sha1": "d25932de56052d320a8ac156f745ece73f6a8cd2",
    "file_sha256": "ac849d002e56052d320a8ac156f745ece73f6a8cd2f3e82"
  }
]

API はページ分割されているため、デフォルトではGET リクエストは 20 件の結果を返します。

パッケージパイプラインの一覧

GitLab 16.1 で導入されました。

一つのパッケージのパイプラインの一覧を取得します。結果はid で降順にソートされます。

結果はページ分割され、1 ページあたり最大 20 件のレコードを返します。

GET /projects/:id/packages/:package_id/pipelines
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
package_id整数。yesパッケージのID。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id/pipelines"

応答例

[
  {
    "id": 1,
    "iid": 1,
    "project_id": 9,
    "sha": "2b6127f6bb6f475c4e81afcc2251e3f941e554f9",
    "ref": "mytag",
    "status": "failed",
    "source": "push",
    "created_at": "2023-02-01T12:19:21.895Z",
    "updated_at": "2023-02-01T14:00:05.922Z",
    "web_url": "http://gdk.test:3001/feature-testing/composer-repository/-/pipelines/1",
    "user": {
      "id": 1,
      "username": "root",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
      "web_url": "http://gdk.test:3001/root"
    }
  },
  {
    "id": 2,
    "iid": 2,
    "project_id": 9,
    "sha": "e564015ac6cb3d8617647802c875b27d392f72a6",
    "ref": "master",
    "status": "canceled",
    "source": "push",
    "created_at": "2023-02-01T12:23:23.694Z",
    "updated_at": "2023-02-01T12:26:28.635Z",
    "web_url": "http://gdk.test:3001/feature-testing/composer-repository/-/pipelines/2",
    "user": {
      "id": 1,
      "username": "root",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
      "web_url": "http://gdk.test:3001/root"
    }
  }
]

プロジェクトパッケージの削除

プロジェクトパッケージを削除します。

DELETE /projects/:id/packages/:package_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
package_id整数。yesパッケージのID。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"

以下のステータスコードを返すことができます：

  • 204 No Contentパッケージの削除に成功した場合は、” を返します。
  • 404 Not Foundパッケージが見つからなかった場合は

リクエスト転送(forward)が有効になっている場合、パッケージを削除すると依存関係の混乱の危険があります。

パッケージファイルの削除

GitLab 13.12 で導入されました。

caution
パッケージファイルを削除すると、パッケージが破損して使用できなくなったり、パッケージマネージャークライアントからプルできなくなったりする可能性があります。パッケージファイルを削除するときは、自分が何をしているのか理解していることを確認してください。

パッケージファイルを削除してください：

DELETE /projects/:id/packages/:package_id/package_files/:package_file_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
package_id整数。yesパッケージのID。
package_file_id整数。yesパッケージファイルのID。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id/package_files/:package_file_id"

以下のステータスコードを返すことができます：

  • 204 No Content:パッケージは正常に削除されました。
  • 403 Forbidden:ユーザーに削除権限がありません。
  • 404 Not Found:パッケージまたはパッケージ・ファイルが見つかりません。