Labels

Labels endpoints in the Seqera Platform API are used to manage both labels and resource labels.

Labels are workspace-specific free-text annotations that can be applied to pipelines, actions, or workflow runs, either during or after creation. Use labels to organize your work and filter key information.

Resource labels provide a flexible tagging system for annotation and tracking of the cloud services consumed by a run. Resource labels are sent to the service provider for each cloud compute environment in key=value format.

Path and query parameters

Name	Type	Location	Req/Opt	Description
workspaceId	integer	query	Optional	Workspace numeric identifier
max	integer	query	Optional	Pagination max results
offset	integer	query	Optional	Pagination offset
search	string	query	Optional	Filter search parameter
type	unknown	query	Optional	Label type
isDefault	boolean	query	Optional	Label default flag
labelId	integer	path	Required	Label numeric identifier

Request body parameters

Name	Type	Req/Opt	Description
AddLabelsToActions			Add labels to actions
actionIds	array	Optional
labelIds	array	Optional
ApplyLabelsToActions			Replace action labels
actionIds	array	Optional
labelIds	array	Optional
RemoveLabelsFromActions			Remove labels from actions
actionIds	array	Optional
labelIds	array	Optional
CreateLabel			Create label
name	string	Optional
value	string	Optional
resource	boolean	Optional
isDefault	boolean	Optional
UpdateLabel			Update label
name	string	Optional
value	string	Optional
isDefault	boolean	Optional
AddLabelsToPipelines			Add labels to pipelines
pipelineIds	array	Optional
labelIds	array	Optional
ApplyLabelsToPipelines			Replace pipeline labels
pipelineIds	array	Optional
labelIds	array	Optional
RemoveLabelsFromPipelines			Remove labels from pipelines
pipelineIds	array	Optional
labelIds	array	Optional
AddLabelsToWorkflows			Add labels to workflows
workflowIds	array	Optional
labelIds	array	Optional
ApplyLabelsToWorkflows			Replace workflow labels
workflowIds	array	Optional
labelIds	array	Optional
RemoveLabelsFromWorkflows			Remove labels from workflows
workflowIds	array	Optional
labelIds	array	Optional