Skip to content

REST: Create and read Workloads

The following endpoints create and read Workloads.

Verb パス 説明
POST /workloads Create a Workload from an existing artifact (artifactId) or an inline artifact spec. Returns WorkloadFormatted.
GET /workloads List Workloads. Filter by status, artifactStatus, importance, artifactId, repositoryId, type, tagKeys, tagValues, createdBy, search, ids. Sort with orderBy (name, createdAt, updatedAt, status, importance, prefix - for descending). Set serviceStats=true to include recent service statistics inline.
GET /workloads/{workload_id} Get a single Workload.

See REST: operate Workloads for day-2 operations (start, stop, delete, settings, sharing, stats, events, protons) and REST: update Workloads for change events (promote, replacement history).