Skip to main content
PATCH
Update workflow

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string<uuid>
required

A UUID string identifying this workflow.

Body

Write serializer for archiving or unarchiving a workflow.

archived
boolean

Archived workflows do not accept new job submissions.

Response

Serializer for Workflow model.

id
string<uuid>
required
read-only
annotations
object
required
read-only

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

tags
string[]
required
read-only

Tags for the resource. Must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated and sorted.

category
enum<string>
required
  • enrolment - Enrolment
  • burn_in_testing - Burn-in testing
  • customer_release - Customer release
  • in_service_ops - In-service ops
Available options:
enrolment,
burn_in_testing,
customer_release,
in_service_ops
organisation_name
string
required
read-only

Serializer for workflow links.

parameters_presets
object | null
required
read-only

Workflow parameter presets grouped by device type ID, or null if none exist. Each key is a device_type UUID.

eligibility_constraints
object
required

Device-selection constraints derived from a workflow's eligibility policy.

Used by the frontend to validate job submissions before sending them.

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
name
string
required
Maximum string length: 255
version
string
required
Maximum string length: 50
Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
temporal_workflow_name
enum<string>
required
  • EnrollmentWorkflow - Enrollment Workflow
  • SingleNodeBurnInWorkflow - Single Node Burn-In Workflow
  • MultiNodeBurnInPairwiseWorkflow - Multi-Node Burn-In Pairwise Workflow
  • MultiNodeBurnInCollectiveWorkflow - Multi-Node Burn-In Collective Workflow
  • PrepareHardwareTestImagesWorkflow - Prepare Hardware-Test Images Workflow
  • ReportGenerationWorkflow - Report Generation Workflow
  • SlurmAdoptWorkflow - Add to Test Cluster Workflow
  • SlurmReleaseWorkflow - Release from Test Cluster Workflow
  • CustomerReleaseWorkflow - Customer Release Workflow
  • IronicNodeCleanWorkflow - Ironic Node Clean Workflow
  • QuarantineWorkflow - Quarantine Workflow
  • ReleaseWorkflow - Release Workflow
  • UnenrollmentWorkflow - Unenrollment Workflow
  • ConnectivityVerificationWorkflow - Connectivity Verification Workflow
  • FirmwareInventoryWorkflow - Firmware Inventory Workflow
  • FirmwareVerificationWorkflow - Firmware Verification Workflow
  • FirmwarePolicyVerificationWorkflow - Firmware Policy Verification Workflow
  • NVSwitchFirmwarePolicyVerificationWorkflow - NVSwitch Firmware Policy Verification Workflow
  • NodeSwapWorkflow - Node Swap Workflow
  • PowerCycleWorkflow - Power Cycle Workflow
  • PowerOffWorkflow - Power Off Workflow
  • SetMaintenanceModeWorkflow - Set Maintenance Mode Workflow
  • DisableMaintenanceModeWorkflow - Disable Maintenance Mode Workflow
  • ColdResetBmcWorkflow - Cold Reset BMC Workflow
  • SlurmDrainNodeWorkflow - Slurm Drain Node Workflow
  • SlurmResumeNodeWorkflow - Slurm Resume Drained Node Workflow
  • FrontendVrfReturnWorkflow - Frontend VRF Return Workflow
  • FrontendVrfIsolateWorkflow - Frontend VRF Isolate Workflow
  • NvLinkIsolateWorkflow - NVLink Isolate Workflow
  • NvLinkReturnWorkflow - NVLink Return Workflow
  • BackendVrfIsolateWorkflow - Back-end VRF Isolate Workflow
  • BackendVrfReturnWorkflow - Back-end VRF Return Workflow
  • ImageNodeWorkflow - Image Node Workflow
  • UnimageNodeWorkflow - Unimage Node Workflow
  • NodeDiagnosticsWorkflow - Node Diagnostics Workflow
Available options:
EnrollmentWorkflow,
SingleNodeBurnInWorkflow,
MultiNodeBurnInPairwiseWorkflow,
MultiNodeBurnInCollectiveWorkflow,
PrepareHardwareTestImagesWorkflow,
ReportGenerationWorkflow,
SlurmAdoptWorkflow,
SlurmReleaseWorkflow,
CustomerReleaseWorkflow,
IronicNodeCleanWorkflow,
QuarantineWorkflow,
ReleaseWorkflow,
UnenrollmentWorkflow,
ConnectivityVerificationWorkflow,
FirmwareInventoryWorkflow,
FirmwareVerificationWorkflow,
FirmwarePolicyVerificationWorkflow,
NVSwitchFirmwarePolicyVerificationWorkflow,
NodeSwapWorkflow,
PowerCycleWorkflow,
PowerOffWorkflow,
SetMaintenanceModeWorkflow,
DisableMaintenanceModeWorkflow,
ColdResetBmcWorkflow,
SlurmDrainNodeWorkflow,
SlurmResumeNodeWorkflow,
FrontendVrfReturnWorkflow,
FrontendVrfIsolateWorkflow,
NvLinkIsolateWorkflow,
NvLinkReturnWorkflow,
BackendVrfIsolateWorkflow,
BackendVrfReturnWorkflow,
ImageNodeWorkflow,
UnimageNodeWorkflow,
NodeDiagnosticsWorkflow
organisation
string<uuid>
required
description
string
parameters_schema
any
exclusive
boolean

Requires exclusive access to the device while running.

archived
boolean

Archived workflows do not accept new job submissions.