API quick reference¶
The following provides a quick map of the Workload API REST surface, organized by endpoint group.
MLOps deployment API
Model and custom-model deployments (for example /api/v2/deployments/) are not part of the Workload API. Use Workloads and artifacts for governed container runtimes; use the Deployments API reference for classic prediction deployments.
認証¶
All API requests require Bearer token authentication:
Authorization: Bearer YOUR_API_TOKEN
Endpoint groups¶
The Workload API is organized into endpoint groups, each with a specific purpose, with telemetry and access control spanning all of them.
Resource APIs¶
The following describes the top-level base API paths and what those paths cover.
| グループ | Base path | 機能 | REST index |
|---|---|---|---|
| ワークロード | /workloads |
CRUD; start/stop; promotion; runtime settings (rollouts follow Replace and roll out); statistics with reset-by-window; events; replacement history; related entities; nested protons (including per-replica statusDetails). |
Create and read, Operate, Update |
| アーティファクト | /artifacts |
CRUD; draft vs. locked status; image builds (POST/GET /artifacts/{id}/builds); build inspection; POST /artifacts/{id}/clone. |
REST: artifacts and repositories |
| Artifact repositories | /artifactRepositories |
Repository metadata; artifact version history; discovery (see Artifact concepts). | REST: artifacts and repositories |
Telemetry and access¶
The Workload-scoped observability and role APIs span the preceding resource groups.
| 特徴量 | 位置 | リファレンス |
|---|---|---|
| Telemetry | Workload-scoped OpenTelemetry (logs, metrics, traces) | Monitoring concepts |
| Shared roles | sharedRoles under Workloads, artifacts, and artifact repositories |
Sharing and access control (SharingRole, update payload) |