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	Array of action string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
ApplyLabelsToActions			Replace action labels
actionIds	array	Optional	Array of action string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
RemoveLabelsFromActions			Remove labels from actions
actionIds	array	Optional	Array of action string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
CreateLabel			Create label
name	string	Optional	Label key name.
value	string	Optional	Label value.
resource	boolean	Optional	Set to true to create a resource label.
isDefault	boolean	Optional	Set to true to automatically apply this label to new resources.
UpdateLabel			Update label
name	string	Optional	Updated label key name.
value	string	Optional	Updated label value.
isDefault	boolean	Optional	If true, automatically applies this label to new resources in the same scope.
AddLabelsToPipelines			Add labels to pipelines
pipelineIds	array	Optional	Array of pipeline numeric identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
ApplyLabelsToPipelines			Replace pipeline labels
pipelineIds	array	Optional	Array of pipeline numeric identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
RemoveLabelsFromPipelines			Remove labels from pipelines
pipelineIds	array	Optional	Array of pipeline numeric identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
AddLabelsToWorkflows			Add labels to workflows
workflowIds	array	Optional	Array of workflow string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
ApplyLabelsToWorkflows			Replace workflow labels
workflowIds	array	Optional	Array of workflow string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
RemoveLabelsFromWorkflows			Remove labels from workflows
workflowIds	array	Optional	Array of workflow string identifiers to update.
labelIds	array	Optional	Array of label numeric identifiers to add, apply, or remove.
AddLabelsToDatasets			Add labels to datasets
datasetIds	array	Optional	Array of dataset string identifiers to update.
labelIds	array	Optional	Array of simple label numeric identifiers to add, apply, or remove.
ApplyLabelsToDatasets			Replace dataset labels
datasetIds	array	Optional	Array of dataset string identifiers to update.
labelIds	array	Optional	Array of simple label numeric identifiers to add, apply, or remove.
RemoveLabelsFromDatasets			Remove labels from datasets
datasetIds	array	Optional	Array of dataset string identifiers to update.
labelIds	array	Optional	Array of simple label numeric identifiers to add, apply, or remove.