Skip to content

REST: Artifacts and repositories

Use these paths together with API reference authentication and models. 完全なスキーマおよびパラメーターのリファレンスについては、Workload APIリファレンスを参照してください。

アーティファクト

These endpoints create, read, update, clone, and delete artifacts.

Verb パス 説明
GET /artifacts List artifacts. Filter by type, status, repositoryId, tagKeys, tagValues, createdBy, search, ids. Sort with orderBy (name, createdAt, updatedAt, status; prefix - for descending).
POST /artifacts Create a new artifact in draft status. Set artifactRepositoryId in the body to add it to a repository (the platform creates the repository automatically if it does not exist).
GET /artifacts/{artifact_id} Get a single artifact.
PUT /artifacts/{artifact_id} Replace all artifact fields.
PATCH /artifacts/{artifact_id} Partial update. Use to lock the artifact: {"status": "locked"}.
DELETE /artifacts/{artifact_id} Delete an artifact. Returns 409 if the artifact is locked or in use by a Workload.
POST /artifacts/{artifact_id}/clone 既存のアーティファクトのクローンを新しいドラフトとして作成します。 本文:{"name": "new-artifact-name"}

イメージビルド

これらのエンドポイントは、あらかじめ構築済みのimageUriの代わりにimageBuildConfigを使用するアーティファクトのコンテナイメージビルドを管理します。

Verb パス 説明
POST /artifacts/{artifact_id}/builds イメージビルドをトリガーします。 buildIdsを含むImageBuildTriggerResponseとともに202を返します。
GET /artifacts/{artifact_id}/builds アーティファクトのイメージビルドを一覧表示します。
GET /artifacts/{artifact_id}/builds/{build_id} 特定のビルドのステータスと詳細を取得します。
GET /artifacts/{artifact_id}/builds/{build_id}/logs ビルドログ(プレーンテキスト)をストリーミングします。
DELETE /artifacts/{artifact_id}/builds/{build_id} ビルドをキャンセルまたは削除します。

Artifact sharing

These endpoints list and replace the roles granted on an individual artifact.

Verb パス 説明
GET /artifacts/{artifact_id}/sharedRoles List roles granted on an artifact.
PATCH /artifacts/{artifact_id}/sharedRoles Replace the artifact role list (up to 100 entries).

Artifact repositories

These endpoints manage repositories that group artifact versions and govern shared access.

Verb パス 説明
GET /artifactRepositories List repositories.
GET /artifactRepositories/{artifact_repository_id} Get a repository.
DELETE /artifactRepositories/{artifact_repository_id} Delete a repository. Cascades to non-locked, unused artifacts; returns 409 otherwise.
GET /artifactRepositories/{artifact_repository_id}/sharedRoles List repository roles.
PATCH /artifactRepositories/{artifact_repository_id}/sharedRoles Replace the repository role list.

The platform creates a repository automatically the first time you create an artifact with artifactRepositoryId set.