openapi: 3.0.1 info: contact: email: info@seqera.io url: https://seqera.io description: Seqera Platform services API title: Seqera API version: 1.206.0 tags: - name: actions description: Pipeline actions - name: avatars description: Avatars - name: compute-envs description: Compute environments - name: credentials description: Credentials - name: data-links description: Cloud storage directory paths in Data Explorer - name: datasets description: Pipeline input datasets (samplesheets) in CSV or TSV format - name: ga4gh description: GA4GH workflow execution service runs - name: labels description: Labels and resource labels - name: launch description: Workflow launch events - name: nextflow description: Nextflow version catalog and launch policy - name: orgs description: Organizations - name: pipelines description: Pipelines - name: pipeline-secrets description: Pipeline secrets in a user or workspace context - name: platforms description: Computing platforms - name: service-info description: Seqera Platform API service information - name: studios description: Studios and Studio sessions - name: teams description: Teams in an organization context - name: tokens description: API access tokens - name: trace description: Workflow execution traces - name: users description: Users - name: workflows description: Workflow executions - name: workspaces description: Workspaces in an organization context paths: /actions: get: operationId: ListActions summary: List actions description: Lists all available actions in a user context, enriched by `attributes`. Append `?workspaceId` to list actions in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/ActionQueryAttribute' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListActionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions post: operationId: CreateAction summary: Create action description: Creates a new pipeline action. Append `?workspaceId` to associate the action with the given workspace. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Action create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateActionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateActionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions /actions/cron/resolve: post: operationId: ResolveCronExpression summary: Resolve a schedule description to a cron expression parameters: - name: workspaceId in: query schema: type: integer format: int64 nullable: true explode: false requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: ResolveCronExpression 200 response content: application/json: schema: type: object security: - BearerAuth: [] tags: - actions /actions/labels/add: post: operationId: AddLabelsToActions summary: Add labels to actions description: Adds the given list of labels to the given pipeline actions. Existing labels are preserved. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels add request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateActionLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /actions/labels/apply: post: operationId: ApplyLabelsToActions summary: Replace action labels description: Applies the given list of labels to the given pipeline actions. Existing labels are replaced — include labels to be preserved in `labelIds`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels apply request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateActionLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /actions/labels/remove: post: operationId: RemoveLabelsFromActions summary: Remove labels from actions description: Removes the given list of labels from the given pipeline actions. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels remove request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateActionLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /actions/types: get: operationId: ListActionTypes summary: List action event types description: Lists the supported event types that trigger a pipeline action. Append `?workspaceId` to list event types in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListEventTypesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions /actions/validate: get: operationId: ValidateActionName summary: Validate action name description: Confirms the validity of the given action name. Append `?name=`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: name in: query description: Action name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - actions /actions/{actionId}: delete: operationId: DeleteAction summary: Delete action description: Deletes the pipeline action identified by the given `actionId`. parameters: - name: actionId in: path description: Action string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions get: operationId: DescribeAction summary: Describe action description: Retrieves the details of the action identified by the given `actionId`. parameters: - name: actionId in: path description: Action string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/ActionQueryAttribute' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeActionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions put: operationId: UpdateAction summary: Update action description: Updates the details of the action identified by the given `actionId`. The `source` of an existing action cannot be changed. parameters: - name: actionId in: path description: Action string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Action update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateActionRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions /actions/{actionId}/launch: post: operationId: LaunchAction summary: Trigger Tower Launch action description: Triggers the execution of the Tower Launch action identified by the given `actionId`. parameters: - name: actionId in: path description: Action string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Action launch request required: true content: application/json: schema: $ref: '#/components/schemas/LaunchActionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LaunchActionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions /actions/{actionId}/pause: post: operationId: PauseAction summary: Pause or resume action description: Pauses or resumes the pipeline action identified by the given `actionId`. parameters: - name: actionId in: path description: Action string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - actions /admin/audit-logs-v2: get: operationId: ListAuditLogsV2 summary: List audit logs (v2) description: Lists audit logs with token-based pagination, ordered by timestamp (descending). Supports filtering by timestamp range. parameters: - name: attributes in: query description: Additional attribute values to include in the response (`state` for pre/post image payloads). schema: type: array items: $ref: '#/components/schemas/AuditLogV2QueryAttribute' explode: false - name: nextPageToken in: query description: Token for retrieving the next page of results schema: type: string - name: max in: query description: Maximum number of records to return in the page schema: type: integer format: int32 - name: timestampAfterOrEqual in: query description: Filter logs with timestamp on or after this date schema: type: string format: date-time - name: timestampBeforeOrEqual in: query description: Filter logs with timestamp on or before this date schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListAuditLogV2Response' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - admin /admin/audit-logs-v2/export-csv: get: operationId: ExportAuditLogsV2Csv summary: Export audit logs (v2) as CSV description: Exports audit log entries as a CSV file. Supports filtering by timestamp range. Fails if the number of matching logs exceeds a certain maximum. parameters: - name: attributes in: query description: Additional attribute values to include in the response (`state` for pre/post image payloads). schema: type: array items: $ref: '#/components/schemas/AuditLogV2QueryAttribute' explode: false - name: timestampAfterOrEqual in: query description: Filter logs with timestamp on or after this date schema: type: string format: date-time - name: timestampBeforeOrEqual in: query description: Filter logs with timestamp on or before this date schema: type: string format: date-time responses: '200': description: OK content: text/csv: schema: type: string format: binary '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - admin /admin/audit-logs-v2/{auditLogId}: get: operationId: DescribeAuditLogV2 summary: Describe a single audit log (v2) description: Retrieves the pre/post change images associated with a specific audit log V2 record. parameters: - name: auditLogId in: path description: Audit log V2 record ID required: true schema: type: integer format: int64 - name: attributes in: query description: Additional attribute values to include in the response (`state` for pre/post change images). Returns an empty value if omitted. schema: type: array items: $ref: '#/components/schemas/AuditLogV2QueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AuditLogV2ResponseDto' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - admin /agents: get: operationId: ListAgents summary: List agents description: Lists non-deleted agents in a workspace. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: search in: query description: Filter by agent name schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListAgentsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - agents post: operationId: CreateAgent summary: Create agent description: Creates an agent in a workspace. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Agent create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateAgentRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents /agents/launch: post: operationId: LaunchAgent summary: Launch agent description: Launches a background AI agent run parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Agent launch request required: true content: application/json: schema: $ref: '#/components/schemas/LaunchAgentRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LaunchAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - agents /agents/runs: get: operationId: ListAgentRuns summary: List agent runs description: Lists background agent runs in a workspace, newest first. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: search in: query description: Optional search criteria, allowing the keywords `status` (`pending`, `running`, `completed`, `failed`), `agentConfigId`, `workflowId` and `sourcePipelineId`. Free text is not supported. schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListAgentRunsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - agents /agents/runs/{agentRunId}/status: get: operationId: GetAgentRunStatus summary: Get agent run status description: Retrieves the current status and chat identifiers for a background agent run in a workspace. parameters: - name: agentRunId in: path description: Agent run string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AgentRunStatusResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents /agents/{agentId}: delete: operationId: DeleteAgent summary: Delete agent description: Tombstones an agent in a workspace. parameters: - name: agentId in: path description: Agent string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - agents get: operationId: DescribeAgent summary: Describe agent description: Retrieves an agent in a workspace. parameters: - name: agentId in: path description: Agent string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents put: operationId: UpdateAgent summary: Update agent description: Updates an agent in a workspace. parameters: - name: agentId in: path description: Agent string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Agent update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAgentRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents /agents/{agentId}/disable: post: operationId: DisableAgent summary: Disable agent description: Marks an active agent as inactive. parameters: - name: agentId in: path description: Agent string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents /agents/{agentId}/enable: post: operationId: EnableAgent summary: Enable agent description: Marks an inactive agent as active. parameters: - name: agentId in: path description: Agent string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateAgentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - agents /avatars: post: operationId: CreateAvatar summary: Create the avatar image requestBody: description: Image file request content: multipart/form-data: encoding: image: contentType: application/octet-stream explode: false schema: type: object properties: image: type: string format: binary responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAvatarResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - avatars /avatars/{avatarId}: get: operationId: DownloadAvatar summary: Download the avatar image parameters: - name: avatarId in: path description: Avatar string identifier required: true schema: type: string responses: '200': description: OK content: application/octet-stream: schema: type: string format: binary '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found element security: - BearerAuth: [] tags: - avatars /compute-envs: get: operationId: ListComputeEnvs summary: List compute environments description: Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status. parameters: - name: status in: query description: Compute environment status schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`, `resources`). Returns an empty value (ex. `labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/ComputeEnvQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListComputeEnvsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs post: operationId: CreateComputeEnv summary: Create compute environment description: Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Compute environment create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateComputeEnvRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateComputeEnvResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs /compute-envs/validate: get: operationId: ValidateComputeEnvName summary: Validate compute environment name description: Confirms the validity of the given compute environment name in a user context. Append `?name=`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: name in: query description: Compute environment name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - compute-envs /compute-envs/{computeEnvId}: delete: operationId: DeleteComputeEnv summary: Delete compute environment description: Deletes the compute environment identified by the given `computeEnvId`. When `force=true`, bypasses active-job checks and SCMS/forge cleanup; only allowed for environments in ERRORED, INVALID, or DELETING status. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: force in: query description: Force-delete a stuck compute environment, bypassing active-job checks. Only valid for environments in ERRORED, INVALID, or DELETING status. schema: type: boolean responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflicting deletion content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - compute-envs get: operationId: DescribeComputeEnv summary: Describe compute environment description: Retrieves the details of the compute environment identified by the given `computeEnvId`. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/ComputeEnvQueryAttribute' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeComputeEnvResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs put: operationId: UpdateComputeEnv summary: Update compute environment description: Updates the details of the compute environment identified by the given `computeEnvId`. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Compute environment update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateComputeEnvRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - compute-envs /compute-envs/{computeEnvId}/disable: post: operationId: DisableComputeEnv summary: Disable compute environment description: Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch workflows. If the compute environment is primary, it will be automatically unset as primary. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs /compute-envs/{computeEnvId}/enable: post: operationId: EnableComputeEnv summary: Enable compute environment description: Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch workflows. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs /compute-envs/{computeEnvId}/primary: post: operationId: UpdateComputeEnvPrimary summary: Define primary compute environment description: Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - compute-envs /compute-envs/{computeEnvId}/validate: post: operationId: ValidateComputeEnv summary: Validate a compute environment description: Re-runs the pre-flight checks (associated-credential validation and work-directory accessibility) for the compute environment identified by the given `computeEnvId` and persists the outcome to the compute environment and its credential. Intended to recover a compute environment marked `INVALID` after the underlying problem has been fixed. Available only while the pre-flight feature is enabled. parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: force in: query description: When true, skip the credential and work-dir checks and force the compute environment (INVALID only, with an AVAILABLE credential) to AVAILABLE. Rejected with 409 otherwise. required: false schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '200': description: Validation outcome - inspect status and the transientError flag on the response body content: application/json: schema: $ref: '#/components/schemas/ValidateComputeEnvResponse' '400': description: Compute environment is in a status that cannot be validated content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Compute environment not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '405': description: Pre-flight feature is disabled content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Force override rejected because the compute environment or its associated credential is not in a compatible state content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - compute-envs /credentials: get: operationId: ListCredentials summary: List credentials description: Lists all available credentials in a user context. Append `?workspaceId` to list credentials in a workspace context, and `?platformId` to filter credentials by computing platform. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: platformId in: query description: Platform string identifier schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - credentials post: operationId: CreateCredentials summary: Create credentials description: Creates new credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. For AWS credentials with IAM Role ARN, append `?useExternalId=true` to generate a Platform-managed External ID. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: useExternalId in: query description: Generate External ID for AWS credentials (requires IAM Role ARN) schema: type: boolean requestBody: description: Credentials create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateCredentialsRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - credentials /credentials/validate: get: operationId: ValidateCredentialsName summary: Validate credential name description: Validates the given credentials name. Append `?name=`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: name in: query description: Credentials name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - credentials /credentials/{credentialsId}: delete: operationId: DeleteCredentials summary: Delete credentials description: Deletes the credentials identified by the given `credentialsId`. parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: checked in: query description: If set credentials deletion will be blocked by running jobs that depend on them schema: type: boolean responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] tags: - credentials get: operationId: DescribeCredentials summary: Describe credentials description: Retrieves the details of the credentials identified by the given `credentialsId`. parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - credentials put: operationId: UpdateCredentials summary: Update credentials description: Updates the details of the credentials identified by the given `credentialsId`. For AWS credentials with IAM Role ARN, append `?useExternalId=true` to generate a Platform-managed External ID. parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: useExternalId in: query description: Generate External ID for AWS credentials (requires IAM Role ARN) schema: type: boolean requestBody: description: Credentials update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCredentialsRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - credentials /credentials/{credentialsId}/keys: get: operationId: GetEncryptedCredentials summary: Get encrypted credentials description: Retrieves the encrypted keys for the credentials identified by the given `credentialsId`. parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: pairingId in: query description: Encryption key string identifier schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetCredentialsKeysResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - credentials /credentials/{credentialsId}/validate: post: operationId: ValidateCredentials summary: Validate credentials against their cloud provider and report the outcome parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: false schema: type: integer format: int64 - name: force in: query description: When true, skip the probe and force the credential (INVALID only) to AVAILABLE. Rejected with 409 for any other status. required: false schema: type: boolean responses: '200': description: Validation outcome — inspect status and the transientError flag on the response body content: application/json: schema: $ref: '#/components/schemas/ValidateCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Credentials not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Force override rejected — credential is not INVALID content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - credentials /data-links: get: operationId: ListDataLinks summary: List data-links description: | Retrieves all available data-links in a user context. Append `?workspaceId={your-workspace-id}` to retrieve data-links in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials identifier schema: type: string - name: search in: query description: 'Free text search criteria — data-link name and keywords: `region`, `provider`.' schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: visibility in: query description: Filter results by visibility schema: type: string - name: creationSource in: query description: 'Filter results by creation source: `user` for manually created data-links, `cloud` for data-links discovered from credentials' schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinksListResponse' '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/DataLinksListResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, or the API is disabled in the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links post: operationId: CreateCustomDataLink summary: Create data-link description: Creates a new data-link in a user context. Append `?workspaceId=` to create the data-link in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Data-link creation request required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkCreateRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DataLinkDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled in the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/cache/refresh: get: operationId: RefreshDataLinkCache summary: Refresh data-link cache description: Refreshes the data-link cache for the given `workspaceId` or `credentialsId` parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string responses: '200': description: OK '403': description: Operation not allowed security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}: delete: operationId: DeleteCustomDataLink summary: Delete data-link description: Deletes the data-link associated with the given `dataLinkId`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: Success — Data-link deleted '204': description: DeleteCustomDataLink 204 response '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links get: operationId: DescribeDataLink summary: Describe data-link description: Retrieves the details of the data-link associated with the given `dataLinkId`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links put: operationId: UpdateCustomDataLink summary: Update data-link description: Update the data-link associated with the given `dataLinkId`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Data-link update request required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkUpdateRequest' responses: '200': description: Success — Data-link updated content: application/json: schema: $ref: '#/components/schemas/DataLinkDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/browse: get: operationId: ExploreDataLink summary: Explore data-link description: Retrieves the content of the data-link associated with the given `dataLinkId` parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: search in: query description: Prefix search of data-link content schema: type: string - name: nextPageToken in: query description: Token used to fetch the next page of items schema: type: string - name: pageSize in: query description: Number of items to return per page. If ommitted, a default maximum value is returned. schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkContentResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/browse/{path}: get: operationId: ExploreDataLinkWithPath summary: Explore data-link path description: Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: path in: path description: Content path required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: search in: query description: Prefix search of data-link content schema: type: string - name: nextPageToken in: query description: Token used to fetch the next page of items schema: type: string - name: pageSize in: query description: Number of items to return per page. If ommitted, a default maximum value is returned. schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkContentResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/browse-tree: get: operationId: ExploreDataLinkTree summary: Explore a data-link tree description: Provides a list of all files in the provided paths (including files in sub-paths). parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: paths in: query description: List of paths schema: type: array items: type: object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkContentTreeListResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/content: delete: operationId: DeleteDataLinkItem summary: Delete data-link content description: Deletes the content of the data-link associated with the given `dataLinkId`. The data-link itself is preserved. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkDeleteItemRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkDeleteItemResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/download/{filePath}: get: operationId: DownloadDataLink summary: Download data-link file at path description: Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: filePath in: path description: File path to download required: true schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/octet-stream: schema: type: string format: binary '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/generate-download-url: get: operationId: GenerateDownloadUrlDataLink summary: Generate data-link file download URL description: Returns a URL to download files from the data-link associated with the given `dataLinkId`. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: filePath in: query description: File path to download schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: preview in: query description: 'Whether to generate the URL for preview purposes or direct download (default: false)' schema: type: boolean - name: resolveSymlink in: query description: 'When true, treats the file as a Fusion symlink and resolves its target (default: false)' schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkDownloadUrlResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/script/download: get: operationId: GenerateDownloadScript summary: Generate download script description: Creates a script to download files from the data-link associated with the given `dataLinkId`. Append `?dirs` or `?files` to specify a list of files or paths to download within the data-link. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: dirs in: query description: List of paths to directories to download schema: type: array items: type: object - name: files in: query description: List of paths to files to download schema: type: array items: type: object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkDownloadScriptResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/upload: post: operationId: GenerateDataLinkUploadUrl summary: Generate data-link file upload URL description: |- Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: Origin in: header schema: type: string nullable: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkMultiPartUploadRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkMultiPartUploadResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/upload/finish: post: operationId: FinishDataLinkUpload summary: Finish data-link file upload description: Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkFinishMultiPartUploadRequest' responses: '200': description: FinishDataLinkUpload 200 response content: application/json: schema: type: object '202': description: No content '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/upload/finish/{dirPath}: post: operationId: FinishDataLinkUploadWithPath summary: Finish data-link file upload to given path description: Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: dirPath in: path description: Path to the destination directory required: true schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkFinishMultiPartUploadRequest' responses: '200': description: FinishDataLinkUploadWithPath 200 response content: application/json: schema: type: object '202': description: No content '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /data-links/{dataLinkId}/upload/{dirPath}: post: operationId: GenerateDataLinkUploadUrlWithPath summary: Generate data-link file upload URL (to given path) description: |- Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. parameters: - name: dataLinkId in: path description: Data-link string identifier required: true schema: type: string - name: dirPath in: path description: Path to the destination directory required: true schema: type: string - name: credentialsId in: query description: Credentials string identifier schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: Origin in: header schema: type: string nullable: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataLinkMultiPartUploadRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataLinkMultiPartUploadResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - data-links /datasets: delete: operationId: DeleteDatasets summary: Delete dataset description: Deletes the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetsRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetsResponse' '204': description: DeleteDatasets 204 response content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets get: operationId: ListDatasetsV2 summary: List datasets description: Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Search query schema: type: string - name: sortBy in: query description: Sort field supports (`name`, `modified`), defaults to `name` schema: type: string - name: sortDir in: query description: Sort direction supports (`asc`, `desc`), defaults to `asc` schema: type: string - name: visibility in: query description: Visibility option supports (`visible`, `hidden`, `all`), defaults to `visible` schema: type: string - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/DatasetQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets post: operationId: CreateDatasetV2 summary: Create dataset description: Creates a new dataset in the user context. Include the dataset file and details in your request body. Append `?workspaceId` to create the dataset in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Dataset create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDatasetResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - datasets /datasets/hide: post: operationId: HideDatasets summary: Hide dataset description: Hide the given `datasetIds` parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Dataset ids to be hidden. required: true content: application/json: schema: $ref: '#/components/schemas/ChangeDatasetVisibilityRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/labels/add: post: operationId: AddLabelsToDatasets summary: Add labels to datasets description: Adds the given list of labels to the given datasets. Existing labels are preserved. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels add request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateDatasetsLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /datasets/labels/apply: post: operationId: ApplyLabelsToDatasets summary: Replace datasets labels description: Applies the given list of labels to the given datasets. Existing labels are replaced - include labels to be preserved in `labelIds`. Only simple labels can be attached to datasets parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels apply request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateDatasetsLabelsRequest' responses: '204': description: OK - No content '400': description: Invalid request, if trying to associate resource labels '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /datasets/labels/remove: post: operationId: RemoveLabelsFromDatasets summary: Remove labels from datasets description: Removes the given list of labels from the given datasets. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels remove request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateDatasetsLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /datasets/preview-url: post: operationId: PreviewDatasetUrl summary: Preview content from a URL description: Fetches a partial content preview from an arbitrary HTTP/HTTPS URL, without creating a dataset. Intended for the dataset form preview after URL validation. parameters: - name: workspaceId in: query schema: type: integer format: int64 nullable: true explode: false requestBody: description: URL preview request required: true content: application/json: schema: $ref: '#/components/schemas/ValidateUrlRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DatasetPreviewResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/show: post: operationId: ShowDatasets summary: Show dataset description: Show the given `datasetIds` parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Dataset ids to be shown. required: true content: application/json: schema: $ref: '#/components/schemas/ChangeDatasetVisibilityRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/validate-url: post: operationId: ValidateDatasetUrl summary: Validate URL for dataset linking description: Validates that a remote dataset URL is accessible and returns a supported CSV/TSV format, without creating a dataset. parameters: - name: workspaceId in: query schema: type: integer format: int64 nullable: true explode: false requestBody: description: URL validation request required: true content: application/json: schema: $ref: '#/components/schemas/ValidateUrlRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ValidateUrlResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/versions: get: operationId: ListLatestDatasetVersionsV2 summary: List latest dataset versions description: Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: mimeType in: query description: Dataset MIME type schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Search query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}: delete: operationId: DeleteDatasetV2 summary: Delete dataset description: Deletes the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets put: operationId: UpdateDatasetV2 summary: Update dataset description: Updates the details of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string requestBody: description: Dataset update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/link: post: operationId: LinkDatasetVersion summary: Link external URL as dataset version description: Creates a new linked DatasetVersion for an existing LINKED dataset by supplying a public HTTP/HTTPS URL. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string requestBody: description: Link version request required: true content: application/json: schema: $ref: '#/components/schemas/LinkVersionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadDatasetVersionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Dataset not found security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/metadata: get: operationId: DescribeDatasetV2 summary: Describe dataset description: Retrieves the metadata of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/DatasetQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeDatasetResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/upload: post: operationId: UploadDatasetV2 summary: Upload new dataset version description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: header in: query description: Uploaded file has header schema: type: boolean requestBody: description: Dataset file request required: true content: multipart/form-data: schema: $ref: '#/components/schemas/MultiRequestFileSchema' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadDatasetVersionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/v/{version}/n/{fileName}: get: operationId: DownloadDatasetV2 summary: Download dataset content description: Downloads the content of the dataset identified by the given `datasetId` and `version`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: version in: path description: Version number to download required: true schema: type: string - name: fileName in: path description: File name for the downloaded dataset content required: true schema: type: string responses: '200': description: OK content: application/octet-stream: schema: type: string format: binary '307': description: Temporary redirect to linked source URL '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/v/{version}/preview: get: operationId: PreviewDatasetVersion summary: Preview linked dataset content description: Fetches a partial preview of the content for a linked dataset version. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: version in: path description: Dataset version number required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DatasetPreviewResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Dataset or version not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/versions: get: operationId: ListDatasetVersionsV2 summary: List all dataset versions description: Lists all versions of the given `datasetId`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: mimeType in: query description: Optional MIME type filter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /datasets/{datasetId}/versions/{version}/disable: post: operationId: DisableDatasetVersion summary: Disable a dataset version description: Disable a dataset version, the dataset version cannot be used for runs, and cannot be enabled again parameters: - name: datasetId in: path description: The dataset string id the version belongs to required: true schema: type: string - name: version in: path description: The version number to disable required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - datasets /ga4gh/wes/v1/runs: get: operationId: Ga4ghRunList summary: 'GA4GH: List runs' description: Uses the GA4GH workflow execution service API to list all run records. parameters: - name: page_size in: query description: Page size schema: type: integer format: int32 - name: page_token in: query description: Page token schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed tags: - ga4gh post: operationId: Ga4ghRunCreate summary: 'GA4GH: Launch run' description: Uses the GA4GH workflow execution service API to launch a new run. Runs are launched in the user workspace context by default. To launch in an organization workspace context, include the `workspaceId` in `workflow_engine_parameters`. Runs are launched with the workspace primary compute environment by default. To launch with a different compute environment, include the `computeEnvId` in `workflow_engine_parameters`. requestBody: description: Run request required: true content: application/json: schema: $ref: '#/components/schemas/RunRequest' multipart/form-data: schema: $ref: '#/components/schemas/RunRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunId' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed tags: - ga4gh /ga4gh/wes/v1/runs/{run_id}: get: operationId: Ga4ghRunDescribe summary: 'GA4GH: Describe run' description: Uses the GA4GH workflow execution service API to retrieve the details of the run assoiated with the given `run_id`. parameters: - name: run_id in: path description: Run string identifier required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunLog' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed '404': description: Run not found content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' tags: - ga4gh /ga4gh/wes/v1/runs/{run_id}/cancel: post: operationId: Ga4ghRunCancel summary: 'GA4GH: Cancel run' description: Uses the GA4GH workflow execution service API to cancel the run associated with the given `run_id`. parameters: - name: run_id in: path description: Run string identifier required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunId' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed '404': description: Run not found content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' tags: - ga4gh /ga4gh/wes/v1/runs/{run_id}/status: get: operationId: Ga4ghRunStatus summary: 'GA4GH: Retrieve run status' description: Uses the GA4GH workflow execution service API to retrieve the status of the run associated with the given `run_id`. parameters: - name: run_id in: path description: Run string identifier required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RunStatus' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed '404': description: Run not found content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' tags: - ga4gh /ga4gh/wes/v1/service-info: get: operationId: Ga4ghServiceInfo summary: GA4GH workflow execution service API info responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WesServiceInfo' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/WesErrorResponse' '403': description: Operation not allowed tags: - ga4gh /identities: get: operationId: ListManagedIdentities summary: List Managed Identities description: List all Managed Identities in an organization. parameters: - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: search in: query description: 'Optional search criteria, allowing free text search on name and keywords: `platform:`' schema: type: string nullable: true - name: max in: query description: Pagination max results schema: type: integer format: int32 nullable: true - name: offset in: query description: Pagination offset schema: type: integer format: int32 nullable: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListManagedIdentitiesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities post: operationId: CreateManagedIdentity summary: Create Managed Identity description: Create a new Managed Identity in an organization. parameters: - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 requestBody: description: Managed Identity create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateManagedIdentityRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateManagedIdentityResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities /identities/{managedIdentityId}: delete: operationId: DeleteManagedIdentity summary: Delete a Managed Identity description: Delete a Managed Identity identified by the given ID. parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: checked in: query description: If deletion of associated Managed Credentials will be blocked by running jobs that depend on them schema: type: boolean nullable: true responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Running jobs block the deletion of this Managed Identity content: application/json: schema: $ref: '#/components/schemas/DeleteManagedCredentialsConflictResponse' security: - BearerAuth: [] tags: - identities get: operationId: DescribeManagedIdentity summary: Describe a Managed Identity description: Describe a Managed Identity in an organization. parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateManagedIdentityResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities put: operationId: UpdateManagedIdentity summary: Update a Managed Identity description: Update a Managed Identity identified by the given ID. parameters: - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 requestBody: description: Managed Identity update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateManagedIdentityRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities /identities/{managedIdentityId}/credentials: get: operationId: ListManagedCredentials summary: List Managed Credentials description: List Managed Credentials belonging to a Managed Identity. parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: userId in: query description: User numeric identifier to filter records by schema: type: integer format: int64 nullable: true - name: search in: query description: 'Optional filtering on Managed Credentials for the given Managed Identity: Allows free text search on `userName` or `firstName + lastName`. Accepts keywords: `is:missing` or `is:added` to filter on credentials status. If not provided (or both provided), all are returned.' schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListManagedCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities post: operationId: CreateManagedCredentials summary: Creates Managed Credentials description: Creates Managed Credentials for the given Managed Identity parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: userId in: query description: User numeric identifier schema: type: integer format: int64 nullable: true requestBody: description: Managed Credentials create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateManagedCredentialsRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateManagedCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities /identities/{managedIdentityId}/credentials/{managedCredentialsId}: delete: operationId: DeleteManagedCredentials summary: Delete a user's Managed Credentials record belonging to a Managed Identity description: Delete Managed Credentials parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: managedCredentialsId in: path description: Managed Credentials numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: checked in: query description: If Managed Credentials deletion will be blocked by running jobs that depend on them schema: type: boolean nullable: true responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Running jobs block the deletion of this Managed Credentials content: application/json: schema: $ref: '#/components/schemas/DeleteManagedCredentialsConflictResponse' security: - BearerAuth: [] tags: - identities put: operationId: UpdateManagedCredentials summary: Updates Managed Credentials description: Update Managed Credentials for the given Managed Identity parameters: - name: managedIdentityId in: path description: Managed Identity numeric identifier required: true schema: type: integer format: int64 - name: managedCredentialsId in: path description: Managed Credentials numeric identifier required: true schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 requestBody: description: Managed Credentials update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateManagedCredentialsRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - identities /labels: get: operationId: ListLabels summary: List labels description: Lists all available labels in a user context. Append `?workspaceId` to list labels in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string - name: type in: query description: Label type schema: $ref: '#/components/schemas/LabelType' - name: isDefault in: query description: Label default flag schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListLabelsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels post: operationId: CreateLabel summary: Create label description: 'Creates a new label or returns an existing label based on name/value. By default the operation works in a user context, append `?workspaceId` to create/retrieve a label in a workspace context. Resource labels include `resource: true` and a `value`.' parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: 'Provide a label `name`. Set `resource: true` for resource labels. Only resource labels have a `value` — if `resource: true`, include a `value`. Else, omit `value` from your request body.' required: true content: application/json: schema: $ref: '#/components/schemas/CreateLabelRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateLabelResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /labels/dynamic/allowed: get: operationId: GetAllowedDynamicLabels responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/AllowedDynamicLabelsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - labels /labels/{labelId}: delete: operationId: DeleteLabel summary: Delete label description: Deletes the label identified by the given `labelId`. parameters: - name: labelId in: path description: Label numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels put: operationId: UpdateLabel summary: Update label description: Updates the label identified by the given `labelId`. parameters: - name: labelId in: path description: Label numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Label update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateLabelRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdateLabelResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /launch/{launchId}: get: operationId: DescribeLaunch summary: Describe Launch record description: Retrieves the details of the launch identified by the given `launchId`. parameters: - name: launchId in: path description: Launch string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeLaunchResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - launch /launch/{launchId}/datasets: get: operationId: ListLaunchDatasetVersions summary: Describe launch datasets description: Retrieves the details of the datasets used in the launch identified by the given `launchId`. parameters: - name: launchId in: path description: Launch string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetVersionsResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - datasets /lineage/resolve: get: operationId: ResolveLineage summary: Resolve a platform identifier to a lineage LID description: Resolves a Nextflow session ID or file path to a lineage LID. Exactly one of sessionId or filePath must be provided. parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: sessionId in: query description: Nextflow session UUID schema: type: string - name: filePath in: query description: Absolute file path schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LineageResolveResponse' '400': description: Bad request — exactly one of sessionId or filePath must be provided '403': description: Operation not allowed '404': description: No lineage found for this identifier security: - BearerAuth: [] tags: - lineage /lineage/search: get: operationId: SearchLineage summary: Search lineage records across a selectable set of accessible workspaces description: |- Cross-workspace lineage search. The `q` DSL uses a simple set of conventions: whitespace = AND, a comma inside a qualifier = OR, and repeating a qualifier = AND. Filter the lineage index by `type:`, `workflow:`, `task:`, `label:`, and/or free-text tokens. Workspace scope is expressed inside the DSL: `workspace:org/name` or the numeric `workspaceId:` alias. Omit both to search every accessible workspace. parameters: - name: q in: query description: Tagged-query DSL string. Scope with `workspace:org/name` (comma = OR, e.g. `workspace:acme/dev,acme/prod`) or the numeric `workspaceId:` alias; omit to search every accessible workspace. schema: type: string - name: pageToken in: query description: Opaque cursor for the page to return. Omit for the first page; otherwise pass the `nextPageToken` from a previous response for the same query. An invalid token is rejected with 400. schema: type: string - name: pageSize in: query description: Page size (capped server-side) schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchResult' '400': description: Invalid query '403': description: The caller does not participate in one of the requested workspaces security: - BearerAuth: [] tags: - lineage /lineage/{lid}: get: operationId: GetLineageRecord summary: Get the full Nextflow lineage record from the object store description: Always reads the record from the lineage object store (golden source). For the slim denormalized projection, use `/lineage/{lid}/summary` instead. parameters: - name: lid in: path description: Lineage LID (URL-encoded) required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LineageRecordResponse' '403': description: Operation not allowed '404': description: Record not found security: - BearerAuth: [] tags: - lineage /lineage/{lid}/downstream: get: operationId: NavigateLineageDownstream summary: Data-flow navigation one hop downstream from a lineage record description: Returns records produced / consumed by `{lid}`. Supports optional `type` filter. WorkflowRun is not a node in data-flow navigation — use /search?q=workflow:{lid} instead. parameters: - name: lid in: path description: Starting lineage LID (URL-encoded) required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: type in: query description: Filter by record type (FileOutput | TaskRun) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchResult' '400': description: Unsupported combination of starting LID type and `type` filter security: - BearerAuth: [] tags: - lineage /lineage/{lid}/summary: get: operationId: GetLineageSummary summary: Get the slim index projection for a lineage record description: Returns a thin projection ({name, path|sessionId|workflowRun, labels}) served directly from the index — no object-store read. 404 when no index row exists for the LID. parameters: - name: lid in: path description: Lineage LID (URL-encoded) required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LineageRecordResponse' '404': description: No index row exists for this LID security: - BearerAuth: [] tags: - lineage /lineage/{lid}/upstream: get: operationId: NavigateLineageUpstream summary: Data-flow navigation one hop upstream from a lineage record description: Returns records that produce / feed into `{lid}`. Supports optional `type` filter. WorkflowRun is not a node in data-flow navigation — use /search?q=workflow:{lid} instead. parameters: - name: lid in: path description: Starting lineage LID (URL-encoded) required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: type in: query description: Filter by record type (FileOutput | TaskRun) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SearchResult' '400': description: Unsupported combination of starting LID type and `type` filter security: - BearerAuth: [] tags: - lineage /orgs: get: operationId: ListOrganizations summary: List organizations description: Lists all available organizations in a user context. parameters: - name: role in: query description: Organization user role identifier schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListOrganizationsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs post: operationId: CreateOrganization summary: Create organization description: Creates a new organization. requestBody: description: Organization create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/validate: get: operationId: ValidateOrganizationName summary: Validate organization name description: Confirms the validity of the given organization name. Append `?name=`. parameters: - name: name in: query description: Organization name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}: delete: operationId: DeleteOrganization summary: Delete organization description: Deletes the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs get: operationId: DescribeOrganization summary: Describe organization description: Retrieves the details of the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs put: operationId: UpdateOrganization summary: Update organization description: Updates the details of the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 requestBody: description: Organization update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/collaborators: get: operationId: ListOrganizationCollaborators summary: List organization collaborators description: Lists the collaborators of the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListMembersResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/idp-groups: get: operationId: ListOrganizationIdpGroups summary: List IdP groups for an organization description: Returns the IdP group catalog for the organization, including both SCIM-pushed and manually entered groups. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListIdpGroupsResponse' '403': description: Operation not allowed '404': description: Feature not enabled or organization not found security: - BearerAuth: [] tags: - orgs post: operationId: CreateOrganizationIdpGroup summary: Manually add an IdP group to the catalog description: Adds a group entry to the IdP group catalog via manual entry. The admin must enter the exact claim value their IdP sends in the groups claim. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 requestBody: description: IdP group create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateIdpGroupRequest' responses: '200': description: Group entry created content: application/json: schema: $ref: '#/components/schemas/IdpGroupEntry' '400': description: Invalid request (empty group value) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Feature not enabled or organization not found '409': description: Group with same value already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/idp-groups/{groupId}: delete: operationId: DeleteOrganizationIdpGroup summary: Remove an IdP group from the catalog description: Removes a manually-entered group from the catalog. SCIM-managed groups cannot be deleted via this endpoint. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: groupId in: path description: IdP group numeric identifier required: true schema: type: integer format: int64 responses: '204': description: Group entry deleted '403': description: Operation not allowed '404': description: Feature not enabled or group not found '409': description: Cannot delete SCIM-managed group content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/members: get: operationId: ListOrganizationMembers summary: List organization members description: Lists the members of the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListMembersResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/members/add: put: operationId: CreateOrganizationMember summary: Add organization member description: Adds a new member to the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 requestBody: description: Member addition request required: true content: application/json: schema: $ref: '#/components/schemas/AddMemberRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddMemberResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/members/leave: delete: operationId: LeaveOrganization summary: Leave organization description: Removes the requesting user from the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/members/{memberId}: delete: operationId: DeleteOrganizationMember summary: Delete member description: Deletes the member identified by the given `memberId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: memberId in: path description: Organization member numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/members/{memberId}/role: put: operationId: UpdateOrganizationMemberRole summary: Update member role description: Updates the role of the member identified by the given `memberId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: memberId in: path description: Organization member numeric identifier required: true schema: type: integer format: int64 requestBody: description: Member role update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateMemberRoleRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/quotas: get: operationId: DescribeOrganizationQuotas summary: Describe organization quotas description: Retrieves the details of the organization quotas identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: include in: query description: Optional list of quota names to include schema: type: array items: type: object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationQuotasResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/scim/config: get: operationId: DescribeOrganizationScimConfig summary: View SCIM configuration description: Returns the SCIM configuration for the organization, including token metadata, group count, and SSO state. Accessible to all org members (read access). parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeScimConfigResponse' '403': description: Operation not allowed '404': description: Feature not enabled or organization not found security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/scim/token: delete: operationId: RevokeOrganizationScimToken summary: Revoke the active SCIM bearer token description: Revokes the active SCIM bearer token for the organization. Returns 404 if no active token exists. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '204': description: Token revoked '403': description: Operation not allowed '404': description: Feature not enabled, organization not found, or no active token security: - BearerAuth: [] tags: - orgs post: operationId: CreateOrganizationScimToken summary: Generate a SCIM bearer token description: Generates a new SCIM bearer token for the organization. If an active token already exists it is revoked first. The plaintext token is returned only once. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: Token created content: application/json: schema: $ref: '#/components/schemas/CreateScimTokenResponse' '403': description: Operation not allowed '404': description: Feature not enabled or organization not found security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/scim/token/rotate: post: operationId: RotateOrganizationScimToken summary: Rotate the SCIM bearer token description: Revokes the current active token and generates a new one. The new plaintext token is returned only once. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: Token rotated content: application/json: schema: $ref: '#/components/schemas/CreateScimTokenResponse' '403': description: Operation not allowed '404': description: Feature not enabled, organization not found, or no active token to rotate security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/teams: get: operationId: ListOrganizationTeams summary: List organization teams description: Lists all teams in the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListTeamResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams post: operationId: CreateOrganizationTeam summary: Create team description: Creates a new team in the organization identified by the given `orgId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 requestBody: description: Team create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateTeamRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateTeamResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - teams /orgs/{orgId}/teams/validate: get: operationId: ValidateTeamName summary: Validate team name description: Confirms the validity of the given team name. Append `?name=`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: name in: query description: Team name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams /orgs/{orgId}/teams/{teamId}: delete: operationId: DeleteOrganizationTeam summary: Delete team description: Deletes the team identified by the given `teamId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams get: operationId: DescribeOrganizationTeam summary: Describe team description: Retrieves the details of the team identified by the given `teamId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeTeamResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams put: operationId: UpdateOrganizationTeam summary: Update team description: Updates the details of the team identified by the given `teamId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 requestBody: description: Team update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTeamRequest' responses: '200': description: OK '204': description: UpdateOrganizationTeam 204 response '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - teams /orgs/{orgId}/teams/{teamId}/members: get: operationId: ListOrganizationTeamMembers summary: List team members description: Lists the team members associated with the given `teamId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query schema: type: string nullable: true explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListMembersResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams post: operationId: CreateOrganizationTeamMember summary: Create team member description: Adds a new member to the team identified by the given `teamId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 requestBody: description: Team create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateTeamMemberRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddTeamMemberResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams /orgs/{orgId}/teams/{teamId}/members/{memberId}/delete: delete: operationId: DeleteOrganizationTeamMember summary: Delete team member description: Deletes the team member identified by the given `memberId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 - name: memberId in: path description: Member numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - teams /orgs/{orgId}/teams/{teamId}/workspaces: get: operationId: ListWorkspacesByTeam summary: List team workspaces description: Lists all the workspaces of which the given `teamId` is a participant. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Search criteria schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkspacesByTeamResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - teams /orgs/{orgId}/users/{userId}/roles: get: operationId: ListUserRolesInOrganization summary: List all user roles and permissions in an organization description: List all user roles and permissions in an organization; also list the sources of those roles (via team assignment or direct user assignment). parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListUserRolesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Organization or user not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - orgs /orgs/{orgId}/workspaces: get: operationId: ListWorkspaces summary: List organization workspaces description: Lists the organization workspaces in `orgId` to which the requesting user belongs. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkspacesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces post: operationId: CreateWorkspace summary: Create workspace description: Creates a new organization workspace. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 requestBody: description: Workspace create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/validate: get: operationId: ValidateWorkspaceName summary: Validate workspace name description: Confirms the validity of the given workspace name. Append `?name=`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: name in: query description: Workspace name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}: delete: operationId: DeleteWorkspace summary: Delete workspace description: Deletes the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces get: operationId: DescribeWorkspace summary: Describe workspace description: Retrieves the details of the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeWorkspaceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces put: operationId: UpdateWorkspace summary: Update workspace description: Updates the details of the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Workspace update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeWorkspaceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate name content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/participants: delete: operationId: LeaveWorkspaceParticipant summary: Leave workspace description: Removes the requesting user from the given workspace. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces get: operationId: ListWorkspaceParticipants summary: List workspace participants description: Lists the participants of the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListParticipantsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/participants/add: put: operationId: CreateWorkspaceParticipant summary: Create workspace participant description: Adds a new participant to the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Participant addition request required: true content: application/json: schema: $ref: '#/components/schemas/AddParticipantRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddParticipantResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element or collaborator not permitted for organization with active SSO content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}: delete: operationId: DeleteWorkspaceParticipant summary: Delete workspace participant description: Deletes the given participant from the given workspace. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: participantId in: path description: Participant numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/participants/{participantId}/role: put: operationId: UpdateWorkspaceParticipantRole summary: Update participant role description: Updates the role of the given participant in the given workspace. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: participantId in: path description: Participant numeric identifier required: true schema: type: integer format: int64 requestBody: description: Participant role update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateParticipantRoleRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/settings/studios: get: operationId: FindDataStudiosWorkspaceSettings summary: List workspace Studios settings description: Retrieves the Studios settings of the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Workspace update request content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioWorkspaceSettingsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces put: operationId: UpdateDataStudiosWorkspaceSettings summary: Update workspace Studios settings description: Updates the Studios settings of the workspace identified by the given `workspaceId`. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Workspace update request required: true content: application/json: schema: $ref: '#/components/schemas/DataStudioWorkspaceSettingsRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workspaces /orgs/{orgId}/workspaces/{workspaceId}/users/{userId}: delete: operationId: DeleteWorkspaceUser summary: Delete workspace user description: Deletes the given user (member or collaborator) from the given workspace. parameters: - name: orgId in: path description: Organization numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces /pipeline-schemas: post: operationId: CreatePipelineSchema summary: Create pipeline schema description: Creates a new pipeline schema in a user context. Append `?workspaceId` to create the schema in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Pipeline schema creation request required: true content: application/json: schema: $ref: '#/components/schemas/CreatePipelineSchemaRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreatePipelineSchemaResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-schemas /pipeline-secrets: get: operationId: ListPipelineSecrets summary: List pipeline secrets description: Lists all available pipeline secrets in a user context. Append `?workspaceId` to list secrets in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListPipelineSecretsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-secrets post: operationId: CreatePipelineSecret summary: Create pipeline secret description: Creates a new pipeline secret in the user context. Append `?workspaceId` to create the secret in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Pipeline secret create request required: true content: application/json: schema: $ref: '#/components/schemas/CreatePipelineSecretRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreatePipelineSecretResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-secrets /pipeline-secrets/validate: get: operationId: ValidatePipelineSecretName summary: Validate secret name description: Confirms the validity of the given pipeline secret name in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: name in: query description: Secret name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipeline-secrets /pipeline-secrets/{secretId}: delete: operationId: DeletePipelineSecret summary: Delete secret description: Deletes the pipeline secret identified by the given `secretId`. parameters: - name: secretId in: path description: Secret numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-secrets get: operationId: DescribePipelineSecret summary: Describe pipeline secret description: Retrieves the details of the pipeline secret identified by the given `secretId`. parameters: - name: secretId in: path description: Secret numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribePipelineSecretResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-secrets put: operationId: UpdatePipelineSecret summary: Update secret description: Updates the pipeline secret identified by the given `secretId`. parameters: - name: secretId in: path description: Secret numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Secret update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineSecretRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-secrets /pipelines: get: operationId: ListPipelines summary: List pipelines description: Lists all available pipelines in a user context, enriched by `attributes`. Append `workspaceId` to list pipelines in a workspace context. parameters: - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted.' schema: type: array items: $ref: '#/components/schemas/PipelineQueryAttribute' explode: false - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: sortBy in: query description: Sort field (`NAME` by default) schema: $ref: '#/components/schemas/PipelineListParams.SortBy' - name: sortDir in: query description: Sort direction (`ASCENDING` by default) schema: $ref: '#/components/schemas/PipelineListParams.SortDir' - name: search in: query description: Filter search parameter schema: type: string - name: visibility in: query description: Filter visibility parameter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListPipelinesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines post: operationId: CreatePipeline summary: Create pipeline description: Creates a new pipeline in a user context. Append `?workspaceId` to create the pipeline in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Pipeline creation request required: true content: application/json: schema: $ref: '#/components/schemas/CreatePipelineRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreatePipelineResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipelines /pipelines/info: get: operationId: DescribePipelineRepository summary: Describe remote pipeline repository description: Retrieves the details of a remote Nextflow pipeline Git repository. Append the repository name or full URL with `?name`. parameters: - name: name in: query description: Pipeline repository name or URL schema: type: string - name: revision in: query description: Pipeline revision schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: mainScript in: query description: Pipeline alternative main.nf schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribePipelineInfoResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines /pipelines/labels/add: post: operationId: AddLabelsToPipelines summary: Add labels to pipelines description: Adds the given list of labels to the given pipelines. Existing labels are preserved. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels add request required: true content: application/json: schema: $ref: '#/components/schemas/AssociatePipelineLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /pipelines/labels/apply: post: operationId: ApplyLabelsToPipelines summary: Replace pipeline labels description: Applies the given list of labels to the given pipelines. Existing labels are replaced — include labels to be preserved in `labelIds`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels apply request required: true content: application/json: schema: $ref: '#/components/schemas/AssociatePipelineLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /pipelines/labels/remove: post: operationId: RemoveLabelsFromPipelines summary: Remove labels from pipelines description: Removes the given list of labels from the given pipelines. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels remove request required: true content: application/json: schema: $ref: '#/components/schemas/AssociatePipelineLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /pipelines/repositories: get: operationId: ListPipelineRepositories summary: List user pipeline repositories description: Lists known Nextflow pipeline Git repositories, extracted from existing runs. Append `?workspaceId` to list repositories in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListPipelineInfoResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines /pipelines/validate: get: operationId: ValidatePipelineName summary: Validate pipeline name description: Confirms the validity of the given pipeline `name` in a user context. Append `?name=`. Append `?workspaceId` to validate the name in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: name in: query description: Pipeline name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipelines /pipelines/{pipelineId}: delete: operationId: DeletePipeline summary: Delete pipeline description: Deletes the pipeline identified by the given `pipelineId`. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines get: operationId: DescribePipeline summary: Describe pipeline description: Retrieves the details of the pipeline identified by the given `pipelineId`, enriched by `attributes`. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted.' schema: type: array items: $ref: '#/components/schemas/PipelineQueryAttribute' explode: false - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: sourceWorkspaceId in: query description: Source workspace numeric identifier required: false schema: type: integer format: int64 nullable: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribePipelineResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines put: operationId: UpdatePipeline summary: Update pipeline (default version) description: |- Updates the details of the pipeline identified by the given `pipelineId`. **Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Pipeline update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipelines /pipelines/{pipelineId}/launch: get: operationId: DescribePipelineLaunch summary: Describe pipeline launch description: Retrieves the launch details of the pipeline identified by the given `pipelineId`. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: sourceWorkspaceId in: query description: Source workspace numeric identifier required: false schema: type: integer format: int64 nullable: true - name: versionId in: query description: Pipeline version identifier required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeLaunchResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines /pipelines/{pipelineId}/schema: get: operationId: DescribePipelineSchema summary: Describe pipeline schema description: "Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`. \ `200 - OK` responses include the pipeline schema. \ `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID. \ " parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: sourceWorkspaceId in: query description: Source workspace numeric identifier required: false schema: type: integer format: int64 nullable: true - name: attributes in: query description: 'Additional attribute values to include in the response: `schema` returns the pipeline schema, `params` returns the pipeline config. Returns all if `attributes` is omitted.' schema: type: array items: $ref: '#/components/schemas/PipelineSchemaAttributes' explode: false - name: versionId in: query description: Pipeline version identifier required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PipelineSchemaResponse' '204': description: Request OK - No schema found for given pipeline ID '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipelines /pipelines/{pipelineId}/versions: get: operationId: ListPipelineVersions summary: List pipeline versions description: Lists all available pipeline versions in a user context. Append `workspaceId` to list pipeline versions in a workspace context. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string - name: isPublished in: query description: Set to true to retrieve published versions, false to fetch draft versions schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListPipelineVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - pipeline-versions /pipelines/{pipelineId}/versions/validate: get: operationId: ValidatePipelineVersionName summary: Validate pipeline version name description: Confirms the validity of the given pipeline version `name` in a user context. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: name in: query description: Pipeline name to validate schema: type: string - name: workspaceId in: query description: Workspace Identifier schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipeline-versions /pipelines/{pipelineId}/versions/{versionId}: post: operationId: UpdatePipelineVersion summary: Update pipeline version description: |- Updates the details of the pipeline version identified by the given `pipelineId` and `versionId`. **Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed. Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included. To append a list of labels to multiple pipelines, use `/pipelines/labels/add`. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: versionId in: path description: Pipeline version string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Pipeline version update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - pipeline-versions /pipelines/{pipelineId}/versions/{versionId}/manage: put: operationId: ManagePipelineVersion summary: Update pipeline version name and default flag description: |- Updates a pipeline version's name and/or marks it as the default version. When setting a version as default, any previously default version is automatically unset. Version names cannot be changed if the version is already referenced by workflow runs. parameters: - name: pipelineId in: path description: Pipeline numeric identifier required: true schema: type: integer format: int64 - name: versionId in: path description: Pipeline Version identifier (Launch ID) required: true schema: type: string - name: workspaceId in: query description: Workspace Identifier schema: type: integer format: int64 requestBody: description: Pipeline Version Manage Request required: true content: application/json: schema: $ref: '#/components/schemas/PipelineVersionManageRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Version not found '409': description: Conflict - unsetting a default pipeline version security: - BearerAuth: [] tags: - pipeline-versions /platform/versions: get: operationId: NextflowVersions summary: Nextflow version catalog description: Returns the system-wide catalog of selectable Nextflow versions and the per-run version-selection policy used by the launch form. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NextflowVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - nextflow /platforms: get: operationId: ListPlatforms summary: List platforms description: Lists all available computing platforms in a user context. Append `?workspaceId` to list platforms in a workspace context. parameters: - name: orgId in: query description: Organization numeric identifier required: false schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListPlatformsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - platforms /platforms/{platformId}: get: operationId: DescribePlatform summary: Describe platform description: Retrieves the details of the computing platform identified by the given `platformId`. parameters: - name: platformId in: path description: Platform string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: sched in: query description: When true, narrow the catalog to Scheduler-compatible instance types (AWS only). schema: type: boolean - name: nvme in: query description: When true, narrow the catalog to NVMe-equipped instance types (AWS only). schema: type: boolean - name: regionId in: query required: true schema: type: string explode: false - name: credentialsId in: query required: true schema: type: string explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribePlatformResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - platforms /platforms/{platformId}/regions: get: operationId: ListPlatformRegions summary: List platform regions description: Lists the available regions for the computing platform identified by the given `platformId`. parameters: - name: platformId in: path description: Platform string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListRegionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - platforms /roles: get: operationId: ListRoles summary: List all roles parameters: - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: name in: query description: Search by name parameter schema: type: string - name: type in: query description: Filter by role type (predefined, custom) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListRolesResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - roles post: operationId: CreateRole summary: Create a role with the given name parameters: - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 requestBody: description: Create role request required: true content: application/json: schema: $ref: '#/components/schemas/CreateRoleRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateRoleResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate role name security: - BearerAuth: [] tags: - roles /roles/permissions: get: operationId: ListRolePermissions summary: List all role permissions available in the system parameters: - name: orgId in: query description: Numeric identifier of the organization required: true schema: type: integer format: int64 - name: name in: query description: Search query for name filtering required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListRolePermissionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found security: - BearerAuth: [] tags: - roles /roles/validate: get: operationId: ValidateRoleName summary: Validate if a role name is available within the organization parameters: - name: name in: query description: The role name schema: type: string - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 responses: '204': description: No content - Role name is valid and available '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Role name already exists security: - BearerAuth: [] tags: - roles /roles/{roleName}: delete: operationId: DeleteRole summary: Delete a role with the given name parameters: - name: roleName in: path description: The role name required: true schema: type: string - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 responses: '204': description: No Content - Role deleted successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Role not found security: - BearerAuth: [] tags: - roles get: operationId: DescribeRole summary: Describe role and its permissions fetching by role name parameters: - name: roleName in: path description: The role name required: true schema: type: string - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeRoleResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Role not found security: - BearerAuth: [] tags: - roles put: operationId: UpdateRole summary: Update a role with the given name parameters: - name: roleName in: path description: The role name required: true schema: type: string - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 requestBody: description: Update role request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRoleRequest' responses: '204': description: No Content - Role updated successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Role not found '409': description: Duplicate role name security: - BearerAuth: [] tags: - roles /service-info: get: operationId: Info summary: General Seqera service features and version. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceInfoResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - service-info /ssh-keys: get: operationId: ListSshKeys summary: List SSH keys description: Retrieves the list of all SSH public keys for the authenticated user. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListSshKeysResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - ssh-keys post: operationId: CreateSshKey summary: Create SSH key description: Creates a new SSH public key with the details in the given request body. requestBody: description: SSH key create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateSshKeyRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSshKeyResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - ssh-keys /ssh-keys/validate/key: get: operationId: ValidateSshKey summary: Validate SSH key description: Confirms the availability of the given key for a SSH key in the user context. parameters: - name: key in: query description: SSH key to validate schema: type: string responses: '204': description: Ok - No content, if the key is valid. '400': description: Bad request, if the key is not valid. '403': description: Operation not allowed. '409': description: Conflict, key duplicated in the given context. security: - BearerAuth: [] tags: - ssh-keys /ssh-keys/validate/name: get: operationId: ValidateSshKeyName summary: Validate SSH key name description: Confirms the availability of the given name for a SSH key in the user context. parameters: - name: name in: query description: SSH key name to validate schema: type: string responses: '204': description: Ok - No content, if the name is valid and available. '400': description: Bad request, if the name is not valid. '403': description: Operation not allowed. '409': description: Conflict, name duplicated in the given context. security: - BearerAuth: [] tags: - ssh-keys /ssh-keys/{keyId}: delete: operationId: DeleteSshKey summary: Delete SSH key description: Deletes the given SSH public key by its ID. parameters: - name: keyId in: path description: SSH key numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - ssh-keys get: operationId: DescribeSshKey summary: Describe SSH key description: Retrieves the details of an SSH public key by its ID. parameters: - name: keyId in: path description: SSH key numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeSshKeyResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: SSH key not found security: - BearerAuth: [] tags: - ssh-keys /studios: get: operationId: ListDataStudios summary: List Studios description: Lists all available Studios in a user context. Append `?workspaceId` to list Studios in a workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: search in: query description: 'Optional search criteria, allowing free text search on name and templateUrl and keywords: `userId`, `computeEnvId` and `status`.' schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: attributes in: query description: 'Optional attribute values to be included in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/DataStudioQueryAttribute' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioListResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the workspace is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios post: operationId: CreateDataStudio summary: Create Studio description: Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter `autoStart=false`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: autoStart in: query description: Optionally disable the Studio's automatic launch when it is created. schema: type: boolean requestBody: description: Create Studio request required: true content: application/json: schema: $ref: '#/components/schemas/DataStudioCreateRequest' responses: '200': description: CreateDataStudio 200 response content: application/json: schema: $ref: '#/components/schemas/DataStudioCreateResponse' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DataStudioCreateResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the workspace or compute environment is not found or when the API is disabled. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict - duplicated name content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/data-links: get: operationId: ListMountedDataLinkIds summary: List mounted data-links description: Lists the IDs of all available data-links mounted in existing Studios. Append `orgId` or `?workspaceId` to list mounted data-links in an organization or workspace context, respectively. parameters: - name: orgId in: query description: Organization numeric identifier schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: status in: query description: Optional Studio status schema: type: string - name: exclude in: query description: Optional Studio session ID to exclude in the request. schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioMountedLinksResponse' '403': description: Operation not allowed. security: - BearerAuth: [] tags: - studios /studios/templates: get: operationId: ListDataStudioTemplates summary: List available Studio templates description: Returns the list of available, configured Studio templates. parameters: - name: workspaceId in: query description: Workspace identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 responses: '200': description: Ok - paginated list of available Studio templates. content: application/json: schema: $ref: '#/components/schemas/DataStudioTemplatesListResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/validate: get: operationId: ValidateDataStudioName summary: Validate Studio name description: Confirms the availability of the given name for a Studio in the user context. Append `?workspaceId=` to validate the name in a workspace context. parameters: - name: workspaceId in: query description: Workspace identifier schema: type: integer format: int64 - name: name in: query description: Studio name to validate schema: type: string responses: '204': description: Ok - No content, if the name is valid and available. '400': description: Bad request, if the name is not valid. '403': description: Operation not allowed. '409': description: Conflict, name duplicated in the given context. security: - BearerAuth: [] tags: - studios /studios/{sessionId}: delete: operationId: DeleteDataStudio summary: Delete Studio description: Deletes the Studio associated with the given Studio session ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios get: operationId: DescribeDataStudio summary: Describe Studio description: Retrieves the details of the Studio session identified by the given `sessionId`. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioDto' '202': description: Accepted, when the Studio is fetching mounted data links in the background. content: application/json: schema: $ref: '#/components/schemas/DataStudioDto' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios put: operationId: UpdateDataStudio summary: Update a Studio description: Updates the given Studio session ID. Can only update non-running Studios. The compute environment can be changed by setting `computeEnvId` to a CE compatible with the Studio's current one; see `GET /studios/{sessionId}/compatible-ce`. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Fields to update on the studio. required: true content: application/json: schema: $ref: '#/components/schemas/DataStudioUpdateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict - duplicated name content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/checkpoints: get: operationId: ListDataStudioCheckpoints summary: List Studio checkpoints description: Retrieves the list of checkpoints for the given Studio session ID, sorted by creation date in descending order. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: search in: query description: 'Optional search criteria, allowing free text search on name and keywords: `status`, `before` and `after` for saved date' schema: type: string - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioListCheckpointsResponse' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/checkpoints/{checkpointId}: get: operationId: GetDataStudioCheckpoint summary: Get Studio checkpoint description: Retrieves the details of the given Studio checkpoint ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: checkpointId in: path description: Numeric identifier of the checkpoint. required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioCheckpointDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios put: operationId: UpdateDataStudioCheckpoint summary: Update Studio checkpoint name description: Updates the name of the given Studio checkpoint ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: checkpointId in: path description: Numeric identifier of the checkpoint. required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DataStudioCheckpointUpdateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioCheckpointDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict, when the checkpoint name conflicts with an existing checkpoint for the same Studio. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/compatible-ce: get: operationId: ListDataStudioCompatibleComputeEnvs summary: List compute environments compatible with a Studio description: Lists the compute environments in the same workspace as the given Studio that are compatible with its compute environment. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`, `resources`). Returns an empty value (ex. `labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/ComputeEnvQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListComputeEnvsResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found, has no compute environment, or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/lifespan: post: operationId: ExtendDataStudioLifespan description: Extends the lifespan of the given Studio session ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioDto' '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/log: get: operationId: GetDataStudioLog summary: Get Studio logs description: Retrieves the process log of the latest session of the given Studio, read from the compute environment's log stream (e.g. CloudWatch). Availability depends on the compute provider and its log retention. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: next in: query description: Pagination cursor pointing at the next log page schema: type: string - name: maxLength in: query description: Maximum number of characters to return schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioLogResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/star: delete: operationId: DeleteDataStudioStar summary: Unstar studio description: Removes the studio identified by the given `sessionId` from your list of starred studios. parameters: - name: sessionId in: path description: Studio session identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '204': description: OK - No content '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios post: operationId: CreateDataStudioStar summary: Star studio description: Adds the studio identified by the given `sessionId` to your list of starred studios. parameters: - name: sessionId in: path description: Studio session identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDataStudioStarResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/start: put: operationId: StartDataStudio summary: Starts a Studio description: Starts the given Studio session ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: An optional overriding configuration for the studio to be started. required: true content: application/json: schema: $ref: '#/components/schemas/DataStudioStartRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioStartResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /studios/{sessionId}/stop: put: operationId: StopDataStudio summary: Stop Studio description: Stops the given Studio session ID. parameters: - name: sessionId in: path description: Studio session numeric identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataStudioStopResponse' '403': description: Operation not allowed. '404': description: NotFound, when the Studio is not found or when the API is disabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - studios /tokens: get: operationId: TokenList summary: List tokens description: Retrieves the list of all available API access tokens. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListAccessTokensResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - tokens post: operationId: CreateToken summary: Create token description: Creates an API access token with the details in the given request body. requestBody: description: Access token create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateAccessTokenRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAccessTokenResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - tokens /tokens/delete-all: delete: operationId: DeleteAllTokens summary: Delete all user tokens description: Deletes all API access tokens in the user context. responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - tokens /tokens/{tokenId}: delete: operationId: DeleteToken summary: Delete token description: Deletes the given API access token ID. parameters: - name: tokenId in: path description: Token numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - tokens /trace/create: post: operationId: CreateTrace summary: Create workflow execution trace description: Creates a new workflow execution trace. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Trace create request required: true content: application/json: schema: $ref: '#/components/schemas/TraceCreateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TraceCreateResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - trace /trace/{workflowId}/begin: put: operationId: UpdateTraceBegin summary: Signal workflow execution start description: Updates the workflow execution trace for the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Trace begin request required: true content: application/json: schema: $ref: '#/components/schemas/TraceBeginRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TraceBeginResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - trace /trace/{workflowId}/complete: put: operationId: UpdateTraceComplete summary: Signal workflow execution completion description: Updates the workflow execution trace for the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Trace complete request required: true content: application/json: schema: $ref: '#/components/schemas/TraceCompleteRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TraceCompleteResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - trace /trace/{workflowId}/heartbeat: put: operationId: UpdateTraceHeartbeat summary: Signal workflow execution heartbeat description: Update the workflow execution trace heartbeat for the given `workflowId` to signal that execution is ongoing. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Trace heartbeat request required: true content: application/json: schema: $ref: '#/components/schemas/TraceHeartbeatRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TraceHeartbeatResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - trace /trace/{workflowId}/progress: put: operationId: UpdateTraceProgress summary: Store workflow task execution metadata description: Store the execution metadata for one or more tasks in the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Trace progress request required: true content: application/json: schema: $ref: '#/components/schemas/TraceProgressRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TraceProgressResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - trace /user/{userId}/workspaces: get: operationId: ListWorkspacesUser summary: List user workspaces and organizations description: Lists the workspaces and organizations to which the user identified by the given `userId` belongs. parameters: - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkspacesAndOrgResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workspaces /user-info: get: operationId: UserInfo summary: Describe current user responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeUserResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - users /users/validate: get: operationId: ValidateUserName summary: Check that the user name is valid parameters: - name: name in: query description: User name to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - users /users/{userId}: delete: operationId: DeleteUser summary: Delete a user entity parameters: - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - users get: operationId: DescribeUser summary: Describe a user entity parameters: - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeUserResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - users post: operationId: UpdateUser summary: Update an user entity parameters: - name: userId in: path description: User numeric identifier required: true schema: type: integer format: int64 requestBody: description: User update request required: true content: application/json: schema: $ref: '#/components/schemas/UpsertUserRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - users /workflow: get: operationId: ListWorkflows summary: List workflows description: Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to list workflow records in a workspace context. parameters: - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/WorkflowQueryAttribute' explode: false - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: search in: query description: Filter search parameter schema: type: string - name: includeTotalSize in: query description: Include total size in the response schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkflowsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/delete: post: operationId: DeleteWorkflowMany summary: Delete workflows description: Deletes the workflow records identified by the given list of `workflowIds`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: force in: query description: Force the deletion even if any workflows are active schema: type: boolean requestBody: description: Delete workflows request required: true content: application/json: schema: $ref: '#/components/schemas/DeleteWorkflowsRequest' responses: '200': description: OK - Return the IDs of workflows that could not be deleted, if any content: application/json: schema: $ref: '#/components/schemas/DeleteWorkflowsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/labels/add: post: operationId: AddLabelsToWorkflows summary: Add labels to workflows description: Adds the given list of labels to the given workflows. Existing labels are preserved. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels add request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateWorkflowLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /workflow/labels/apply: post: operationId: ApplyLabelsToWorkflows summary: Replace workflow labels description: Applies the given list of labels to the given workflows. Existing labels are replaced — include labels to be preserved in `labelIds`. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels apply request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateWorkflowLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /workflow/labels/remove: post: operationId: RemoveLabelsFromWorkflows summary: Remove labels from workflows description: Removes the given list of labels from the given workflows. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: description: Labels remove request required: true content: application/json: schema: $ref: '#/components/schemas/AssociateWorkflowLabelsRequest' responses: '204': description: OK - No content '403': description: Operation not allowed security: - BearerAuth: [] tags: - labels /workflow/launch: post: operationId: CreateWorkflowLaunch summary: Launch workflow description: Submits a workflow execution. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: sourceWorkspaceId in: query description: Source workspace numeric identifier required: false schema: type: integer format: int64 nullable: true requestBody: description: Workflow launch request required: true content: application/json: schema: $ref: '#/components/schemas/SubmitWorkflowLaunchRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubmitWorkflowLaunchResponse' '400': description: Bad request — single-failure launches return `ErrorResponse`; multi-failure launches return `WorkflowLaunchValidationErrorResponse` with a per-blocker `errors[]` array content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/WorkflowLaunchValidationErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/random-name: get: operationId: GenerateRandomWorkflowName summary: Generates a random name responses: '200': description: Generated name content: application/json: schema: $ref: '#/components/schemas/RandomWorkflowNameResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/validate: get: operationId: ValidateWorkflowConstraints summary: Validate run name description: 'Check that the given run name of a workflow has a valid format. When the session ID is given: check that no other workflow in the system exists with the combination of both elements.' parameters: - name: runName in: query description: Workflow run name to validate schema: type: string - name: sessionId in: query description: Workflow session ID to validate schema: type: string responses: '204': description: OK - No content '400': description: Bad request. Invalid run name format content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicated element. Existing run name and session ID combination content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}: delete: operationId: DeleteWorkflow summary: Delete the Workflow entity with the given ID parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: force in: query description: Force the deletion even if the workflow is active schema: type: boolean responses: '204': description: OK - Not content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows get: operationId: DescribeWorkflow summary: Describe workflow description: Retrieves the details of the workflow record associated with the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: attributes in: query description: Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified. schema: type: array items: $ref: '#/components/schemas/WorkflowQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeWorkflowResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows patch: operationId: UpdateWorkflow summary: Apply a partial update to the workflow-extension metadata for the given Workflow ID description: Updates only the workflow-extension store; never a core workflow field. Designed to carry workflow-extension attributes generally so future fields reuse this operation. Returns the updated workflow representation. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeWorkflowResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict — a concurrent update prevented the write; the request may be retried content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/cancel: post: operationId: CancelWorkflow summary: Cancel workflow description: Cancels the workflow execution identified by the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: force in: query description: Cancel on the Platform side even if it cannot be cancelled on the CE provider side schema: type: boolean requestBody: content: application/json: schema: $ref: '#/components/schemas/EmptyBodyRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/download: get: operationId: DownloadWorkflowLog summary: Download workflow files description: Downloads the workflow files for the Nextflow main job associated with the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: fileName in: query description: Filename to download schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: text/plain: schema: type: string format: binary '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/download/{taskId}: get: operationId: DownloadWorkflowTaskLog summary: Download workflow task files description: Downloads the workflow files of the task identified by the given `taskId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: taskId in: path description: Task numeric identifier required: true schema: type: integer format: int64 - name: fileName in: query description: Filename to download schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: text/plain: schema: type: string format: binary '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/launch: get: operationId: DescribeWorkflowLaunch summary: Describe workflow launch description: Retrieves the details of the workflow launch associated with the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeWorkflowLaunchResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element. Existing run name and session ID combination content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/log: get: operationId: GetWorkflowLog summary: Get workflow logs description: Retrieves the output logs for the Nextflow main job of the workflow identified by the given `workflowId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: next in: query description: Workflow log cursor schema: type: string - name: maxLength in: query description: Maximum length in bytes of the log to retrieve schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkflowLogResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/log/{taskId}: get: operationId: GetWorkflowTaskLog summary: Get workflow task logs description: Retrieves the output logs for the workflow task identified by the given `taskId`. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: taskId in: path description: Task numeric identifier required: true schema: type: integer format: int64 - name: next in: query description: Workflow log cursor schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: maxLength in: query description: Maximum length in bytes of the log to retrieve schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkflowLogResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/metrics: get: operationId: DescribeWorkflowMetrics summary: Get the execution metrics for the given Workflow ID parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetWorkflowMetricsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/progress: get: operationId: DescribeWorkflowProgress summary: Retrieve the execution progress for the given Workflow ID parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetProgressResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/star: delete: operationId: DeleteWorkflowStar summary: Unstar workflow description: Removes the workflow identified by the given `workflowId` from your list of starred workflows. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowStarResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - workflows get: operationId: DescribeWorkflowStar summary: Check workflow star status description: Confirms whether the given `workflowId` is starred. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowStarResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - workflows post: operationId: CreateWorkflowStar summary: Star workflow description: Adds the workflow identified by the given `workflowId` to your list of starred workflows. parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowStarResponse' '403': description: Operation not allowed '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Duplicated element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' tags: - workflows /workflow/{workflowId}/task/{taskId}: get: operationId: DescribeWorkflowTask summary: Describe a task entity with the given ID parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: taskId in: path description: Task numeric identifier required: true schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeTaskResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workflow/{workflowId}/tasks: get: operationId: ListWorkflowTasks summary: List the tasks for the given Workflow ID and filter parameters parameters: - name: workflowId in: path description: Workflow string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: max in: query description: Pagination max results schema: type: integer format: int32 - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: sortBy in: query description: Field to sort by schema: type: string - name: sortDir in: query description: Sorting direction (asc|desc) schema: type: string - name: search in: query description: Search tasks by name schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListTasksResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows /workspaces/{workspaceId}/datasets: get: operationId: ListDatasets summary: List available datasets description: Lists all available datasets in the workspace context identified by the given `workspaceId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets post: operationId: CreateDataset summary: Create dataset description: Creates a new dataset in the given workspace context. Include the dataset file and details in your request body. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Dataset create request required: true content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDatasetResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' deprecated: true security: - BearerAuth: [] tags: - datasets /workspaces/{workspaceId}/datasets/versions: get: operationId: ListWorkspaceDatasetVersions summary: List latest dataset versions description: Lists the latest version of each dataset associated with the given `workspaceId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: mimeType in: query schema: type: string nullable: true explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets /workspaces/{workspaceId}/datasets/{datasetId}: delete: operationId: DeleteDataset summary: Delete dataset description: Deletes the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets put: operationId: UpdateDataset summary: Update dataset description: Updates the details of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string requestBody: description: Dataset update request required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' responses: '204': description: OK - No content '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Duplicate element content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' deprecated: true security: - BearerAuth: [] tags: - datasets /workspaces/{workspaceId}/datasets/{datasetId}/metadata: get: operationId: DescribeDataset summary: Describe dataset description: Retrieves the metadata of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: attributes in: query description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.' schema: type: array items: $ref: '#/components/schemas/DatasetQueryAttribute' explode: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DescribeDatasetResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets /workspaces/{workspaceId}/datasets/{datasetId}/upload: post: operationId: UploadDataset summary: Upload new dataset version description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: header in: query description: Uploaded file has header schema: type: boolean requestBody: description: Dataset file request required: true content: multipart/form-data: schema: $ref: '#/components/schemas/MultiRequestFileSchema' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadDatasetVersionResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets /workspaces/{workspaceId}/datasets/{datasetId}/versions: get: operationId: ListDatasetVersions summary: List all dataset versions description: Lists all versions of the given `datasetId`. parameters: - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 - name: datasetId in: path description: Dataset string identifier required: true schema: type: string - name: mimeType in: query description: MIME type filter schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDatasetVersionsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed deprecated: true security: - BearerAuth: [] tags: - datasets components: schemas: AbstractGridConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean userName: type: string workDir: description: Compute environment working directory type: string AccessToken: type: object properties: basicAuth: type: string deprecated: true nullable: true dateCreated: type: string format: date-time id: type: integer format: int64 lastUsed: type: string format: date-time name: type: string maxLength: 50 minLength: 1 required: - name AccessTokenImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' lastUsed: type: string format: date-time name: type: string required: - auditImageType title: Access token audit image Action.ConfigType: type: object properties: discriminator: type: string discriminator: mapping: bucket: '#/components/schemas/BucketActionConfig' cron: '#/components/schemas/CronActionConfig' github: '#/components/schemas/GithubActionConfig' tower: '#/components/schemas/Action.TowerActionConfig' propertyName: discriminator oneOf: - $ref: '#/components/schemas/Action.TowerActionConfig' - $ref: '#/components/schemas/GithubActionConfig' - $ref: '#/components/schemas/BucketActionConfig' - $ref: '#/components/schemas/CronActionConfig' Action.EventType: type: object properties: discriminator: type: string timestamp: type: string format: date-time discriminator: mapping: bucket: '#/components/schemas/BucketActionEvent' cron: '#/components/schemas/CronActionEvent' github: '#/components/schemas/GithubActionEvent' tower: '#/components/schemas/Action.TowerActionEvent' propertyName: discriminator oneOf: - $ref: '#/components/schemas/GithubActionEvent' - $ref: '#/components/schemas/Action.TowerActionEvent' - $ref: '#/components/schemas/BucketActionEvent' - $ref: '#/components/schemas/CronActionEvent' Action.Source: type: string enum: - github - tower - bucket - cron x-enum-varnames: - github - tower - bucket - cron Action.Status: type: string enum: - CREATING - ACTIVE - ERROR - PAUSED Action.TowerActionConfig: type: object properties: discriminator: type: string title: Tower Action Config Action.TowerActionEvent: type: object properties: discriminator: type: string timestamp: type: string format: date-time workflowId: type: string title: Tower action event ActionImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' config: $ref: '#/components/schemas/Action.ConfigType' error: type: string event: $ref: '#/components/schemas/Action.EventType' hookId: type: string hookUrl: type: string lastSeen: type: string format: date-time launch: $ref: '#/components/schemas/LaunchImage' name: type: string source: type: string status: type: string required: - auditImageType title: Action audit image ActionQueryAttribute: type: string enum: - labels x-enum-varnames: - labels ActionResponseDto: type: object properties: config: $ref: '#/components/schemas/Action.ConfigType' dateCreated: type: string format: date-time error: type: string event: $ref: '#/components/schemas/Action.EventType' hookId: type: string hookUrl: type: string id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' lastSeen: type: string format: date-time lastUpdated: type: string format: date-time launch: $ref: '#/components/schemas/LaunchDbDto' name: type: string nextExecution: type: string format: date-time source: $ref: '#/components/schemas/Action.Source' status: $ref: '#/components/schemas/Action.Status' ActiveConnection: type: object allOf: - $ref: '#/components/schemas/UserInfo' - properties: lastActive: type: string format: date-time type: object AddMemberRequest: type: object properties: user: type: string AddMemberResponse: type: object properties: member: $ref: '#/components/schemas/MemberDbDto' AddParticipantRequest: type: object properties: memberId: type: integer format: int64 teamId: type: integer format: int64 userNameOrEmail: type: string AddParticipantResponse: type: object properties: participant: $ref: '#/components/schemas/ParticipantResponseDto' AddTeamMemberResponse: type: object properties: member: $ref: '#/components/schemas/MemberDbDto' Agent.Status: type: string enum: - active - inactive - deleted x-enum-varnames: - active - inactive - deleted AgentDbDto: type: object properties: agentInstructions: type: string agentInstructionsTemplateId: type: string nullable: true createdBy: type: integer format: int64 dateCreated: type: string format: date-time description: type: string nullable: true id: type: string lastUpdated: type: string format: date-time name: type: string status: $ref: '#/components/schemas/Agent.Status' updatedBy: type: integer format: int64 workspaceId: type: integer format: int64 AgentRun.Status: type: string enum: - pending - running - completed - failed x-enum-varnames: - pending - running - completed - failed AgentRun.Trigger: type: object properties: entityId: type: string type: type: string AgentRunDbDto: type: object properties: actorId: type: integer format: int64 nullable: true agentRunName: type: string nullable: true dateCreated: type: string format: date-time id: type: string lastUpdated: type: string format: date-time sessionId: type: string nullable: true sourcePipelineId: type: string nullable: true status: $ref: '#/components/schemas/AgentRun.Status' threadId: type: string nullable: true title: type: string nullable: true trigger: allOf: - $ref: '#/components/schemas/AgentRun.Trigger' nullable: true workflowId: type: string nullable: true workspaceId: type: integer format: int64 AgentRunStatusResponse: type: object properties: agentRunId: type: string sessionId: type: string nullable: true status: type: string threadId: type: string nullable: true AgentSecurityKeys: type: object properties: connectionId: type: string discriminator: type: string shared: type: boolean workDir: type: string title: Tower Agent credentials AllowedDynamicLabelsResponse: type: object properties: values: type: array items: type: string AltairPbsComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean userName: type: string workDir: description: Compute environment working directory type: string title: Altair PBS configuration Analytics: type: object properties: hubspotId: type: string nullable: true posthogApiHost: type: string nullable: true posthogApiKey: type: string nullable: true AssociateActionLabelsRequest: type: object properties: actionIds: type: array items: type: string labelIds: type: array items: format: int64 type: integer AssociateDatasetsLabelsRequest: type: object properties: datasetIds: type: array items: type: string labelIds: type: array items: format: int64 type: integer AssociatePipelineLabelsRequest: type: object properties: labelIds: type: array items: format: int64 type: integer pipelineIds: type: array items: format: int64 type: integer AssociateWorkflowLabelsRequest: type: object properties: labelIds: type: array items: format: int64 type: integer workflowIds: type: array items: type: string AuditActor.ActorType: type: string enum: - user - system x-enum-varnames: - user - system AuditEventType: type: string enum: - workflow_launched - workflow_created - workflow_updated - workflow_completed - workflow_deleted - workflow_dropped - access_token_created - access_token_deleted - ssh_key_created - ssh_key_deleted - user_created - user_updated - user_deleted - user_sign_in - compute_environment_created - compute_environment_updated - compute_environment_deleted - credentials_created - credentials_updated - credentials_deleted - credentials_dropped - action_created - action_updated - action_deleted - agent_created - agent_updated - agent_enabled - agent_disabled - agent_deleted - organization_created - organization_updated - organization_deleted - organization_sso_created - organization_sso_updated - organization_sso_deleted - team_created - team_updated - team_deleted - workspace_created - workspace_updated - workspace_deleted - pipeline_created - pipeline_updated - pipeline_deleted - participant_created - participant_deleted - participant_role_updated - member_created - member_deleted - member_role_updated - team_member_created - team_member_deleted - pipeline_secret_created - pipeline_secret_updated - pipeline_secret_deleted - dataset_created - dataset_updated - dataset_deleted - dataset_content_uploaded - dataset_content_downloaded - data_link_created - data_link_updated - data_link_deleted - data_link_hide - data_link_show - data_link_file_preview - data_link_file_upload - data_link_file_download - data_link_file_deleted - studio_session_created - studio_session_deleted - studio_session_started - studio_session_stopped - studio_session_updated - studio_session_connected - studio_session_disconnected - studio_session_build_started - studio_session_build_failed - studio_session_build_succeeded - studio_session_lifespan_extended - studio_session_ssh_auth_succeeded - studio_session_ssh_auth_failed - label_created - label_updated - label_deleted - resource_label_created - resource_label_updated - resource_label_deleted - label_assignment_created - label_assignment_deleted - managed_identity_created - managed_identity_edited - managed_identity_deleted - managed_credentials_created - managed_credentials_updated - managed_credentials_deleted - credits_modified - credit_purchase_created - credit_purchase_completed - credit_purchase_failed - credit_purchase_canceled - credit_purchase_expired - user_role_created - user_role_updated - user_role_deleted - role_created - role_updated - role_deleted - oauth_consent_granted - oauth_consent_denied - idp_group_created - idp_group_updated - idp_group_deleted - scim_token_created - scim_token_updated - compute_environment_made_primary - compute_environment_made_non_primary - compute_profile_created - compute_profile_updated - compute_profile_deleted - compute_profile_made_primary - compute_profile_made_non_primary - organization_settings_updated - participant_added - participant_removed - participant_role_update - member_added - member_removed - member_role_update - team_member_added - team_member_removed - data_link_file_delete - data_studio_session_created - data_studio_session_deleted - data_studio_session_started - data_studio_session_stopped - data_studio_session_connected - data_studio_session_disconnected - data_studio_session_build_started - data_studio_session_build_failed - data_studio_session_build_succeeded - data_studio_session_lifespan_extended - data_studio_session_ssh_auth_succeeded - data_studio_session_ssh_auth_failed - role_grant_association_created - role_grant_association_deleted - pipeline_version_created - action_paused - action_unpaused - user_trusted - user_enabled - user_disabled - workflow_status_changed x-deprecated: - compute_environment_made_primary - compute_environment_made_non_primary - compute_profile_created - compute_profile_updated - compute_profile_deleted - compute_profile_made_primary - compute_profile_made_non_primary - organization_settings_updated - participant_added - participant_removed - participant_role_update - member_added - member_removed - member_role_update - team_member_added - team_member_removed - data_link_file_delete - data_studio_session_created - data_studio_session_deleted - data_studio_session_started - data_studio_session_stopped - data_studio_session_connected - data_studio_session_disconnected - data_studio_session_build_started - data_studio_session_build_failed - data_studio_session_build_succeeded - data_studio_session_lifespan_extended - data_studio_session_ssh_auth_succeeded - data_studio_session_ssh_auth_failed - role_grant_association_created - role_grant_association_deleted - pipeline_version_created - action_paused - action_unpaused - user_trusted - user_enabled - user_disabled - workflow_status_changed x-enum-varnames: - workflow_launched - workflow_created - workflow_updated - workflow_completed - workflow_deleted - workflow_dropped - access_token_created - access_token_deleted - ssh_key_created - ssh_key_deleted - user_created - user_updated - user_deleted - user_sign_in - compute_environment_created - compute_environment_updated - compute_environment_deleted - credentials_created - credentials_updated - credentials_deleted - credentials_dropped - action_created - action_updated - action_deleted - agent_created - agent_updated - agent_enabled - agent_disabled - agent_deleted - organization_created - organization_updated - organization_deleted - organization_sso_created - organization_sso_updated - organization_sso_deleted - team_created - team_updated - team_deleted - workspace_created - workspace_updated - workspace_deleted - pipeline_created - pipeline_updated - pipeline_deleted - participant_created - participant_deleted - participant_role_updated - member_created - member_deleted - member_role_updated - team_member_created - team_member_deleted - pipeline_secret_created - pipeline_secret_updated - pipeline_secret_deleted - dataset_created - dataset_updated - dataset_deleted - dataset_content_uploaded - dataset_content_downloaded - data_link_created - data_link_updated - data_link_deleted - data_link_hide - data_link_show - data_link_file_preview - data_link_file_upload - data_link_file_download - data_link_file_deleted - studio_session_created - studio_session_deleted - studio_session_started - studio_session_stopped - studio_session_updated - studio_session_connected - studio_session_disconnected - studio_session_build_started - studio_session_build_failed - studio_session_build_succeeded - studio_session_lifespan_extended - studio_session_ssh_auth_succeeded - studio_session_ssh_auth_failed - label_created - label_updated - label_deleted - resource_label_created - resource_label_updated - resource_label_deleted - label_assignment_created - label_assignment_deleted - managed_identity_created - managed_identity_edited - managed_identity_deleted - managed_credentials_created - managed_credentials_updated - managed_credentials_deleted - credits_modified - credit_purchase_created - credit_purchase_completed - credit_purchase_failed - credit_purchase_canceled - credit_purchase_expired - user_role_created - user_role_updated - user_role_deleted - role_created - role_updated - role_deleted - oauth_consent_granted - oauth_consent_denied - idp_group_created - idp_group_updated - idp_group_deleted - scim_token_created - scim_token_updated - compute_environment_made_primary - compute_environment_made_non_primary - compute_profile_created - compute_profile_updated - compute_profile_deleted - compute_profile_made_primary - compute_profile_made_non_primary - organization_settings_updated - participant_added - participant_removed - participant_role_update - member_added - member_removed - member_role_update - team_member_added - team_member_removed - data_link_file_delete - data_studio_session_created - data_studio_session_deleted - data_studio_session_started - data_studio_session_stopped - data_studio_session_connected - data_studio_session_disconnected - data_studio_session_build_started - data_studio_session_build_failed - data_studio_session_build_succeeded - data_studio_session_lifespan_extended - data_studio_session_ssh_auth_succeeded - data_studio_session_ssh_auth_failed - role_grant_association_created - role_grant_association_deleted - pipeline_version_created - action_paused - action_unpaused - user_trusted - user_enabled - user_disabled - workflow_status_changed AuditImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' AuditImageType: type: string enum: - user - pipeline - compute_env - workspace - team - team_member - organization - label - label_assignment - participant - credentials - custom_role - org_sso_connection - credit_info - credit_purchase - data_studio - data_studio_connection - data_link - data_link_metadata - data_link_file - action - agent - workflow - dataset - dataset_version - managed_credentials - managed_identity - user_role - member - oauth_consent - pipeline_secret - access_token - user_ssh_public_key - idp_group - scim_token x-enum-varnames: - user - pipeline - compute_env - workspace - team - team_member - organization - label - label_assignment - participant - credentials - custom_role - org_sso_connection - credit_info - credit_purchase - data_studio - data_studio_connection - data_link - data_link_metadata - data_link_file - action - agent - workflow - dataset - dataset_version - managed_credentials - managed_identity - user_role - member - oauth_consent - pipeline_secret - access_token - user_ssh_public_key - idp_group - scim_token AuditLogTargetState: type: object properties: metadata: $ref: '#/components/schemas/AuditLogTargetStateMetadata' newState: allOf: - $ref: '#/components/schemas/AuditImage' - discriminator: mapping: access_token: '#/components/schemas/AccessTokenImage' action: '#/components/schemas/ActionImage' compute_env: '#/components/schemas/ComputeEnvImage' credentials: '#/components/schemas/CredentialsImage' credit_info: '#/components/schemas/CreditInfoImage' credit_purchase: '#/components/schemas/CreditPurchaseImage' custom_role: '#/components/schemas/CustomRoleImage' data_link: '#/components/schemas/DataLinkImage' data_link_file: '#/components/schemas/DataLinkFileImage' data_link_metadata: '#/components/schemas/DataLinkMetadataImage' data_studio: '#/components/schemas/DataStudioImage' data_studio_connection: '#/components/schemas/DataStudioConnectionImage' dataset: '#/components/schemas/DatasetImage' dataset_version: '#/components/schemas/DatasetVersionImage' idp_group: '#/components/schemas/IdpGroupImage' label: '#/components/schemas/LabelImage' label_assignment: '#/components/schemas/LabelAssignmentImage' managed_credentials: '#/components/schemas/ManagedCredentialsImage' managed_identity: '#/components/schemas/ManagedIdentityImage' member: '#/components/schemas/MemberImage' oauth_consent: '#/components/schemas/OAuthConsentImage' org_sso_connection: '#/components/schemas/OrgSsoConnectionImage' organization: '#/components/schemas/OrganizationImage' participant: '#/components/schemas/ParticipantImage' pipeline: '#/components/schemas/PipelineImage' pipeline_secret: '#/components/schemas/PipelineSecretImage' scim_token: '#/components/schemas/ScimTokenImage' team: '#/components/schemas/TeamImage' team_member: '#/components/schemas/TeamMemberImage' user: '#/components/schemas/UserImage' user_role: '#/components/schemas/UserRoleImage' user_ssh_public_key: '#/components/schemas/UserSshPublicKeyImage' workflow: '#/components/schemas/WorkflowImage' workspace: '#/components/schemas/WorkspaceImage' propertyName: auditImageType type: object oneOf: - $ref: '#/components/schemas/AccessTokenImage' - $ref: '#/components/schemas/ActionImage' - $ref: '#/components/schemas/ComputeEnvImage' - $ref: '#/components/schemas/CredentialsImage' - $ref: '#/components/schemas/CreditInfoImage' - $ref: '#/components/schemas/CreditPurchaseImage' - $ref: '#/components/schemas/CustomRoleImage' - $ref: '#/components/schemas/DataLinkFileImage' - $ref: '#/components/schemas/DataLinkImage' - $ref: '#/components/schemas/DataLinkMetadataImage' - $ref: '#/components/schemas/DatasetImage' - $ref: '#/components/schemas/DatasetVersionImage' - $ref: '#/components/schemas/DataStudioConnectionImage' - $ref: '#/components/schemas/DataStudioImage' - $ref: '#/components/schemas/IdpGroupImage' - $ref: '#/components/schemas/LabelAssignmentImage' - $ref: '#/components/schemas/LabelImage' - $ref: '#/components/schemas/ManagedCredentialsImage' - $ref: '#/components/schemas/ManagedIdentityImage' - $ref: '#/components/schemas/MemberImage' - $ref: '#/components/schemas/OAuthConsentImage' - $ref: '#/components/schemas/OrganizationImage' - $ref: '#/components/schemas/OrgSsoConnectionImage' - $ref: '#/components/schemas/ParticipantImage' - $ref: '#/components/schemas/PipelineImage' - $ref: '#/components/schemas/PipelineSecretImage' - $ref: '#/components/schemas/ScimTokenImage' - $ref: '#/components/schemas/TeamImage' - $ref: '#/components/schemas/TeamMemberImage' - $ref: '#/components/schemas/UserImage' - $ref: '#/components/schemas/UserRoleImage' - $ref: '#/components/schemas/UserSshPublicKeyImage' - $ref: '#/components/schemas/WorkflowImage' - $ref: '#/components/schemas/WorkspaceImage' previousState: allOf: - $ref: '#/components/schemas/AuditImage' - discriminator: mapping: access_token: '#/components/schemas/AccessTokenImage' action: '#/components/schemas/ActionImage' compute_env: '#/components/schemas/ComputeEnvImage' credentials: '#/components/schemas/CredentialsImage' credit_info: '#/components/schemas/CreditInfoImage' credit_purchase: '#/components/schemas/CreditPurchaseImage' custom_role: '#/components/schemas/CustomRoleImage' data_link: '#/components/schemas/DataLinkImage' data_link_file: '#/components/schemas/DataLinkFileImage' data_link_metadata: '#/components/schemas/DataLinkMetadataImage' data_studio: '#/components/schemas/DataStudioImage' data_studio_connection: '#/components/schemas/DataStudioConnectionImage' dataset: '#/components/schemas/DatasetImage' dataset_version: '#/components/schemas/DatasetVersionImage' idp_group: '#/components/schemas/IdpGroupImage' label: '#/components/schemas/LabelImage' label_assignment: '#/components/schemas/LabelAssignmentImage' managed_credentials: '#/components/schemas/ManagedCredentialsImage' managed_identity: '#/components/schemas/ManagedIdentityImage' member: '#/components/schemas/MemberImage' oauth_consent: '#/components/schemas/OAuthConsentImage' org_sso_connection: '#/components/schemas/OrgSsoConnectionImage' organization: '#/components/schemas/OrganizationImage' participant: '#/components/schemas/ParticipantImage' pipeline: '#/components/schemas/PipelineImage' pipeline_secret: '#/components/schemas/PipelineSecretImage' scim_token: '#/components/schemas/ScimTokenImage' team: '#/components/schemas/TeamImage' team_member: '#/components/schemas/TeamMemberImage' user: '#/components/schemas/UserImage' user_role: '#/components/schemas/UserRoleImage' user_ssh_public_key: '#/components/schemas/UserSshPublicKeyImage' workflow: '#/components/schemas/WorkflowImage' workspace: '#/components/schemas/WorkspaceImage' propertyName: auditImageType type: object oneOf: - $ref: '#/components/schemas/AccessTokenImage' - $ref: '#/components/schemas/ActionImage' - $ref: '#/components/schemas/ComputeEnvImage' - $ref: '#/components/schemas/CredentialsImage' - $ref: '#/components/schemas/CreditInfoImage' - $ref: '#/components/schemas/CreditPurchaseImage' - $ref: '#/components/schemas/CustomRoleImage' - $ref: '#/components/schemas/DataLinkFileImage' - $ref: '#/components/schemas/DataLinkImage' - $ref: '#/components/schemas/DataLinkMetadataImage' - $ref: '#/components/schemas/DatasetImage' - $ref: '#/components/schemas/DatasetVersionImage' - $ref: '#/components/schemas/DataStudioConnectionImage' - $ref: '#/components/schemas/DataStudioImage' - $ref: '#/components/schemas/IdpGroupImage' - $ref: '#/components/schemas/LabelAssignmentImage' - $ref: '#/components/schemas/LabelImage' - $ref: '#/components/schemas/ManagedCredentialsImage' - $ref: '#/components/schemas/ManagedIdentityImage' - $ref: '#/components/schemas/MemberImage' - $ref: '#/components/schemas/OAuthConsentImage' - $ref: '#/components/schemas/OrganizationImage' - $ref: '#/components/schemas/OrgSsoConnectionImage' - $ref: '#/components/schemas/ParticipantImage' - $ref: '#/components/schemas/PipelineImage' - $ref: '#/components/schemas/PipelineSecretImage' - $ref: '#/components/schemas/ScimTokenImage' - $ref: '#/components/schemas/TeamImage' - $ref: '#/components/schemas/TeamMemberImage' - $ref: '#/components/schemas/UserImage' - $ref: '#/components/schemas/UserRoleImage' - $ref: '#/components/schemas/UserSshPublicKeyImage' - $ref: '#/components/schemas/WorkflowImage' - $ref: '#/components/schemas/WorkspaceImage' AuditLogTargetStateMetadata: type: object properties: contentRequested: type: boolean postStateStatus: $ref: '#/components/schemas/AuditLogTargetStateMetadataStatus' preStateStatus: $ref: '#/components/schemas/AuditLogTargetStateMetadataStatus' AuditLogTargetStateMetadataStatus: type: string enum: - RECORDED - UNRECORDED - UNAPPLICABLE AuditLogV2QueryAttribute: type: string enum: - state x-enum-varnames: - state AuditLogV2ResponseDto: type: object properties: actor: $ref: '#/components/schemas/AuditLogV2ResponseDto.Actor' client: $ref: '#/components/schemas/AuditLogV2ResponseDto.Client' correlationId: type: string event: $ref: '#/components/schemas/AuditEventType' id: type: string target: $ref: '#/components/schemas/AuditLogV2ResponseDto.Target' timestamp: type: string format: date-time AuditLogV2ResponseDto.Actor: type: object properties: email: type: string firstName: type: string isRoot: type: boolean lastName: type: string type: $ref: '#/components/schemas/AuditActor.ActorType' userId: type: integer format: int64 userName: type: string AuditLogV2ResponseDto.Client: type: object properties: accessTokenId: type: integer format: int64 ip: type: string userAgent: type: string AuditLogV2ResponseDto.ResourceOrganization: type: object properties: id: type: integer format: int64 name: type: string AuditLogV2ResponseDto.ResourceUser: type: object properties: id: type: integer format: int64 name: type: string AuditLogV2ResponseDto.ResourceWorkspace: type: object properties: id: type: integer format: int64 name: type: string AuditLogV2ResponseDto.Target: type: object properties: context: $ref: '#/components/schemas/EntityContext' id: type: string name: type: string organization: $ref: '#/components/schemas/AuditLogV2ResponseDto.ResourceOrganization' state: $ref: '#/components/schemas/AuditLogTargetState' type: type: string user: $ref: '#/components/schemas/AuditLogV2ResponseDto.ResourceUser' workspace: $ref: '#/components/schemas/AuditLogV2ResponseDto.ResourceWorkspace' Avatar: type: object properties: dateCreated: type: string format: date-time id: type: string maxLength: 22 lastUpdated: type: string format: date-time AwsBatchConfig: type: object properties: cliPath: type: string computeJobRole: type: string computeQueue: type: string deletedResources: type: array items: additionalProperties: type: object type: object readOnly: true discriminator: description: property to select the compute config platform type: string dragenInstanceType: type: string dragenQueue: type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' executionRole: type: string forge: $ref: '#/components/schemas/ForgeConfig' forgedResources: type: array items: additionalProperties: type: object type: object fusion2Enabled: type: boolean fusionSnapshots: type: boolean headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 headJobRole: type: string headQueue: type: string logGroup: type: string lustreId: type: string deprecated: true nextflowConfig: type: string nvnmeStorageEnabled: type: boolean postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: type: string secretsKmsKeyId: description: Optional customer-managed KMS key used to encrypt the temporary Secrets Manager secrets created for runs that use pipeline secrets. Accepts a key ARN or a key id. When omitted, the AWS-managed default Secrets Manager key is used. type: string storageType: type: string deprecated: true volumes: type: array items: type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: AWS Batch configuration AwsBatchPlatformMetainfo: type: object properties: allocStrategy: type: array items: type: string buckets: type: array items: $ref: '#/components/schemas/Bucket' discriminator: description: property to select the platform metainfo type type: string efsFileSystems: type: array items: $ref: '#/components/schemas/EfsFileSystem' fileSystems: type: array items: $ref: '#/components/schemas/FsxFileSystem' images: type: array items: $ref: '#/components/schemas/Image' instanceFamilies: type: array items: type: string jobQueues: type: array items: $ref: '#/components/schemas/JobQueue' keyPairs: type: array items: type: string securityGroups: type: array items: $ref: '#/components/schemas/SecurityGroup' subnets: type: array items: $ref: '#/components/schemas/Subnet' vpcs: type: array items: $ref: '#/components/schemas/Vpc' warnings: type: array items: type: string title: AWS Batch platform metainfo AwsCloudConfig: type: object properties: allowBuckets: type: array items: type: string arm64Enabled: type: boolean deletedResources: type: array items: additionalProperties: type: object type: object readOnly: true discriminator: description: property to select the compute config platform type: string ebsBootSize: type: integer format: int32 ebsEncrypted: description: When true, the boot EBS volume of provisioned instances is encrypted. Null/absent (the default) is treated as false — no encryption. type: boolean ebsKmsKeyId: description: Optional KMS key ARN used to encrypt the boot EBS volume. Only applied when ebsEncrypted is true. When omitted, the account/region default EBS encryption key is used. type: string ec2KeyPair: type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' forgedResources: type: array items: additionalProperties: type: object type: object fusion2Enabled: type: boolean gpuEnabled: type: boolean imageId: type: string instanceProfileArn: type: string instanceType: type: string logGroup: type: string nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: type: string schedConfig: $ref: '#/components/schemas/SchedConfig' schedEnabled: type: boolean secretsKmsKeyId: description: Optional customer-managed KMS key used to encrypt the temporary Secrets Manager secrets created for runs that use pipeline secrets. Accepts a key ARN or a key id. When omitted, the AWS-managed default Secrets Manager key is used. type: string securityGroups: type: array items: type: string subnetId: description: DEPRECATED — use subnetIds. Kept in sync with the first element of subnetIds. type: string deprecated: true subnetIds: description: Subnets to launch into. Basic uses the first; Intelligent Compute may use all. type: array items: type: string vpcId: description: The VPC used to scope subnet and security-group selection. type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: AWS Cloud configuration AwsCloudPlatformMetainfo: type: object properties: buckets: type: array items: $ref: '#/components/schemas/Bucket' discriminator: description: property to select the platform metainfo type type: string images: type: array items: $ref: '#/components/schemas/Image' instanceTypes: type: array items: $ref: '#/components/schemas/InstanceType' keyPairs: type: array items: type: string securityGroups: type: array items: $ref: '#/components/schemas/SecurityGroup' subnets: type: array items: $ref: '#/components/schemas/Subnet' vpcs: type: array items: $ref: '#/components/schemas/Vpc' warnings: type: array items: type: string title: AWS Cloud platform metainfo AwsCredentialsMode: type: string enum: - keys - role - workloadIdentity x-enum-varnames: - keys - role - workloadIdentity x-type: String AwsSecurityKeys: type: object properties: accessKey: type: string nullable: true assumeRoleArn: type: string nullable: true discriminator: type: string externalId: type: string nullable: true mode: $ref: '#/components/schemas/AwsCredentialsMode' secretKey: type: string writeOnly: true title: AWS credentials AzBatchConfig: type: object properties: autoPoolMode: type: boolean deprecated: true deleteJobsOnCompletion: allOf: - $ref: '#/components/schemas/JobCleanupPolicy' nullable: true readOnly: true deleteJobsOnCompletionEnabled: type: boolean nullable: true deletePoolsOnCompletion: type: boolean deleteTasksOnCompletion: type: boolean nullable: true discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' forge: $ref: '#/components/schemas/AzBatchForgeConfig' fusion2Enabled: type: boolean headJobCpus: description: Number of CPU slots reserved on the head pool VM for the Nextflow head job. Defaults to 1 so multiple head jobs can share a head pool VM; increase to dedicate more CPU and memory to each head job. type: integer format: int32 example: 1 nullable: true headJobMemoryMb: description: Memory in MiB reserved for the Nextflow head job container. When omitted, the value is derived from the head pool VM size as the per-slot share (vmMemory / vmCpus) multiplied by the requested slot count. type: integer format: int32 example: 4096 nullable: true headPool: type: string jobMaxWallClockTime: description: "Maximum wall clock time for Azure Batch jobs before automatic termination. Accepts human-readable duration syntax (e.g., '7d', '1d1h1m'). Defaults to 7d when not specified. Maximum: 180 days." type: string example: 7d nullable: true managedIdentityClientId: type: string nullable: true managedIdentityHeadResourceId: type: string nullable: true managedIdentityPoolClientId: type: string nullable: true managedIdentityPoolResourceId: type: string nullable: true nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: type: string subnetId: description: Azure VNet subnet resource ID for private network isolation. Requires Entra (service principal) credentials. type: string example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet nullable: true terminateJobsOnCompletion: type: boolean nullable: true tokenDuration: type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string workerPool: type: string title: Azure Batch configuration AzBatchForgeConfig: type: object properties: autoScale: type: boolean bootDiskSizeGB: description: Boot disk size in GB for all pool nodes. When omitted, Azure uses the default disk size for the selected VM image. Per-pool values in headPool/workerPool take precedence in dual-pool mode. type: integer format: int32 example: 100 maximum: 4095 minimum: 50 nullable: true containerRegIds: type: array items: type: string disposeOnDeletion: type: boolean dualPoolConfig: type: boolean headPool: description: Head pool configuration for dual pool mode allOf: - $ref: '#/components/schemas/AzBatchPoolConfig' vmCount: type: integer format: int32 vmType: type: string workerPool: description: Worker pool configuration for dual pool mode allOf: - $ref: '#/components/schemas/AzBatchPoolConfig' AzBatchPlatformMetainfo: type: object properties: containers: type: array items: type: string discriminator: description: property to select the platform metainfo type type: string pools: type: array items: type: string vmTypes: type: array items: type: string warnings: type: array items: type: string title: Azure Batch platform metainfo AzBatchPoolConfig: description: Azure Batch pool configuration for head or worker pool type: object properties: autoScale: type: boolean bootDiskSizeGB: description: Boot disk size in GB for this pool's nodes. Overrides the forge-level bootDiskSizeGB. When omitted, falls back to the forge-level value or Azure's default. type: integer format: int32 example: 100 maximum: 4095 minimum: 50 nullable: true vmCount: type: integer format: int32 vmType: type: string AzCloudConfig: type: object properties: bootDiskSizeGB: description: OS disk size in GB for the head node instance. When omitted, Azure uses the default disk size for the VM image. type: integer format: int32 example: 100 maximum: 4095 minimum: 50 nullable: true dataCollectionEndpoint: type: string dataCollectionRuleId: type: string deletedResources: type: array items: $ref: '#/components/schemas/Map.Entry_String.String_' readOnly: true discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' forgedResources: type: array items: $ref: '#/components/schemas/Map.Entry_String.String_' fusion2Enabled: type: boolean instanceType: type: string logTableName: type: string logWorkspaceId: type: string managedIdentityClientId: type: string managedIdentityId: type: string networkId: type: string nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: type: string resourceGroup: type: string schedConfig: $ref: '#/components/schemas/SchedConfig' schedEnabled: type: boolean subnets: type: array items: type: string subscriptionId: type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Azure Cloud configuration AzCloudPlatformMetaInfo: type: object properties: containers: type: array items: type: string discriminator: description: property to select the platform metainfo type type: string instanceTypes: type: array items: type: string networks: type: array items: $ref: '#/components/schemas/AzNetwork' subnets: type: array items: $ref: '#/components/schemas/AzSubnet' warnings: type: array items: type: string title: Azure Cloud platform metainfo AzNetwork: type: object properties: id: type: string name: type: string region: type: string resourceGroup: type: string AzSubnet: type: object properties: name: type: string networkId: type: string region: type: string AzureCloudKeys: type: object properties: batchKey: type: string writeOnly: true batchName: type: string clientId: type: string clientSecret: type: string writeOnly: true discriminator: type: string storageKey: type: string writeOnly: true storageName: type: string subscriptionId: type: string tenantId: type: string title: Azure Cloud credentials AzureEntraKeys: type: object properties: batchKey: type: string writeOnly: true batchName: type: string clientId: type: string clientSecret: type: string writeOnly: true discriminator: type: string storageKey: type: string writeOnly: true storageName: type: string tenantId: type: string title: Azure Entra credentials AzureReposSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string username: type: string title: Azure Repos credentials AzureSecurityKeys: type: object properties: batchKey: type: string writeOnly: true batchName: type: string discriminator: type: string storageKey: type: string writeOnly: true storageName: type: string title: Azure credentials BitBucketSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string writeOnly: true username: type: string title: BitBucket credentials Bucket: type: object properties: path: type: string BucketActionConfig: type: object properties: bucketName: type: string dataLinkId: type: string discriminator: type: string events: type: array items: type: string filter: type: string markerFile: type: string subscriptionArn: type: string topicArn: type: string title: Bucket action config BucketActionEvent: type: object properties: bucketName: type: string discriminator: type: string eventName: type: string provider: type: string recordCount: type: integer format: int32 timestamp: type: string format: date-time title: Bucket action event BucketActionRequest: type: object properties: dataLinkId: type: string events: type: array items: type: string filter: type: string markerFile: type: string ChangeDatasetVisibilityRequest: type: object properties: datasetIds: type: array items: type: string ChangeStatus: type: string enum: - UNCHANGED - CHANGED - UNKNOWN - UNAVAILABLE CloudPriceModel: type: string enum: - standard - spot x-enum-varnames: - standard - spot CodeCommitSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string username: type: string title: AWS CodeCommit credentials ComputeConfig: type: object properties: discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string workDir: description: Compute environment working directory type: string discriminator: mapping: altair-platform: '#/components/schemas/AltairPbsComputeConfig' aws-batch: '#/components/schemas/AwsBatchConfig' aws-cloud: '#/components/schemas/AwsCloudConfig' azure-batch: '#/components/schemas/AzBatchConfig' azure-cloud: '#/components/schemas/AzCloudConfig' eks-platform: '#/components/schemas/EksComputeConfig' gke-platform: '#/components/schemas/GkeComputeConfig' google-batch: '#/components/schemas/GoogleBatchConfig' google-cloud: '#/components/schemas/GoogleCloudConfig' google-lifesciences: '#/components/schemas/GoogleLifeSciencesConfig' k8s-platform: '#/components/schemas/K8sComputeConfig' local-platform: '#/components/schemas/LocalComputeConfig' lsf-platform: '#/components/schemas/LsfComputeConfig' moab-platform: '#/components/schemas/MoabComputeConfig' seqeracompute-platform: '#/components/schemas/SeqeraComputeConfig' slurm-platform: '#/components/schemas/SlurmComputeConfig' uge-platform: '#/components/schemas/UnivaComputeConfig' propertyName: discriminator oneOf: - $ref: '#/components/schemas/AwsBatchConfig' - $ref: '#/components/schemas/AwsCloudConfig' - $ref: '#/components/schemas/SeqeraComputeConfig' - $ref: '#/components/schemas/GoogleBatchConfig' - $ref: '#/components/schemas/GoogleCloudConfig' - $ref: '#/components/schemas/AzBatchConfig' - $ref: '#/components/schemas/AzCloudConfig' - $ref: '#/components/schemas/LsfComputeConfig' - $ref: '#/components/schemas/SlurmComputeConfig' - $ref: '#/components/schemas/K8sComputeConfig' - $ref: '#/components/schemas/EksComputeConfig' - $ref: '#/components/schemas/GkeComputeConfig' - $ref: '#/components/schemas/UnivaComputeConfig' - $ref: '#/components/schemas/AltairPbsComputeConfig' - $ref: '#/components/schemas/MoabComputeConfig' - $ref: '#/components/schemas/LocalComputeConfig' - $ref: '#/components/schemas/GoogleLifeSciencesConfig' ComputeEnv.Status: type: string enum: - CREATING - AVAILABLE - DISABLED - DELETING - ERRORED - INVALID - DELETED ComputeEnvDbDto: type: object properties: id: type: string name: type: string platform: type: string region: type: string ComputeEnvImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' config: $ref: '#/components/schemas/ComputeConfig' credentialsId: type: string description: type: string fusionMetricsCollectionEnabled: type: boolean lastUsed: type: string format: date-time managedIdentityId: type: integer format: int64 message: type: string name: type: string platform: type: string primary: type: boolean status: type: string required: - auditImageType title: Compute environment audit image ComputeEnvQueryAttribute: type: string enum: - labels - resources x-enum-varnames: - labels - resources ComputeEnvResources: type: object properties: cpus: type: integer format: int32 nullable: true diskSize: type: integer format: int32 nullable: true estimatedPrice: type: number format: float nullable: true gpuEnabled: type: boolean nullable: true gpus: type: integer format: int32 nullable: true instanceType: type: string nullable: true memory: type: integer format: int32 nullable: true ComputeEnvResponseDto: type: object properties: awsAccountId: type: string nullable: true config: $ref: '#/components/schemas/ComputeConfig' credentialsId: type: string dateCreated: type: string format: date-time deleted: type: boolean description: type: string fusionMetricsCollectionEnabled: type: boolean id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' lastUpdated: type: string format: date-time lastUsed: type: string format: date-time managedIdentityId: type: string message: type: string name: type: string orgId: type: integer format: int64 platform: type: string enum: - aws-batch - aws-cloud - seqeracompute-platform - google-batch - google-cloud - azure-batch - azure-cloud - k8s-platform - eks-platform - gke-platform - uge-platform - slurm-platform - lsf-platform - altair-platform - moab-platform - local-platform - google-lifesciences primary: type: boolean resources: allOf: - $ref: '#/components/schemas/ComputeEnvResources' nullable: true status: $ref: '#/components/schemas/ComputeEnv.Status' workspaceId: type: integer format: int64 ComputeEnv_ComputeConfig_: type: object properties: config: $ref: '#/components/schemas/ComputeConfig' credentialsId: type: string dateCreated: type: string format: date-time readOnly: true deleted: type: boolean readOnly: true description: type: string maxLength: 2000 fusionMetricsCollectionEnabled: type: boolean id: type: string maxLength: 22 readOnly: true lastUpdated: type: string format: date-time readOnly: true lastUsed: type: string format: date-time readOnly: true message: type: string maxLength: 4096 name: type: string maxLength: 100 orgId: type: integer format: int64 readOnly: true platform: type: string enum: - aws-batch - aws-cloud - seqeracompute-platform - google-batch - google-cloud - azure-batch - azure-cloud - k8s-platform - eks-platform - gke-platform - uge-platform - slurm-platform - lsf-platform - altair-platform - moab-platform - local-platform - google-lifesciences maxLength: 25 primary: type: boolean readOnly: true status: allOf: - $ref: '#/components/schemas/ComputeEnv.Status' readOnly: true workspaceId: type: integer format: int64 readOnly: true required: - config - name - platform ComputePlatform: type: object properties: credentialsProviders: type: array items: type: string id: type: string name: type: string ComputePlatformDto: type: object properties: id: type: string name: type: string ComputeRegion: type: object properties: id: type: string name: type: string ConfigEnvVariable: type: object properties: compute: type: boolean head: type: boolean name: type: string value: type: string ConflictingResource: type: object properties: id: type: string name: type: string type: type: string url: type: string ContainerData: type: object properties: buildId: type: string cached: type: boolean freeze: type: boolean mirrorId: type: string requestId: type: string requestTime: type: string format: date-time scanId: type: string sourceImage: type: string targetImage: type: string required: - targetImage ContainerRegistryKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true registry: type: string userName: type: string title: Container registry credentials CreateAccessTokenRequest: type: object properties: name: type: string CreateAccessTokenResponse: type: object properties: accessKey: type: string token: $ref: '#/components/schemas/AccessToken' CreateActionRequest: type: object properties: bucket: $ref: '#/components/schemas/BucketActionRequest' cron: $ref: '#/components/schemas/CronActionRequest' launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string source: $ref: '#/components/schemas/Action.Source' CreateActionResponse: type: object properties: actionId: type: string CreateAgentRequest: type: object properties: agentInstructions: type: string agentInstructionsTemplateId: type: string nullable: true description: type: string nullable: true name: type: string CreateAgentResponse: type: object properties: agent: $ref: '#/components/schemas/AgentDbDto' CreateAvatarResponse: type: object properties: avatar: $ref: '#/components/schemas/Avatar' url: type: string CreateComputeEnvRequest: type: object properties: computeEnv: $ref: '#/components/schemas/ComputeEnv_ComputeConfig_' labelIds: type: array items: format: int64 type: integer CreateComputeEnvResponse: type: object properties: computeEnvId: type: string CreateCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/Credentials' CreateCredentialsResponse: type: object properties: credentialsId: type: string CreateDataStudioStarResponse: type: object properties: sessionId: type: string CreateDatasetRequest: type: object properties: description: type: string name: type: string sourceType: $ref: '#/components/schemas/SourceType' CreateDatasetResponse: type: object properties: dataset: $ref: '#/components/schemas/DatasetDto' CreateIdpGroupRequest: type: object properties: displayName: type: string CreateLabelRequest: type: object properties: isDefault: type: boolean name: type: string resource: type: boolean value: type: string CreateLabelResponse: type: object properties: id: type: integer format: int64 isDefault: type: boolean name: type: string resource: type: boolean value: type: string CreateManagedCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/Credentials' metadata: $ref: '#/components/schemas/ManagedCredentialsMetadata' provider: type: string enum: - ssh CreateManagedCredentialsResponse: type: object properties: managedCredentials: $ref: '#/components/schemas/ManagedCredentialsDbDto' CreateManagedIdentityRequest: type: object properties: config: $ref: '#/components/schemas/AbstractGridConfig' name: type: string platform: type: string enum: - altair-platform - lsf-platform - moab-platform - slurm-platform - uge-platform CreateManagedIdentityResponse: type: object properties: config: $ref: '#/components/schemas/ComputeConfig' id: type: integer format: int64 name: type: string platform: type: string CreateOrganizationRequest: type: object properties: logoId: type: string organization: $ref: '#/components/schemas/Organization' CreateOrganizationResponse: type: object properties: organization: $ref: '#/components/schemas/OrganizationDbDto' CreatePipelineRequest: type: object properties: description: type: string icon: type: string labelIds: type: array items: format: int64 type: integer launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string version: $ref: '#/components/schemas/CreatePipelineVersionRequest' CreatePipelineResponse: type: object properties: pipeline: $ref: '#/components/schemas/PipelineDbDto' CreatePipelineSchemaRequest: type: object properties: content: type: string CreatePipelineSchemaResponse: type: object properties: pipelineSchema: $ref: '#/components/schemas/PipelineSchemaDbDto' CreatePipelineSecretRequest: type: object properties: name: type: string value: type: string CreatePipelineSecretResponse: type: object properties: secretId: type: integer format: int64 CreatePipelineVersionRequest: type: object properties: name: type: string CreateRoleRequest: type: object properties: description: type: string maxLength: 120 minLength: 1 name: type: string permissions: type: array items: type: string required: - description CreateRoleResponse: type: object properties: description: type: string name: type: string permissions: type: array items: type: string CreateScimTokenResponse: type: object properties: endpointUrl: type: string maskedToken: type: string token: type: string CreateSshKeyRequest: type: object properties: name: type: string publicKey: type: string required: - name - publicKey CreateSshKeyResponse: type: object properties: sshKey: $ref: '#/components/schemas/UserSshPublicKeyDto' CreateTeamMemberRequest: type: object properties: userNameOrEmail: type: string CreateTeamRequest: type: object properties: avatarId: type: string idpGroupId: type: integer format: int64 nullable: true team: $ref: '#/components/schemas/Team' CreateTeamResponse: type: object properties: team: $ref: '#/components/schemas/TeamDbDto' CreateWorkflowStarResponse: type: object properties: workflowId: type: string CreateWorkspaceRequest: type: object properties: workspace: $ref: '#/components/schemas/Workspace' CreateWorkspaceResponse: type: object properties: workspace: $ref: '#/components/schemas/Workspace' Credentials: type: object properties: baseUrl: type: string maxLength: 200 nullable: true pattern: '' category: type: string maxLength: 20 nullable: true dateCreated: type: string format: date-time readOnly: true deleted: type: boolean nullable: true readOnly: true description: type: string nullable: true id: type: string maxLength: 22 keys: $ref: '#/components/schemas/SecurityKeys' lastUpdated: type: string format: date-time readOnly: true lastUsed: type: string format: date-time nullable: true readOnly: true lastValidated: description: Timestamp of the most recent completed validation probe (success or authoritative fail). Null until first probe. NOT advanced on transient probe outcomes. type: string format: date-time nullable: true readOnly: true message: description: Provider-supplied error detail captured when status transitions to INVALID. Cleared (null) whenever status returns to AVAILABLE. Truncated to 4096 characters with a trailing " (truncated)" suffix when the underlying provider message exceeds that limit. type: string maxLength: 4096 nullable: true readOnly: true name: type: string maxLength: 100 provider: type: string enum: - aws - azure - azure_entra - google - github - github_app - gitlab - bitbucket - ssh - k8s - container-reg - tw-agent - codecommit - gitea - azurerepos - seqeracompute - azure-cloud - s3 maxLength: 16 status: description: Validation health for these credentials. AVAILABLE = last probe succeeded (or no probe has been attempted yet). INVALID = the last probe was authoritatively rejected by the provider (see message). Transient probe failures (network / 5xx) leave this field untouched. allOf: - $ref: '#/components/schemas/Credentials.Status' readOnly: true required: - name - provider Credentials.Status: type: string enum: - AVAILABLE - INVALID CredentialsImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' baseUrl: type: string category: type: string description: type: string keys: $ref: '#/components/schemas/SecurityKeys' lastUsed: type: string format: date-time message: type: string name: type: string provider: type: string status: type: string required: - auditImageType title: Credentials audit image CreditInfoImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' contractId: type: string customerId: type: string hasCreditGrant: type: boolean required: - auditImageType title: Credit info audit image CreditPurchaseImage: type: object properties: amount: type: number auditImageType: $ref: '#/components/schemas/AuditImageType' createdByUserId: type: integer format: int64 organizationId: type: integer format: int64 status: type: string required: - auditImageType title: Credit purchase audit image CronActionConfig: type: object properties: discriminator: type: string expression: type: string preset: type: string timezone: type: string title: Cron action config CronActionEvent: type: object properties: discriminator: type: string scheduledTime: type: string format: date-time timestamp: type: string format: date-time workflowId: type: string title: Cron action event CronActionRequest: type: object properties: expression: type: string preset: type: string timezone: type: string CustomRoleImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' contextType: type: string description: type: string name: type: string permissions: type: array items: type: string required: - auditImageType title: Custom role audit image DataLink.Status: type: string enum: - VALID - INVALID readOnly: true DataLinkContentResponse: type: object properties: nextPageToken: type: string objects: type: array items: $ref: '#/components/schemas/DataLinkItem' originalPath: type: string DataLinkContentTreeListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/DataLinkSimpleItem' required: - items DataLinkCreateRequest: type: object properties: credentialsId: type: string description: type: string name: type: string provider: $ref: '#/components/schemas/DataLinkProvider' publicAccessible: type: boolean resourceRef: type: string type: $ref: '#/components/schemas/DataLinkType' DataLinkCredentials: type: object properties: id: type: string name: type: string provider: $ref: '#/components/schemas/DataLinkProvider' required: - id - name - provider DataLinkDeleteItemRequest: type: object properties: dirs: type: array items: type: string files: type: array items: type: string DataLinkDeleteItemResponse: type: object properties: deletionFailures: type: array items: $ref: '#/components/schemas/DataLinkItemDeletionFailure' DataLinkDownloadScriptResponse: type: object properties: script: type: string DataLinkDownloadUrlResponse: type: object properties: resolvedMimeType: type: string resolvedPath: type: string url: type: string warning: type: string DataLinkDto: type: object properties: credentials: type: array items: $ref: '#/components/schemas/DataLinkCredentials' description: type: string hidden: type: boolean id: type: string message: type: string name: type: string provider: $ref: '#/components/schemas/DataLinkProvider' publicAccessible: type: boolean region: type: string resourceRef: type: string status: allOf: - $ref: '#/components/schemas/DataLink.Status' readOnly: true type: $ref: '#/components/schemas/DataLinkType' DataLinkFileImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' provider: type: string uri: type: string required: - auditImageType title: Data-link file operation audit image DataLinkFinishMultiPartUploadRequest: type: object properties: fileName: type: string tags: items: $ref: '#/components/schemas/UploadEtag' type: array uploadId: type: string withError: type: boolean DataLinkImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' creationSource: type: string credentialsId: type: string description: type: string message: type: string name: type: string provider: type: string publicAccessible: type: boolean region: type: string resourceRef: type: string status: type: string type: type: string required: - auditImageType title: Data-link audit image DataLinkItem: type: object properties: lastModified: description: Last-modified timestamp of the object (ISO-8601, UTC). Null for folders. type: string format: date-time nullable: true mimeType: type: string name: type: string size: type: integer format: int64 type: $ref: '#/components/schemas/DataLinkItemType' DataLinkItemDeletionFailure: type: object properties: dataLinkItem: $ref: '#/components/schemas/DataLinkItem' errorMessage: type: string required: - dataLinkItem - errorMessage DataLinkItemType: type: string enum: - FOLDER - FILE - FUSION_SYMLINK_FILE DataLinkMetadataImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' hidden: type: boolean required: - auditImageType title: Data-link metadata audit image DataLinkMultiPartUploadRequest: type: object properties: contentLength: type: integer format: int64 contentType: type: string fileName: type: string partNumbers: type: array items: format: int32 type: integer uploadId: type: string DataLinkMultiPartUploadResponse: type: object properties: uploadId: type: string uploadUrls: type: array items: type: string DataLinkProvider: type: string enum: - aws - google - azure - azure_entra - azure-cloud - seqeracompute - s3 DataLinkResponse: type: object properties: dataLink: $ref: '#/components/schemas/DataLinkDto' DataLinkSimpleItem: type: object properties: path: type: string size: type: integer format: int64 required: - path - size DataLinkType: type: string enum: - bucket x-enum-varnames: - bucket DataLinkUpdateRequest: type: object properties: credentialsId: type: string description: type: string name: type: string DataLinksListResponse: type: object properties: dataLinks: type: array items: $ref: '#/components/schemas/DataLinkDto' totalSize: type: integer format: int64 DataStudioCheckpointDto: type: object properties: author: $ref: '#/components/schemas/UserInfo' dateCreated: type: string format: date-time dateSaved: type: string format: date-time id: type: integer format: int64 name: type: string path: type: string status: $ref: '#/components/schemas/StudioCheckpointStatus' required: - author - dateCreated - dateSaved - id - name - path - status DataStudioCheckpointUpdateRequest: type: object properties: name: type: string DataStudioComputeEnvDto: type: object allOf: - $ref: '#/components/schemas/ComputeEnvDbDto' - properties: credentialsId: type: string workDir: type: string type: object DataStudioConfiguration: type: object properties: condaEnvironment: type: string maxLength: 2048 cpu: type: integer format: int32 minimum: 0 environment: type: object additionalProperties: type: string nullable: true gpu: type: integer format: int32 minimum: 0 lifespanHours: type: integer format: int32 minimum: 0 memory: type: integer format: int32 minimum: 0 mountData: type: array items: type: string deprecated: true nullable: true mountDataV2: type: array items: $ref: '#/components/schemas/MountData' nullable: true sshEnabled: type: boolean nullable: true DataStudioConnectionImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' connectionTag: type: integer format: int32 lastActive: type: string format: date-time userId: type: string required: - auditImageType title: Data Studio connection audit image DataStudioCreateRequest: type: object properties: allowedUserIds: type: array items: format: int64 type: integer nullable: true computeEnvId: type: string minLength: 1 configuration: $ref: '#/components/schemas/DataStudioConfiguration' dataStudioToolUrl: type: string description: type: string maxLength: 2048 initialCheckpointId: type: integer format: int64 isPrivate: type: boolean labelIds: type: array items: format: int64 type: integer nullable: true name: type: string maxLength: 80 minLength: 1 remoteConfig: allOf: - $ref: '#/components/schemas/StudioRemoteConfiguration' nullable: true spot: type: boolean nullable: true required: - computeEnvId - name DataStudioCreateResponse: type: object properties: studio: $ref: '#/components/schemas/DataStudioDto' DataStudioDto: type: object properties: activeConnections: type: array items: $ref: '#/components/schemas/ActiveConnection' allowedUsers: type: array items: $ref: '#/components/schemas/UserInfo' nullable: true baseImage: type: string computeEnv: $ref: '#/components/schemas/DataStudioComputeEnvDto' configuration: $ref: '#/components/schemas/DataStudioConfiguration' customImage: type: boolean dateCreated: type: string format: date-time description: type: string effectiveLifespanHours: type: integer format: int32 isPrivate: type: boolean labels: type: array items: $ref: '#/components/schemas/LabelDbDto' nullable: true lastStarted: type: string format: date-time lastUpdated: type: string format: date-time mountedDataLinks: type: array items: $ref: '#/components/schemas/DataLinkDto' name: type: string parentCheckpoint: $ref: '#/components/schemas/DataStudioDto.ParentCheckpoint' progress: type: array items: $ref: '#/components/schemas/DataStudioProgressStep' remoteConfig: $ref: '#/components/schemas/StudioRemoteConfiguration' sessionId: type: string sshDetails: allOf: - $ref: '#/components/schemas/StudioSshDetailsDto' nullable: true starred: type: boolean statusInfo: $ref: '#/components/schemas/DataStudioStatusInfo' studioUrl: type: string template: $ref: '#/components/schemas/DataStudioTemplate' user: $ref: '#/components/schemas/UserInfo' waveBuildUrl: type: string workspaceId: type: integer format: int64 DataStudioDto.ParentCheckpoint: type: object properties: checkpointId: type: integer format: int64 checkpointName: type: string sessionId: type: string studioName: type: string DataStudioImage: type: object properties: appliedLifespanHours: type: integer format: int32 auditImageType: $ref: '#/components/schemas/AuditImageType' baseImage: type: string computeEnvId: type: string condaEnvironment: type: string connectVersion: type: string description: type: string effectiveLifespanHours: type: integer format: int32 environment: type: string initialCheckpointId: type: integer format: int64 initialSessionId: type: string isPrivate: type: boolean lastHeartbeat: type: string format: date-time lastStarted: type: string format: date-time name: type: string remoteConfigCloneEnabled: type: boolean remoteConfigClonePath: type: string remoteConfigCommitHash: type: string remoteConfigRepository: type: string remoteConfigRevision: type: string requiredCpus: type: integer format: int64 requiredGpus: type: integer format: int64 requiredMemory: type: integer format: int64 runningOperationId: type: string sshEnabled: type: boolean status: type: string statusMessage: type: string stopReason: type: string templateIcon: type: string templatePort: type: integer format: int32 templateUrl: type: string tool: type: string userId: type: integer format: int64 waveBuildId: type: string required: - auditImageType title: Data Studio audit image DataStudioListCheckpointsResponse: type: object properties: checkpoints: type: array items: $ref: '#/components/schemas/DataStudioCheckpointDto' totalSize: type: integer format: int64 required: - checkpoints - totalSize DataStudioListResponse: type: object properties: studios: type: array items: $ref: '#/components/schemas/DataStudioDto' totalSize: type: integer format: int64 required: - studios - totalSize DataStudioLogResponse: type: object properties: log: $ref: '#/components/schemas/LogPage' DataStudioMountedLinksResponse: type: object properties: dataLinkIds: type: array items: type: string DataStudioProgressStep: type: object properties: message: type: string status: $ref: '#/components/schemas/DataStudioProgressStep.Status' warnings: type: array items: type: string DataStudioProgressStep.Status: type: string enum: - pending - in-progress - succeeded - errored DataStudioQueryAttribute: type: string enum: - labels x-enum-varnames: - labels DataStudioStartRequest: type: object properties: allowedUserIds: type: array items: format: int64 type: integer nullable: true configuration: allOf: - $ref: '#/components/schemas/DataStudioConfiguration' nullable: true description: type: string nullable: true labelIds: type: array items: format: int64 type: integer nullable: true name: type: string maxLength: 80 minLength: 1 nullable: true spot: type: boolean nullable: true DataStudioStartResponse: type: object properties: jobSubmitted: type: boolean sessionId: type: string statusInfo: $ref: '#/components/schemas/DataStudioStatusInfo' required: - jobSubmitted - sessionId - statusInfo DataStudioStatus: type: string enum: - starting - running - stopping - stopped - errored - building - buildFailed x-enum-varnames: - starting - running - stopping - stopped - errored - building - buildFailed DataStudioStatusInfo: type: object properties: canForceStop: type: boolean lastUpdate: type: string format: date-time message: type: string status: $ref: '#/components/schemas/DataStudioStatus' stopReason: $ref: '#/components/schemas/DataStudioStopReason' DataStudioStopReason: type: string enum: - CREDITS_RUN_OUT - LIFESPAN_EXPIRED - SPOT_RECLAMATION - NO_STATS_AVAIL - FORCE_STOPPED DataStudioStopResponse: type: object properties: jobSubmitted: type: boolean sessionId: type: string statusInfo: $ref: '#/components/schemas/DataStudioStatusInfo' required: - jobSubmitted - sessionId - statusInfo DataStudioTemplate: type: object properties: icon: type: string repository: type: string status: $ref: '#/components/schemas/DataStudioVersionStatus' tool: type: string DataStudioTemplatesListResponse: type: object properties: templates: type: array items: $ref: '#/components/schemas/DataStudioTemplate' totalSize: type: integer format: int64 required: - templates - totalSize DataStudioUpdateRequest: type: object properties: computeEnvId: type: string nullable: true configuration: allOf: - $ref: '#/components/schemas/DataStudioConfiguration' nullable: true description: type: string maxLength: 2048 nullable: true labelIds: type: array items: format: int64 type: integer nullable: true name: type: string maxLength: 80 minLength: 1 nullable: true DataStudioVersionStatus: type: string enum: - recommended - deprecated - experimental - unsupported x-enum-varnames: - recommended - deprecated - experimental - unsupported DataStudioWorkspaceSettingsRequest: type: object properties: containerRepository: description: Container repository where Wave pushes images built for Studios in this workspace (e.g. 'cr.seqera.io/my-org/studios'). When null, the platform default is used. type: string nullable: true lifespanHours: description: Maximum number of hours a Studio session may run before it is automatically stopped. Use 0 for unlimited lifespan. type: integer format: int32 nameStrategy: description: Wave image naming strategy applied to container images built for Studios in this workspace. When null, the platform default strategy is used. type: string enum: - none - tagPrefix - imageSuffix nullable: true privateStudioByDefault: description: When true, newly created Studio sessions are private by default and only accessible to their creator. type: boolean DataStudioWorkspaceSettingsResponse: type: object properties: containerRepository: type: string nullable: true lifespanHours: type: integer format: int32 nameStrategy: type: string nullable: true orgId: type: integer format: int64 privateStudioByDefault: type: boolean wspId: type: integer format: int64 DatasetDto: type: object properties: dateCreated: type: string format: date-time deleted: type: boolean description: type: string hidden: type: boolean id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' lastUpdated: type: string format: date-time lastUpdatedBy: $ref: '#/components/schemas/UserInfo' mediaType: type: string name: type: string organizationId: type: integer format: int64 runsInfo: $ref: '#/components/schemas/DatasetRunsInfo' sourceType: $ref: '#/components/schemas/SourceType' user: $ref: '#/components/schemas/UserInfo' version: type: integer format: int64 workspaceId: type: integer format: int64 DatasetImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' description: type: string hidden: type: boolean lastUpdatedById: type: integer format: int64 mediaType: type: string name: type: string sourceType: type: string required: - auditImageType title: Dataset audit image DatasetPreviewResponse: type: object properties: content: type: string fileTooLarge: type: boolean reachable: type: boolean DatasetQueryAttribute: type: string enum: - labels x-enum-varnames: - labels DatasetRunsInfo: type: object properties: lastUsed: type: string format: date-time runsCount: type: integer format: int64 DatasetVersionDto: type: object properties: createdBy: $ref: '#/components/schemas/UserInfo' datasetDescription: type: string datasetId: type: string datasetName: type: string dateCreated: type: string format: date-time disabled: type: boolean fileName: type: string fileSize: type: integer format: int64 hasHeader: type: boolean lastUpdated: type: string format: date-time linkedSource: $ref: '#/components/schemas/LinkedSourceDto' mediaType: type: string url: type: string version: type: integer format: int64 workspaceId: type: integer format: int64 DatasetVersionImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' createdById: type: integer format: int64 data: $ref: '#/components/schemas/DatasetVersionImage.BlobContentImage' datasetId: type: string disabled: type: boolean hasHeader: type: boolean latest: type: boolean linkedSource: $ref: '#/components/schemas/DatasetVersionImage.LinkedSourceImage' version: type: integer format: int64 required: - auditImageType title: Dataset version audit image DatasetVersionImage.BlobContentImage: type: object properties: fileName: type: string mediaType: type: string size: type: integer format: int64 title: Blob content snapshot DatasetVersionImage.LinkedSourceImage: type: object properties: checkedAt: type: string format: date-time contentLength: type: integer format: int64 etag: type: string lastModified: type: string format: date-time mediaType: type: string url: type: string title: Linked source snapshot DefaultWorkflowEngineParameter: type: object properties: default_value: type: string name: type: string type: type: string DeleteCredentialsConflictResponse: type: object properties: conflicts: type: array items: $ref: '#/components/schemas/ConflictingResource' credentialsId: type: string DeleteDatasetsRequest: type: object properties: datasetIds: type: array items: type: string DeleteDatasetsResponse: type: object properties: failed: type: array items: type: string success: type: array items: type: string DeleteManagedCredentialsConflictResponse: type: object properties: conflicts: type: array items: $ref: '#/components/schemas/ConflictingResource' managedCredentialsId: type: string DeleteWorkflowsRequest: type: object properties: workflowIds: type: array items: type: string DeleteWorkflowsResponse: type: object properties: failedWorkflowIds: type: array items: type: string DescribeActionResponse: type: object properties: action: $ref: '#/components/schemas/ActionResponseDto' DescribeAgentResponse: type: object properties: agent: $ref: '#/components/schemas/AgentDbDto' DescribeComputeEnvResponse: type: object properties: computeEnv: $ref: '#/components/schemas/ComputeEnvResponseDto' DescribeCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/Credentials' setupSnippet: description: Server-rendered, read-only provider-side setup snippet (e.g. AWS IAM role trust policy) to paste at the cloud provider. Populated when a renderer is available for the credential type and the installation is configured for it; otherwise omitted. type: string nullable: true readOnly: true DescribeDatasetResponse: type: object properties: dataset: $ref: '#/components/schemas/DatasetDto' DescribeLaunchResponse: type: object properties: launch: $ref: '#/components/schemas/LaunchDbDto' DescribeOrganizationQuotasResponse: type: object properties: quotas: $ref: '#/components/schemas/OrganizationQuotas' DescribeOrganizationResponse: type: object properties: organization: $ref: '#/components/schemas/OrganizationDbDto' DescribePipelineInfoResponse: type: object properties: pipelineInfo: $ref: '#/components/schemas/PipelineInfo' DescribePipelineResponse: type: object properties: pipeline: $ref: '#/components/schemas/PipelineDbDto' DescribePipelineSecretResponse: type: object properties: pipelineSecret: $ref: '#/components/schemas/PipelineSecret' DescribePlatformResponse: type: object properties: metainfo: $ref: '#/components/schemas/PlatformMetainfo' DescribeRoleResponse: type: object properties: role: $ref: '#/components/schemas/RoleDto' DescribeScimConfigResponse: type: object properties: endpointUrl: type: string groupCount: type: integer format: int32 hasActiveToken: type: boolean maskedToken: type: string nullable: true ssoActive: type: boolean tokenCreatedAt: type: string format: date-time nullable: true tokenLastUsed: type: string format: date-time nullable: true DescribeSshKeyResponse: type: object properties: sshKey: $ref: '#/components/schemas/UserSshPublicKeyDto' DescribeTaskResponse: type: object properties: task: $ref: '#/components/schemas/Task' DescribeTeamResponse: type: object properties: team: $ref: '#/components/schemas/TeamDbDto' DescribeUserResponse: type: object properties: defaultWorkspaceId: type: integer format: int64 nullable: true needConsent: type: boolean user: $ref: '#/components/schemas/UserResponseDto' DescribeWorkflowLaunchResponse: type: object properties: launch: $ref: '#/components/schemas/WorkflowLaunchResponse' DescribeWorkflowResponse: type: object properties: cost: type: number nullable: true costCurrency: type: string nullable: true costIsEstimate: type: boolean nullable: true instancesProvisioned: type: integer format: int32 nullable: true jobInfo: $ref: '#/components/schemas/JobInfoDto' labels: type: array items: $ref: '#/components/schemas/LabelDbDto' messages: type: array items: type: string optimized: type: boolean orgId: type: integer format: int64 orgName: type: string pipelineInfo: $ref: '#/components/schemas/PipelineMinInfoResponse' platform: $ref: '#/components/schemas/ComputePlatformDto' progress: $ref: '#/components/schemas/ProgressData' schedConfig: allOf: - $ref: '#/components/schemas/SchedConfig' nullable: true schedEnabled: type: boolean nullable: true schedRunId: type: string nullable: true workflow: $ref: '#/components/schemas/WorkflowMaxDbDto' workspaceId: type: integer format: int64 workspaceName: type: string DescribeWorkspaceResponse: type: object properties: workspace: $ref: '#/components/schemas/Workspace' DisplayData: type: object properties: processName: type: string runName: type: string taskHash: type: string workflowId: type: string workspaceId: type: integer format: int64 EfsFileSystem: type: object properties: id: type: string EksComputeConfig: type: object properties: clusterName: description: The AWS EKS cluster name type: string computeServiceAccount: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 headPodSpec: type: string headServiceAccount: type: string namespace: type: string nextflowConfig: type: string podCleanup: $ref: '#/components/schemas/PodCleanupPolicy' postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: description: AWS region type: string server: type: string servicePodSpec: type: string sslCert: type: string storageClaimName: type: string storageMountPath: type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Amazon EKS cluster configuration EksPlatformMetaInfo: type: object properties: clusters: type: array items: type: string discriminator: description: property to select the platform metainfo type type: string warnings: type: array items: type: string title: Amazon EKS platform metainfo EmptyBodyRequest: type: object EntityContext: type: string enum: - User - Organization - Workspace - System x-enum-varnames: - User - Organization - Workspace - System ErrorResponse: type: object properties: message: type: string required: - message EventType: type: object properties: description: type: string display: type: string enabled: type: boolean source: type: string Feature: type: string enum: - AMD - ARM - SCHED - GPU - FPGA - NVME ForgeConfig: type: object properties: allocStrategy: type: string enum: - BEST_FIT - BEST_FIT_PROGRESSIVE - SPOT_CAPACITY_OPTIMIZED - SPOT_PRICE_CAPACITY_OPTIMIZED allowBuckets: type: array items: type: string arm64Enabled: type: boolean bidPercentage: type: integer format: int32 disposeOnDeletion: type: boolean dragenAmiId: type: string dragenEnabled: type: boolean dragenInstanceType: type: string ebsAutoScale: type: boolean ebsBlockSize: type: integer format: int32 ebsBootSize: type: integer format: int32 ec2KeyPair: type: string ecsConfig: type: string efsCreate: type: boolean efsId: type: string efsMount: type: string fargateHeadEnabled: type: boolean fsxMount: type: string fsxName: type: string fsxSize: type: integer format: int32 fusionEnabled: type: boolean gpuEnabled: type: boolean imageId: type: string instanceTypes: type: array items: type: string maxCpus: type: integer format: int32 minCpus: type: integer format: int32 securityGroups: type: array items: type: string subnets: type: array items: type: string type: type: string enum: - SPOT - EC2 vpcId: type: string FsxFileSystem: type: object properties: dns: type: string id: type: string mount: type: string GetCredentialsKeysResponse: type: object properties: keys: type: string GetProgressResponse: type: object properties: progress: $ref: '#/components/schemas/ProgressData' GetWorkflowMetricsResponse: type: object properties: metrics: type: array items: $ref: '#/components/schemas/WorkflowMetrics' GitHubAppSecurityKeys: type: object properties: appId: type: string clientId: type: string clientSecret: type: string writeOnly: true discriminator: type: string privateKey: type: string writeOnly: true slug: type: string webhookSecret: type: string writeOnly: true GitHubSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string username: type: string title: GitHub credentials GitKeys: type: object properties: discriminator: type: string password: type: string token: type: string username: type: string GitLabSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string writeOnly: true username: type: string title: GitLab credentials GiteaSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true token: type: string username: type: string title: Gitea credentials GithubActionConfig: type: object properties: discriminator: type: string events: type: array items: type: string title: GitHub action config GithubActionEvent: type: object properties: commitId: type: string commitMessage: type: string discriminator: type: string pusherEmail: type: string pusherName: type: string ref: type: string timestamp: type: string format: date-time title: GitHub action event GkeComputeConfig: type: object properties: clusterName: description: The GKE cluster name type: string computeServiceAccount: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 headPodSpec: type: string headServiceAccount: type: string namespace: type: string nextflowConfig: type: string podCleanup: $ref: '#/components/schemas/PodCleanupPolicy' postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: description: The GKE cluster region - or - zone type: string server: type: string servicePodSpec: type: string sslCert: type: string storageClaimName: type: string storageMountPath: type: string waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Google GKE cluster configuration GkePlatformMetaInfo: type: object properties: clusters: type: array items: type: string discriminator: description: property to select the platform metainfo type type: string warnings: type: array items: type: string title: Google GKE platform metainfo GoogleBatchConfig: type: object properties: bootDiskImage: type: string bootDiskSizeGb: type: integer format: int32 computeJobsInstanceTemplate: type: string computeJobsMachineType: type: array items: type: string copyImage: type: string cpuPlatform: type: string debugMode: type: integer format: int32 discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean fusionSnapshots: type: boolean headJobCpus: type: integer format: int32 headJobInstanceTemplate: type: string headJobMemoryMb: type: integer format: int32 labels: type: object additionalProperties: type: string location: type: string machineType: type: string network: type: string networkTags: type: array items: type: string nextflowConfig: type: string nfsMount: type: string nfsTarget: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string projectId: type: string serviceAccount: type: string spot: type: boolean sshDaemon: type: boolean sshImage: type: string subnetwork: type: string usePrivateAddress: type: boolean waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Google Batch service configuration GoogleBucket: type: object properties: path: type: string GoogleCloudConfig: type: object properties: arm64Enabled: type: boolean bootDiskSizeGb: type: integer format: int32 deletedResources: type: array items: additionalProperties: type: object type: object readOnly: true discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' forgedResources: type: array items: additionalProperties: type: object type: object fusion2Enabled: type: boolean gpuEnabled: type: boolean imageId: type: string instanceType: type: string network: description: VPC network for compute instances. Short name or fully-qualified path; defaults to the project's 'default' network when empty. type: string nullable: true networkTags: description: Network tags applied to compute instances (VPC firewall-rule targets). type: array items: type: string nullable: true nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string projectId: type: string region: type: string schedConfig: $ref: '#/components/schemas/SchedConfig' schedEnabled: type: boolean serviceAccountEmail: type: string subnetworks: description: Subnetworks for compute instances. Short names (scoped to the CE region) or fully-qualified paths. Basic uses the first; Intelligent Compute may use all. type: array items: type: string nullable: true usePrivateAddress: description: Launch instances without an external IP. Requires Cloud NAT + Private Google Access on the subnetwork. type: boolean nullable: true waveEnabled: type: boolean workDir: description: Compute environment working directory type: string zone: type: string title: Google Cloud configuration GoogleCloudPlatformMetaInfo: type: object properties: buckets: type: array items: $ref: '#/components/schemas/GoogleBucket' discriminator: description: property to select the platform metainfo type type: string images: type: array items: $ref: '#/components/schemas/GoogleImage' instanceTypes: type: array items: $ref: '#/components/schemas/GoogleInstanceType' networks: type: array items: $ref: '#/components/schemas/GoogleNetwork' subnetworks: type: array items: $ref: '#/components/schemas/GoogleSubnetwork' warnings: type: array items: type: string zones: type: array items: type: string title: Google Cloud platform metainfo GoogleImage: type: object properties: arch: type: string description: type: string id: type: string name: type: string qualifiedName: type: string GoogleInstanceType: type: object properties: arch: type: string features: description: Capability features advertised for this instance type (e.g. GPU). Absent when the data source does not publish features; an empty list means none. type: array items: $ref: '#/components/schemas/Feature' id: type: string GoogleLifeSciencesConfig: type: object properties: bootDiskSizeGb: type: integer format: int32 copyImage: type: string debugMode: type: integer format: int32 discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 labels: type: object additionalProperties: type: string location: type: string nextflowConfig: type: string nfsMount: type: string nfsTarget: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preemptible: type: boolean preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string projectId: type: string region: type: string sshDaemon: type: boolean sshImage: type: string usePrivateAddress: type: boolean workDir: description: Compute environment working directory type: string zones: type: array items: type: string title: Google Life Sciences configuration (retired) GoogleNetwork: type: object properties: name: type: string selfLink: type: string GooglePlatformMetainfo: type: object properties: buckets: type: array items: $ref: '#/components/schemas/GooglePlatformMetainfo.Bucket' discriminator: description: property to select the platform metainfo type type: string filestores: type: array items: $ref: '#/components/schemas/GooglePlatformMetainfo.Filestore' images: type: array items: $ref: '#/components/schemas/GoogleImage' instanceTypes: type: array items: $ref: '#/components/schemas/GoogleInstanceType' locations: type: array items: type: string warnings: type: array items: type: string zones: type: array items: type: string title: Google Batch platform metainfo GooglePlatformMetainfo.Bucket: type: object properties: path: type: string GooglePlatformMetainfo.Filestore: type: object properties: location: type: string name: type: string target: type: string GoogleSecurityKeys: type: object properties: data: type: string writeOnly: true discriminator: type: string serviceAccountEmail: type: string tokenAudience: type: string workloadIdentityProvider: type: string title: Google credentials GoogleSubnetwork: type: object properties: name: type: string network: type: string region: type: string GpuMetrics: type: object properties: active_time: type: integer format: int64 avg_mem: type: integer format: int64 avg_mem_bw_util: type: number format: double driver: type: string mem: type: integer format: int64 name: type: string pct: type: number format: double pct_mem: type: number format: double peak: type: number format: double peak_mem: type: number format: double peak_mem_bw_util: type: number format: double peak_mem_used: type: integer format: int64 GridPlatformMetainfo: type: object properties: discriminator: description: property to select the platform metainfo type type: string title: Grid platform metainfo IdpGroupEntry: type: object properties: displayName: type: string id: type: integer format: int64 source: $ref: '#/components/schemas/OrgIdpGroupSource' IdpGroupImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' displayName: type: string scimExternalId: type: string source: $ref: '#/components/schemas/OrgIdpGroupSource' required: - auditImageType title: IdP group audit image Image: type: object properties: arch: type: string description: type: string id: type: string name: type: string required: - arch - description - id - name InstanceType: type: object properties: arch: type: string features: description: Capability features advertised for this instance type (e.g. GPU, NVMe). Absent when the data source does not publish features; an empty list means none. type: array items: $ref: '#/components/schemas/Feature' id: type: string required: - arch Iterator_String_: type: object JobCleanupPolicy: type: string enum: - on_success - always - never x-enum-varnames: - on_success - always - never JobInfoDto: type: object properties: exitCode: type: integer format: int32 id: type: integer format: int64 message: type: string operationId: type: string status: type: string JobQueue: type: object properties: name: type: string state: type: string required: - name - state K8sComputeConfig: type: object properties: computeServiceAccount: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 headPodSpec: type: string headServiceAccount: type: string namespace: type: string nextflowConfig: type: string podCleanup: $ref: '#/components/schemas/PodCleanupPolicy' postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string server: type: string servicePodSpec: type: string sslCert: type: string storageClaimName: type: string storageMountPath: type: string workDir: description: Compute environment working directory type: string title: Kubernetes compute configuration K8sPlatformMetaInfo: type: object properties: discriminator: description: property to select the platform metainfo type type: string title: Kubernetes platform metainfo K8sSecurityKeys: type: object properties: certificate: type: string discriminator: type: string privateKey: type: string writeOnly: true token: type: string writeOnly: true title: Kubernetes credentials LabelAssignmentImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' labelId: type: integer format: int64 resourceId: type: string resourceType: type: string required: - auditImageType title: Label assignment audit image LabelDbDto: type: object properties: dateCreated: type: string format: date-time id: type: integer format: int64 isDefault: type: boolean isDynamic: type: boolean isInterpolated: type: boolean name: type: string resource: type: boolean value: type: string LabelImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' dynamic: type: boolean isDefault: type: boolean name: type: string resource: type: boolean value: type: string required: - auditImageType title: Label audit image LabelType: type: string enum: - simple - resource - all x-enum-varnames: - simple - resource - all LaunchActionRequest: type: object properties: params: type: object additionalProperties: type: object LaunchActionResponse: type: object properties: workflowId: type: string LaunchAgentRequest: type: object properties: agentConfigId: type: string nullable: true instructions: type: string triggerContext: type: object additionalProperties: type: object nullable: true LaunchAgentResponse: type: object properties: agentRunId: type: string status: type: string LaunchDbDto: type: object properties: commitId: type: string computeEnv: $ref: '#/components/schemas/ComputeEnv_ComputeConfig_' configProfiles: type: array items: type: string configText: type: string dateCreated: type: string format: date-time entryName: type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 id: type: string lastUpdated: type: string format: date-time launchContainer: type: string mainScript: type: string nextflowVersion: description: Nextflow release version to run this workflow with; must exist in the system catalog and satisfy the minimum configured for the compute environment's type. type: string nullable: true optimizationId: type: string optimizationTargets: type: string outputDir: description: Per-run output directory passed as Nextflow -output-dir (requires Nextflow 24.10.0 or later and workflow outputs syntax). type: string nullable: true paramsText: type: string pipeline: type: string pipelineSchemaId: type: integer format: int64 postRunScript: type: string preRunScript: type: string pullLatest: type: boolean resume: type: boolean resumeLaunchId: type: string revision: type: string runName: type: string schemaName: type: string sessionId: type: string stubRun: type: boolean syntaxParser: type: string enum: - v1 - v2 nullable: true towerConfig: type: string userSecrets: type: array items: type: string workDir: type: string workspaceId: type: integer format: int64 workspaceSecrets: type: array items: type: string LaunchImage: type: object properties: commitId: type: string computeEnvId: type: string configProfiles: type: array items: type: string configText: type: string defaultTemplate: type: boolean entryName: type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 id: type: string launchContainer: type: string mainScript: type: string optimizationId: type: string optimizationTargets: type: string paramsText: type: string pipeline: type: string pipelineSchemaId: type: integer format: int64 postRunScript: type: string preRunScript: type: string pullLatest: type: boolean resume: type: boolean revision: type: string schemaName: type: string sessionId: type: string sourceTemplateId: type: string stubRun: type: boolean towerConfig: type: string userSecrets: type: string versionName: type: string workDir: type: string workspaceSecrets: type: string LaunchValidationError: type: object properties: code: description: Stable machine-readable code identifying the failing check type: string example: COMPUTE_ENV_INVALID message: description: Human-readable explanation of this single blocker type: string LineageRecordResponse: type: object properties: data: type: object additionalProperties: type: object displayData: $ref: '#/components/schemas/DisplayData' lid: type: string recordUri: type: string type: type: string LineageResolveResponse: type: object properties: lid: type: string LinkVersionRequest: type: object properties: hasHeader: type: boolean url: type: string LinkedSourceDto: type: object properties: changeStatus: $ref: '#/components/schemas/ChangeStatus' checkedAt: type: string format: date-time hasChangeIndicators: type: boolean url: type: string ListAccessTokensResponse: type: object properties: tokens: type: array items: $ref: '#/components/schemas/AccessToken' ListActionsResponse: type: object properties: actions: type: array items: $ref: '#/components/schemas/ListActionsResponse.ActionInfo' ListActionsResponse.ActionInfo: type: object properties: config: $ref: '#/components/schemas/Action.ConfigType' dateCreated: type: string format: date-time endpoint: type: string error: type: string event: $ref: '#/components/schemas/Action.EventType' hint: type: string id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' lastSeen: type: string format: date-time name: type: string nextExecution: type: string format: date-time pipeline: type: string source: $ref: '#/components/schemas/Action.Source' status: $ref: '#/components/schemas/Action.Status' usageCmd: type: string ListAgentRunsResponse: type: object properties: agentRuns: type: array items: $ref: '#/components/schemas/AgentRunDbDto' totalSize: type: integer format: int64 ListAgentsResponse: type: object properties: agents: type: array items: $ref: '#/components/schemas/AgentDbDto' totalSize: type: integer format: int64 ListAuditLogV2Response: type: object properties: auditLogs: type: array items: $ref: '#/components/schemas/AuditLogV2ResponseDto' nextPageToken: type: string ListComputeEnvsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/ListComputeEnvsResponse.Entry' ListComputeEnvsResponse.Entry: type: object properties: credentialsId: type: string description: type: string nullable: true fusion2Enabled: type: boolean nullable: true id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' nullable: true lastUsed: type: string format: date-time message: type: string name: type: string platform: type: string primary: type: boolean region: type: string resources: allOf: - $ref: '#/components/schemas/ComputeEnvResources' nullable: true schedEnabled: type: boolean nullable: true status: $ref: '#/components/schemas/ComputeEnv.Status' visibility: type: string waveEnabled: type: boolean nullable: true workDir: type: string workspaceName: type: string ListCredentialsResponse: type: object properties: credentials: type: array items: $ref: '#/components/schemas/Credentials' ListDatasetVersionsResponse: type: object properties: totalSize: type: integer format: int64 versions: type: array items: $ref: '#/components/schemas/DatasetVersionDto' ListDatasetsResponse: type: object properties: datasets: type: array items: $ref: '#/components/schemas/DatasetDto' totalSize: type: integer format: int64 ListEventTypesResponse: type: object properties: eventTypes: type: array items: $ref: '#/components/schemas/EventType' ListIdpGroupsResponse: type: object properties: groups: type: array items: $ref: '#/components/schemas/IdpGroupEntry' ListLabelsResponse: type: object properties: labels: type: array items: $ref: '#/components/schemas/LabelDbDto' totalSize: type: integer format: int64 ListManagedCredentialsRespDto: type: object properties: avatarUrl: type: string firstName: type: string lastName: type: string managedCredentialsId: type: integer format: int64 metadata: $ref: '#/components/schemas/ManagedCredentialsMetadata' provider: type: string enum: - ssh userId: type: integer format: int64 userName: type: string ListManagedCredentialsResponse: type: object properties: managedCredentials: type: array items: $ref: '#/components/schemas/ListManagedCredentialsRespDto' totalSize: type: integer format: int64 ListManagedIdentitiesResponse: type: object properties: managedIdentities: type: array items: $ref: '#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_' totalSize: type: integer format: int64 ListMembersResponse: type: object properties: members: type: array items: $ref: '#/components/schemas/MemberDbDto' totalSize: type: integer format: int64 ListOrganizationsResponse: type: object properties: organizations: type: array items: $ref: '#/components/schemas/OrganizationDbDto' totalSize: type: integer format: int32 ListParticipantsResponse: type: object properties: participants: type: array items: $ref: '#/components/schemas/ParticipantResponseDto' totalSize: type: integer format: int64 ListPipelineInfoResponse: type: object properties: pipelines: type: array items: type: string ListPipelineSecretsResponse: type: object properties: pipelineSecrets: type: array items: $ref: '#/components/schemas/PipelineSecret' totalSize: type: integer format: int64 ListPipelineVersionsResponse: type: object properties: totalSize: type: integer format: int64 versions: type: array items: $ref: '#/components/schemas/PipelineDbDto' ListPipelinesResponse: type: object properties: pipelines: type: array items: $ref: '#/components/schemas/PipelineDbDto' totalSize: type: integer format: int64 ListPlatformsResponse: type: object properties: platforms: type: array items: $ref: '#/components/schemas/ComputePlatform' ListRegionsResponse: type: object properties: regions: type: array items: $ref: '#/components/schemas/ComputeRegion' ListRolePermissionsResponse: type: object properties: permissions: type: array items: $ref: '#/components/schemas/RolePermissionResponseDto' ListRolesResponse: type: object properties: roles: type: array items: $ref: '#/components/schemas/ListRolesResponse.RoleInfo' totalSize: type: integer format: int32 ListRolesResponse.RoleInfo: type: object properties: description: type: string isPredefined: type: boolean name: type: string ListSshKeysResponse: type: object properties: sshKeys: type: array items: $ref: '#/components/schemas/UserSshPublicKeyDto' ListTasksResponse: type: object properties: tasks: type: array items: $ref: '#/components/schemas/DescribeTaskResponse' total: type: integer format: int64 ListTeamResponse: type: object properties: teams: type: array items: $ref: '#/components/schemas/TeamDbDto' totalSize: type: integer format: int64 ListUserRolesResponse: type: object properties: user: $ref: '#/components/schemas/MemberDbDto' userWorkspaces: type: array items: $ref: '#/components/schemas/UserWorkspaceRolesDto' ListWorkflowsResponse: type: object properties: hasMore: type: boolean totalSize: type: integer format: int64 workflows: type: array items: $ref: '#/components/schemas/ListWorkflowsResponse.ListWorkflowsElement' ListWorkflowsResponse.ListWorkflowsElement: type: object properties: labels: type: array items: $ref: '#/components/schemas/LabelDbDto' optimized: type: boolean orgId: type: integer format: int64 orgName: type: string pipelineInfo: $ref: '#/components/schemas/PipelineMinInfoResponse' progress: $ref: '#/components/schemas/ProgressData' starred: type: boolean workflow: $ref: '#/components/schemas/WorkflowDbDto' workspaceId: type: integer format: int64 workspaceName: type: string ListWorkspacesAndOrgResponse: type: object properties: orgsAndWorkspaces: type: array items: $ref: '#/components/schemas/OrgAndWorkspaceDto' ListWorkspacesByTeamResponse: type: object properties: totalSize: type: integer format: int64 workspaces: type: array items: $ref: '#/components/schemas/WorkspaceParticipantResponseDto' ListWorkspacesResponse: type: object properties: workspaces: type: array items: $ref: '#/components/schemas/WorkspaceDbDto' LocalComputeConfig: type: object properties: discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string schedConfig: $ref: '#/components/schemas/SchedConfig' schedEnabled: type: boolean waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Local execution configuration LocalPlatformMetainfo: type: object properties: discriminator: description: property to select the platform metainfo type type: string title: Local platform metainfo LocalSecurityKeys: type: object properties: discriminator: type: string password: type: string writeOnly: true title: Local security keys Log: type: object properties: cmd: type: array items: type: string end_time: type: string exit_code: type: integer format: int32 name: type: string start_time: type: string stderr: type: string stdout: type: string LogPage: type: object properties: downloads: type: array items: $ref: '#/components/schemas/LogPage.Download' entries: $ref: '#/components/schemas/Iterator_String_' forwardToken: type: string message: type: string pending: type: boolean rewindToken: type: string truncated: type: boolean LogPage.Download: type: object properties: displayText: type: string fileName: type: string saveName: type: string LsfComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string perJobMemLimit: type: boolean perTaskReserve: type: boolean port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean unitForLimits: type: string userName: type: string workDir: description: Compute environment working directory type: string title: IBM LSF configuration ManagedCredentialsDbDto: type: object properties: id: type: integer format: int64 ManagedCredentialsImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' credentialsId: type: string managedIdentityId: type: integer format: int64 memberId: type: integer format: int64 metadata: $ref: '#/components/schemas/ManagedCredentialsMetadata' required: - auditImageType title: Managed credentials audit image ManagedCredentialsMetadata: type: object properties: discriminator: type: string readOnly: true ManagedIdentityDbDto_AbstractGridConfig_: type: object properties: config: $ref: '#/components/schemas/AbstractGridConfig' id: type: integer format: int64 name: type: string platform: type: string enum: - altair-platform - lsf-platform - moab-platform - slurm-platform - uge-platform ManagedIdentityImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' config: $ref: '#/components/schemas/ComputeConfig' name: type: string platform: type: string required: - auditImageType title: Managed identity audit image Map.Entry_String.String_: type: object properties: key: type: string value: type: string MemberDbDto: type: object properties: avatar: type: string nullable: true email: type: string firstName: type: string nullable: true lastName: type: string nullable: true memberId: type: integer format: int64 role: $ref: '#/components/schemas/OrgRole' userId: type: integer format: int64 userName: type: string MemberImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' organizationId: type: integer format: int64 role: type: string userId: type: integer format: int64 required: - auditImageType title: Member audit image MoabComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean userName: type: string workDir: description: Compute environment working directory type: string title: Moab configuration MountData: type: object properties: dataLinkId: type: string path: type: string nullable: true MultiRequestFileSchema: type: object properties: file: type: string format: binary NavbarConfig: type: object properties: menus: type: array items: $ref: '#/components/schemas/NavbarConfig.NavbarMenu' nullable: true NavbarConfig.NavbarMenu: type: object properties: label: type: string url: type: string NextflowVersion: type: object properties: default: type: boolean image: type: string imageDind: type: string version: type: string NextflowVersionPolicy: type: object properties: minVersion: type: string selectable: type: boolean NextflowVersionsResponse: type: object properties: nextflowFeatureMinVersions: type: object additionalProperties: type: string nextflowVersionPolicyByComputeEnvType: type: object additionalProperties: $ref: '#/components/schemas/NextflowVersionPolicy' nextflowVersions: type: array items: $ref: '#/components/schemas/NextflowVersion' nextflowVersionSelectionEnabled: type: boolean OAuthConsentImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' scopes: type: string required: - auditImageType title: OAuth consent audit image OrgAndWorkspaceDto: type: object properties: orgId: type: integer format: int64 orgLogoUrl: type: string orgName: type: string orgType: $ref: '#/components/schemas/OrgType' roles: type: array items: type: string visibility: $ref: '#/components/schemas/Visibility' workspaceFullName: type: string workspaceId: type: integer format: int64 workspaceName: type: string OrgIdpGroupSource: type: string enum: - SCIM - MANUAL OrgRole: type: string enum: - owner - member - collaborator x-enum-varnames: - owner - member - collaborator OrgSsoConnectionImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' auth0OrgId: type: string connectionId: type: string connectionName: type: string createdAt: type: string format: date-time createdById: type: integer format: int64 domain: type: string status: type: string ticketUrl: type: string required: - auditImageType title: Org SSO connection audit image OrgType: type: string enum: - academic - evaluating - pro - basic - internal x-enum-varnames: - academic - evaluating - pro - basic - internal Organization: type: object properties: dateCreated: type: string format: date-time readOnly: true description: type: string maxLength: 1000 fullName: type: string maxLength: 100 id: type: integer format: int64 nullable: true readOnly: true lastUpdated: type: string format: date-time readOnly: true location: type: string maxLength: 100 name: type: string maxLength: 40 pattern: ^[a-zA-Z\d](?:[a-zA-Z\d]|[-_](?=[a-zA-Z\d])){1,38}$ website: type: string pattern: '' required: - fullName - name OrganizationDbDto: type: object properties: description: type: string nullable: true fullName: type: string location: type: string nullable: true logoId: type: string nullable: true logoUrl: type: string nullable: true memberId: type: integer format: int64 nullable: true memberRole: allOf: - $ref: '#/components/schemas/OrgRole' nullable: true name: type: string orgId: type: integer format: int64 paying: type: boolean deprecated: true type: $ref: '#/components/schemas/OrgType' website: type: string nullable: true OrganizationImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' description: type: string fullName: type: string location: type: string logoId: type: string name: type: string type: $ref: '#/components/schemas/OrgType' website: type: string required: - auditImageType title: Organization audit image OrganizationQuotas: type: object properties: maxCustomRolesPerOrg: type: integer format: int64 maxDatasetsPerWorkspace: type: integer format: int64 maxDataStudiosRunning: type: integer format: int64 maxFusionThroughputBytes: type: integer format: int64 maxLabelsPerWorkspace: type: integer format: int64 maxMembers: type: integer format: int64 maxParticipantsPerWorkspace: type: integer format: int64 maxPipelinesPerWorkspace: type: integer format: int64 maxRunHistory: type: integer format: int64 maxRuns: type: integer format: int64 maxSeqeraComputeComputeEnvs: type: integer format: int64 maxTeams: type: integer format: int64 maxVersionsPerDataset: type: integer format: int64 maxWorkspaces: type: integer format: int64 ParticipantImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' memberId: type: integer format: int64 role: $ref: '#/components/schemas/WspRole' teamId: type: integer format: int64 userId: type: integer format: int64 workspaceId: type: integer format: int64 wspCustomRoleId: type: integer format: int64 required: - auditImageType title: Participant audit image ParticipantResponseDto: type: object properties: email: type: string firstName: type: string lastName: type: string memberId: type: integer format: int64 orgRole: $ref: '#/components/schemas/OrgRole' participantId: type: integer format: int64 teamAvatarUrl: type: string teamId: type: integer format: int64 teamName: type: string type: $ref: '#/components/schemas/ParticipantType' userAvatarUrl: type: string userName: type: string wspRole: type: string ParticipantType: type: string enum: - MEMBER - TEAM - COLLABORATOR PipelineDbDto: type: object properties: computeEnv: allOf: - $ref: '#/components/schemas/ComputeEnvDbDto' nullable: true deleted: type: boolean description: type: string nullable: true icon: type: string nullable: true labels: type: array items: $ref: '#/components/schemas/LabelDbDto' nullable: true lastUpdated: type: string format: date-time name: type: string optimizationId: type: string nullable: true optimizationStatus: allOf: - $ref: '#/components/schemas/PipelineOptimizationStatus' nullable: true optimizationTargets: type: string nullable: true orgId: type: integer format: int64 nullable: true orgName: type: string nullable: true pipelineId: type: integer format: int64 repository: type: string userFirstName: type: string nullable: true userId: type: integer format: int64 userLastName: type: string nullable: true userName: type: string version: $ref: '#/components/schemas/PipelineVersionFullInfoDto' visibility: type: string nullable: true workspaceId: type: integer format: int64 nullable: true workspaceName: type: string nullable: true PipelineImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' description: type: string icon: type: string launch: $ref: '#/components/schemas/LaunchImage' name: type: string required: - auditImageType title: Pipeline audit image PipelineInfo: type: object properties: cloneUrl: type: string commitId: type: string nullable: true configFiles: type: array items: type: string manifest: $ref: '#/components/schemas/WfManifest' profiles: type: array items: type: string projectName: type: string provider: type: string repositoryUrl: type: string revisionName: type: string nullable: true revisions: type: array items: type: string simpleName: type: string warnings: type: array items: type: string workDirs: type: array items: type: string PipelineListParams.SortBy: type: string enum: - CREATED - MODIFIED - NAME PipelineListParams.SortDir: type: string enum: - ASCENDING - DESCENDING PipelineMinInfoResponse: type: object properties: id: type: integer format: int64 version: $ref: '#/components/schemas/PipelineMinInfoResponse.PipelineVersionMinInfoResponse' workspaceId: type: integer format: int64 PipelineMinInfoResponse.PipelineVersionMinInfoResponse: type: object properties: dateCreated: type: string format: date-time hash: type: string id: type: string isDefault: type: boolean isDraftVersion: type: boolean lastUpdated: type: string format: date-time name: type: string PipelineOptimizationStatus: type: string enum: - OPTIMIZED - OPTIMIZABLE - UNAVAILABLE PipelineQueryAttribute: type: string enum: - optimized - labels - computeEnv x-enum-varnames: - optimized - labels - computeEnv PipelineSchemaAttributes: type: string enum: - schema - params x-enum-varnames: - schema - params PipelineSchemaDbDto: type: object properties: content: type: string id: type: integer format: int64 PipelineSchemaResponse: type: object properties: params: type: string schema: type: string required: - schema PipelineSecret: type: object properties: dateCreated: type: string format: date-time readOnly: true id: type: integer format: int64 nullable: true lastUpdated: type: string format: date-time readOnly: true lastUsed: type: string format: date-time nullable: true readOnly: true name: type: string maxLength: 100 pattern: ^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\1)){1,49}$ required: - name PipelineSecretImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' lastUsed: type: string format: date-time name: type: string salt: type: string required: - auditImageType title: Pipeline secret audit image PipelineVersionFullInfoDto: type: object properties: creatorAvatarUrl: type: string creatorFirstName: type: string creatorLastName: type: string creatorUserId: type: integer format: int64 creatorUserName: type: string dateCreated: type: string format: date-time hash: type: string id: type: string isDefault: type: boolean lastUpdated: type: string format: date-time name: type: string PipelineVersionManageRequest: type: object properties: isDefault: type: boolean name: type: string PlatformMetainfo: type: object properties: discriminator: description: property to select the platform metainfo type type: string discriminator: mapping: aws-batch: '#/components/schemas/AwsBatchPlatformMetainfo' aws-cloud: '#/components/schemas/AwsCloudPlatformMetainfo' azure-batch: '#/components/schemas/AzBatchPlatformMetainfo' azure-cloud: '#/components/schemas/AzCloudPlatformMetaInfo' eks-platform: '#/components/schemas/EksPlatformMetaInfo' gke-platform: '#/components/schemas/GkePlatformMetaInfo' google: '#/components/schemas/GooglePlatformMetainfo' google-cloud: '#/components/schemas/GoogleCloudPlatformMetaInfo' grid: '#/components/schemas/GridPlatformMetainfo' k8s-platform: '#/components/schemas/K8sPlatformMetaInfo' local-platform: '#/components/schemas/LocalPlatformMetainfo' seqeracompute: '#/components/schemas/SeqeraComputePlatformMetainfo' propertyName: discriminator oneOf: - $ref: '#/components/schemas/AwsBatchPlatformMetainfo' - $ref: '#/components/schemas/AwsCloudPlatformMetainfo' - $ref: '#/components/schemas/GooglePlatformMetainfo' - $ref: '#/components/schemas/GoogleCloudPlatformMetaInfo' - $ref: '#/components/schemas/AzBatchPlatformMetainfo' - $ref: '#/components/schemas/AzCloudPlatformMetaInfo' - $ref: '#/components/schemas/EksPlatformMetaInfo' - $ref: '#/components/schemas/GkePlatformMetaInfo' - $ref: '#/components/schemas/K8sPlatformMetaInfo' - $ref: '#/components/schemas/GridPlatformMetainfo' - $ref: '#/components/schemas/SeqeraComputePlatformMetainfo' - $ref: '#/components/schemas/LocalPlatformMetainfo' PodCleanupPolicy: type: string enum: - on_success - always - never x-enum-varnames: - on_success - always - never ProcessLoad: type: object properties: aborted: type: integer format: int64 cached: type: integer format: int64 cpuEfficiency: type: number format: float cpuLoad: type: integer format: int64 deprecated: true cpus: type: integer format: int64 deprecated: true cpuShareMillis: type: integer format: int64 nullable: true cpuShares: type: integer format: int64 nullable: true cpuTime: type: integer format: int64 deprecated: true dateCreated: type: string format: date-time failed: type: integer format: int64 ignored: type: integer format: int64 invCtxSwitch: type: integer format: int64 deprecated: true lastUpdated: type: string format: date-time loadCpus: type: integer format: int64 loadMemory: type: integer format: int64 loadTasks: type: integer format: int64 deprecated: true memoryEfficiency: type: number format: float memoryReq: type: integer format: int64 deprecated: true memoryRss: type: integer format: int64 deprecated: true peakCpus: type: integer format: int64 peakMemory: type: integer format: int64 peakTasks: type: integer format: int64 pending: type: integer format: int64 process: type: string readBytes: type: integer format: int64 deprecated: true retries: type: integer format: int64 running: type: integer format: int64 submitted: type: integer format: int64 succeeded: type: integer format: int64 version: type: integer format: int64 volCtxSwitch: type: integer format: int64 deprecated: true writeBytes: type: integer format: int64 deprecated: true required: - aborted - cached - cpuLoad - cpuTime - cpus - failed - ignored - invCtxSwitch - loadCpus - loadMemory - loadTasks - memoryReq - memoryRss - peakCpus - peakMemory - peakTasks - pending - process - readBytes - retries - running - submitted - succeeded - volCtxSwitch - writeBytes ProgressData: type: object properties: processesProgress: type: array items: $ref: '#/components/schemas/ProcessLoad' totalProcesses: type: integer format: int32 workflowProgress: $ref: '#/components/schemas/WorkflowLoad' RandomWorkflowNameResponse: type: object properties: name: type: string ResourceAllocation: type: object properties: acceleratorCount: type: integer format: int32 acceleratorName: type: string acceleratorType: type: string cpuShares: type: integer format: int32 memoryMiB: type: integer format: int32 time: type: string ResourceData: type: object properties: max: type: number format: float maxLabel: type: string mean: type: number format: float min: type: number format: float minLabel: type: string q1: type: number format: float q1Label: type: string q2: type: number format: float q2Label: type: string q3: type: number format: float q3Label: type: string warnings: type: array items: type: string RoleDto: type: object properties: description: type: string isPredefined: type: boolean name: type: string permissions: type: array items: type: string RolePermissionResponseDto: type: object properties: category: type: string name: type: string RunId: type: object properties: run_id: type: string RunListResponse: type: object properties: next_page_token: type: string runs: type: array items: $ref: '#/components/schemas/RunStatus' RunLog: type: object properties: outputs: type: object request: $ref: '#/components/schemas/RunRequest' run_id: type: string run_log: $ref: '#/components/schemas/Log' state: $ref: '#/components/schemas/State' task_logs: type: array items: $ref: '#/components/schemas/Log' RunRequest: type: object properties: tags: additionalProperties: type: string type: object workflow_engine_parameters: type: object additionalProperties: type: string workflow_params: type: string workflow_type: type: string workflow_type_version: type: string workflow_url: type: string RunStatus: type: object properties: run_id: type: string state: $ref: '#/components/schemas/State' S3SecurityKeys: type: object properties: accessKey: type: string discriminator: type: string pathStyleAccessEnabled: type: boolean secretKey: type: string writeOnly: true title: S3-compatible credentials SSHSecurityKeys: type: object properties: discriminator: type: string passphrase: type: string writeOnly: true privateKey: type: string writeOnly: true title: SSH credentials SchedConfig: type: object properties: backendStrategy: description: Backend used by Intelligent Compute to run tasks. 'ECS' (AWS only, default) delegates task execution to AWS ECS; 'EC2' (AWS only) runs tasks directly on AWS EC2 instances; 'VM' runs tasks on cloud VMs (provider-agnostic). type: string enum: - ECS - EC2 - VM diskAllocation: type: string fusionSnapshots: description: Enable Fusion snapshots so interrupted (e.g. spot-reclaimed) tasks can resume from a snapshot instead of restarting from scratch. type: boolean machineTypes: description: EC2 instance types for compute nodes. Leave empty to automatically select the most cost-effective types for each task. type: array items: type: string maxCpusPerUser: description: Maximum concurrent vCPUs a single user may hold across their runs in this compute environment. null means unlimited. type: integer format: int32 maxSpotAttempts: description: "Maximum number of Spot provisioning attempts for a task, including the first one, before giving up on Spot capacity. 1 means a single attempt with no retry. Only used when the provisioning model is 'spot' or 'spotFirst'. Allowed range: 1-10." type: integer format: int32 nvmeEnabled: description: When true, only use instance types providing local SSD (NVMe) storage. Maps to diskAllocation='nvme'. type: boolean pool: description: Warm-pool configuration. When present and enabled, the scheduler maintains a pool of idle VMs ready to absorb incoming tasks with sub-5s start latency. allOf: - $ref: '#/components/schemas/SchedConfig.Pool' predictionModel: description: "Resource-prediction model used by Intelligent Compute to size tasks. Suggested values: 'none' (default), 'qr/v1', 'qr/v2', 'qr/v3'. Any other string is accepted." type: string provisioningModel: type: string enum: - spot - spotFirst - ondemand SchedConfig.Pool: type: object properties: desiredWarm: description: Target number of idle VMs to keep warm. Bounds total warm-VM cost across all of this CE's pool clusters. type: integer format: int32 enabled: description: Whether the warm pool is active for this CE. When false, the scheduler will not maintain idle VMs. type: boolean scaleToZeroSecs: description: Seconds of inactivity after which the warm pool scales to zero. Set to 0 to never scale to zero. type: integer format: int32 ScimTokenImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' dateCreated: type: string format: date-time lastUsed: type: string format: date-time revokedAt: type: string format: date-time tokenPrefix: type: string required: - auditImageType title: SCIM token audit image SearchResult: type: object properties: nextPageToken: type: string records: type: array items: $ref: '#/components/schemas/LineageRecordResponse' SecurityGroup: type: object properties: id: type: string name: type: string vpcId: type: string SecurityKeys: type: object properties: discriminator: type: string discriminator: mapping: aws: '#/components/schemas/AwsSecurityKeys' azure: '#/components/schemas/AzureSecurityKeys' azure-cloud: '#/components/schemas/AzureCloudKeys' azure_entra: '#/components/schemas/AzureEntraKeys' azurerepos: '#/components/schemas/AzureReposSecurityKeys' bitbucket: '#/components/schemas/BitBucketSecurityKeys' codecommit: '#/components/schemas/CodeCommitSecurityKeys' container-reg: '#/components/schemas/ContainerRegistryKeys' gitea: '#/components/schemas/GiteaSecurityKeys' github: '#/components/schemas/GitHubSecurityKeys' github_app: '#/components/schemas/GitHubAppSecurityKeys' gitlab: '#/components/schemas/GitLabSecurityKeys' google: '#/components/schemas/GoogleSecurityKeys' k8s: '#/components/schemas/K8sSecurityKeys' local: '#/components/schemas/LocalSecurityKeys' s3: '#/components/schemas/S3SecurityKeys' seqeracompute: '#/components/schemas/SeqeraComputeSecurityKeys' ssh: '#/components/schemas/SSHSecurityKeys' tw-agent: '#/components/schemas/AgentSecurityKeys' propertyName: discriminator oneOf: - $ref: '#/components/schemas/AwsSecurityKeys' - $ref: '#/components/schemas/GoogleSecurityKeys' - $ref: '#/components/schemas/GitHubSecurityKeys' - $ref: '#/components/schemas/GitHubAppSecurityKeys' - $ref: '#/components/schemas/GitLabSecurityKeys' - $ref: '#/components/schemas/BitBucketSecurityKeys' - $ref: '#/components/schemas/GiteaSecurityKeys' - $ref: '#/components/schemas/SSHSecurityKeys' - $ref: '#/components/schemas/K8sSecurityKeys' - $ref: '#/components/schemas/AzureSecurityKeys' - $ref: '#/components/schemas/AzureCloudKeys' - $ref: '#/components/schemas/AzureReposSecurityKeys' - $ref: '#/components/schemas/ContainerRegistryKeys' - $ref: '#/components/schemas/AgentSecurityKeys' - $ref: '#/components/schemas/CodeCommitSecurityKeys' - $ref: '#/components/schemas/AzureEntraKeys' - $ref: '#/components/schemas/SeqeraComputeSecurityKeys' - $ref: '#/components/schemas/S3SecurityKeys' - $ref: '#/components/schemas/LocalSecurityKeys' SeqeraComputeCloudInstanceTypeSize: type: string enum: - SMALL - MEDIUM - LARGE SeqeraComputeConfig: type: object properties: defaultDataRetentionPolicy: type: boolean discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' instanceTypeSize: description: Size of the Data Studios instance (SMALL, MEDIUM, LARGE) allOf: - $ref: '#/components/schemas/SeqeraComputeCloudInstanceTypeSize' nextflowConfig: type: string postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string region: type: string workDir: description: Compute environment working directory type: string title: Seqera Compute configuration SeqeraComputePlatformMetainfo: type: object properties: allocStrategy: type: array items: type: string buckets: type: array items: $ref: '#/components/schemas/Bucket' discriminator: description: property to select the platform metainfo type type: string efsFileSystems: type: array items: $ref: '#/components/schemas/EfsFileSystem' fileSystems: type: array items: $ref: '#/components/schemas/FsxFileSystem' images: type: array items: $ref: '#/components/schemas/Image' instanceFamilies: type: array items: type: string instanceTypes: type: array items: $ref: '#/components/schemas/InstanceType' jobQueues: type: array items: $ref: '#/components/schemas/JobQueue' keyPairs: type: array items: type: string securityGroups: type: array items: $ref: '#/components/schemas/SecurityGroup' subnets: type: array items: $ref: '#/components/schemas/Subnet' vpcs: type: array items: $ref: '#/components/schemas/Vpc' warnings: type: array items: type: string title: Seqera Compute platform metainfo SeqeraComputeSecurityKeys: type: object properties: accessKey: type: string nullable: true assumeRoleArn: type: string nullable: true discriminator: type: string externalId: type: string nullable: true mode: $ref: '#/components/schemas/AwsCredentialsMode' secretKey: type: string writeOnly: true title: Seqera Compute credentials ServiceInfo: type: object properties: allowInstanceCredentials: type: boolean allowLocalRepos: type: boolean deprecated: true allowNextflowCliLogs: type: boolean allowSchedRoleCredentials: type: boolean analytics: allOf: - $ref: '#/components/schemas/Analytics' nullable: true apiVersion: type: string authTypes: type: array items: type: string commitId: type: string contactEmail: type: string contentMaxFileSize: type: integer format: int64 contentUrl: type: string creditPurchasesEnabled: type: boolean evalWorkspaceIds: type: array items: format: int64 type: integer nullable: true forgePrefix: type: string groundswellAllowedWorkspaces: type: array items: format: int64 type: integer nullable: true groundswellEnabled: type: boolean heartbeatInterval: type: integer format: int32 landingUrl: type: string nullable: true launchConfigTextMaxSize: type: integer format: int32 launchParamsTextMaxSize: type: integer format: int32 llmEnabled: type: boolean loginPath: type: string logoutUrl: type: string nullable: true navbar: allOf: - $ref: '#/components/schemas/NavbarConfig' nullable: true seqeraAgentBackendUrl: type: string nullable: true seqeraAiBaseUrl: type: string nullable: true seqeraCloud: type: boolean seqeraComputeEnabled: type: boolean termsOfUseUrl: type: string userWorkspaceEnabled: type: boolean version: type: string waveEnabled: type: boolean ServiceInfoResponse: type: object properties: serviceInfo: $ref: '#/components/schemas/ServiceInfo' SlurmComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean userName: type: string workDir: description: Compute environment working directory type: string title: Slurm configuration SourceType: type: string enum: - UPLOADED - LINKED State: type: string enum: - UNKNOWN - QUEUED - INITIALIZING - RUNNING - PAUSED - COMPLETE - EXECUTOR_ERROR - SYSTEM_ERROR - CANCELED - CANCELING StudioCheckpointStatus: type: string enum: - empty - interim - finalized - invalid x-enum-varnames: - empty - interim - finalized - invalid StudioRemoteConfiguration: type: object properties: commitId: type: string nullable: true repository: type: string revision: type: string nullable: true required: - repository StudioSshDetailsDto: description: SSH connection details for a Studio session type: object properties: command: description: The full SSH command to execute type: string example: ssh username@sessionId@host -p port host: description: The hostname to connect to type: string port: description: The SSH port number type: integer format: int32 user: description: The user in the format 'username@sessionId' type: string required: - command - host - port - user SubmitWorkflowLaunchRequest: type: object properties: launch: $ref: '#/components/schemas/WorkflowLaunchRequest' SubmitWorkflowLaunchResponse: type: object properties: workflowId: type: string Subnet: type: object properties: id: type: string vpcId: type: string zone: type: string Task: type: object properties: attempt: type: integer format: int32 cloudZone: type: string complete: type: string format: date-time container: type: string cost: type: number cpus: type: integer format: int32 dateCreated: type: string format: date-time nullable: true disk: type: integer format: int64 duration: type: integer format: int64 env: type: string errorAction: type: string errorMessage: type: string nullable: true executor: type: string exit: type: integer format: int32 exitStatus: type: integer format: int32 gpuMetrics: allOf: - $ref: '#/components/schemas/GpuMetrics' nullable: true hash: type: string id: type: integer format: int64 nullable: true invCtxt: type: integer format: int64 lastUpdated: type: string format: date-time nullable: true logStreamId: type: string machineType: type: string memory: type: integer format: int64 module: type: array items: type: string name: type: string nativeId: type: string numSpotInterruptions: type: integer format: int32 pcpu: type: number format: double peakRss: type: integer format: int64 peakVmem: type: integer format: int64 pmem: type: number format: double priceModel: $ref: '#/components/schemas/CloudPriceModel' process: type: string queue: type: string rchar: type: integer format: int64 readBytes: type: integer format: int64 realtime: type: integer format: int64 resourceAllocation: $ref: '#/components/schemas/ResourceAllocation' rss: type: integer format: int64 scratch: type: string script: type: string start: type: string format: date-time status: $ref: '#/components/schemas/TaskStatus' submit: type: string format: date-time syscr: type: integer format: int64 syscw: type: integer format: int64 tag: type: string taskId: type: integer format: int64 time: type: integer format: int64 vmem: type: integer format: int64 volCtxt: type: integer format: int64 wchar: type: integer format: int64 workdir: type: string writeBytes: type: integer format: int64 required: - status - taskId TaskStatus: type: string enum: - NEW - SUBMITTED - RUNNING - CACHED - COMPLETED - FAILED - ABORTED Team: type: object properties: dateCreated: type: string format: date-time readOnly: true description: type: string maxLength: 250 id: type: integer format: int64 nullable: true readOnly: true lastUpdated: type: string format: date-time readOnly: true name: type: string maxLength: 40 pattern: ^[a-zA-Z\d](?:[a-zA-Z\d]|[-_](?=[a-zA-Z\d])){1,38}$ required: - name TeamDbDto: type: object properties: avatarUrl: type: string nullable: true description: type: string idpGroupId: type: integer format: int64 nullable: true idpGroupName: type: string nullable: true membersCount: type: integer format: int64 name: type: string teamId: type: integer format: int64 TeamImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' avatarId: type: string description: type: string idpGroupId: type: integer format: int64 idpGroupName: type: string name: type: string required: - auditImageType title: Team audit image TeamMemberImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' memberId: type: integer format: int64 teamId: type: integer format: int64 userId: type: integer format: int64 required: - auditImageType title: Team member audit image TeamType: type: string enum: - regular - system_owners x-enum-varnames: - regular - system_owners TraceBeginRequest: type: object properties: launchId: type: string deprecated: true processNames: type: array items: type: string towerLaunch: type: boolean workflow: $ref: '#/components/schemas/Workflow' TraceBeginResponse: type: object properties: status: $ref: '#/components/schemas/TraceProcessingStatus' watchUrl: type: string workflowId: type: string TraceCompleteRequest: type: object properties: metrics: type: array items: $ref: '#/components/schemas/WorkflowMetrics' progress: $ref: '#/components/schemas/TraceProgressData' workflow: $ref: '#/components/schemas/Workflow' TraceCompleteResponse: type: object properties: status: $ref: '#/components/schemas/TraceProcessingStatus' workflowId: type: string TraceCreateMetadata: type: object properties: commitId: type: string nullable: true computeEnvId: type: string nullable: true computeEnvName: type: string nullable: true computeEnvPlatform: type: string nullable: true labels: type: array items: type: string nullable: true orgName: type: string nullable: true pipelineId: type: integer format: int64 nullable: true pipelineName: type: string nullable: true revision: type: string nullable: true userId: type: integer format: int64 userName: type: string userOrganization: type: string nullable: true workspaceFullName: type: string nullable: true workspaceId: type: integer format: int64 nullable: true workspaceName: type: string nullable: true TraceCreateRequest: type: object properties: launchId: type: string deprecated: true projectName: type: string repository: type: string runName: type: string sessionId: type: string workflowId: type: string TraceCreateResponse: type: object properties: message: type: string metadata: allOf: - $ref: '#/components/schemas/TraceCreateMetadata' nullable: true watchUrl: type: string workflowId: type: string TraceHeartbeatRequest: type: object properties: progress: $ref: '#/components/schemas/TraceProgressData' TraceHeartbeatResponse: type: object properties: message: type: string TraceProcessingStatus: type: string enum: - OK - KO TraceProgressData: type: object properties: aborted: type: integer format: int32 cached: type: integer format: int32 failed: type: integer format: int32 ignored: type: integer format: int32 loadCpus: type: integer format: int64 loadMemory: type: integer format: int64 numSpotInterruptions: type: integer format: int32 peakCpus: type: integer format: int64 peakMemory: type: integer format: int64 peakRunning: type: integer format: int32 pending: type: integer format: int32 processes: type: array items: $ref: '#/components/schemas/TraceProgressDetail' retries: type: integer format: int32 running: type: integer format: int32 stored: type: integer format: int32 submitted: type: integer format: int32 succeeded: type: integer format: int32 TraceProgressDetail: type: object properties: aborted: type: integer format: int32 cached: type: integer format: int32 failed: type: integer format: int32 ignored: type: integer format: int32 index: type: integer format: int32 loadCpus: type: integer format: int64 loadMemory: type: integer format: int64 name: type: string peakCpus: type: integer format: int64 peakMemory: type: integer format: int64 peakRunning: type: integer format: int32 pending: type: integer format: int32 retries: type: integer format: int32 running: type: integer format: int32 stored: type: integer format: int32 submitted: type: integer format: int32 succeeded: type: integer format: int32 terminated: type: boolean TraceProgressRequest: type: object properties: containers: type: array items: $ref: '#/components/schemas/ContainerData' progress: $ref: '#/components/schemas/TraceProgressData' tasks: type: array items: $ref: '#/components/schemas/Task' TraceProgressResponse: type: object properties: status: $ref: '#/components/schemas/TraceProcessingStatus' workflowId: type: string UnivaComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobOptions: type: string headQueue: type: string hostName: type: string launchDir: type: string maxQueueSize: type: integer format: int32 nextflowConfig: type: string port: type: integer format: int32 postRunScript: description: Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string preRunScript: description: Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). type: string propagateHeadJobOptions: type: boolean userName: type: string workDir: description: Compute environment working directory type: string title: Univa Grid Engine configuration UpdateActionRequest: type: object properties: bucket: $ref: '#/components/schemas/BucketActionRequest' cron: $ref: '#/components/schemas/CronActionRequest' launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string UpdateAgentRequest: type: object properties: agentInstructions: type: string agentInstructionsTemplateId: type: string nullable: true description: type: string nullable: true name: type: string UpdateAgentResponse: type: object properties: agent: $ref: '#/components/schemas/AgentDbDto' UpdateComputeEnvRequest: type: object properties: credentialsId: type: string description: type: string maxLength: 2000 fusionMetricsCollectionEnabled: type: boolean name: type: string UpdateCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/Credentials' UpdateDatasetRequest: type: object properties: description: type: string name: type: string UpdateLabelRequest: type: object properties: isDefault: type: boolean name: type: string value: type: string UpdateLabelResponse: type: object properties: id: type: integer format: int64 isDefault: type: boolean name: type: string value: type: string UpdateManagedCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/Credentials' metadata: $ref: '#/components/schemas/ManagedCredentialsMetadata' provider: type: string enum: - ssh UpdateManagedIdentityRequest: type: object properties: managedIdentity: $ref: '#/components/schemas/ManagedIdentityDbDto_AbstractGridConfig_' UpdateMemberRoleRequest: type: object properties: role: $ref: '#/components/schemas/OrgRole' UpdateOrganizationRequest: type: object properties: description: type: string fullName: type: string location: type: string logoId: type: string name: type: string paying: type: boolean deprecated: true nullable: true type: allOf: - $ref: '#/components/schemas/OrgType' nullable: true website: type: string UpdateParticipantRoleRequest: type: object properties: role: type: string UpdatePipelineRequest: type: object properties: description: type: string icon: type: string labelIds: type: array items: format: int64 type: integer launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string UpdatePipelineResponse: type: object properties: pipeline: $ref: '#/components/schemas/PipelineDbDto' UpdatePipelineSecretRequest: type: object properties: value: type: string UpdateRoleRequest: type: object properties: description: type: string maxLength: 120 minLength: 1 name: type: string permissions: type: array items: type: string required: - description UpdateTeamRequest: type: object properties: avatarId: type: string description: type: string idpGroupId: type: integer format: int64 nullable: true name: type: string UpdateWorkflowRequest: type: object properties: schedRunId: type: string nullable: true UpdateWorkspaceRequest: type: object properties: description: type: string fullName: type: string name: type: string visibility: $ref: '#/components/schemas/Visibility' UploadDatasetVersionResponse: type: object properties: version: $ref: '#/components/schemas/DatasetVersionDto' UploadEtag: type: object properties: eTag: type: string partNumber: type: integer format: int32 UpsertUserRequest: type: object properties: avatar: type: string avatarId: type: string defaultWorkspaceId: type: integer format: int64 nullable: true description: type: string maxLength: 1000 email: type: string format: email maxLength: 255 firstName: type: string maxLength: 100 lastName: type: string maxLength: 100 notification: type: boolean organization: type: string maxLength: 100 userName: type: string maxLength: 40 waveBuildNotification: allOf: - $ref: '#/components/schemas/WaveBuildNotification' nullable: true required: - email - userName UserImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' auth0Id: type: string authTime: type: string format: date-time avatarId: type: string avatarUrl: type: string description: type: string disabled: type: boolean email: type: string firstName: type: string lastAccess: type: string format: date-time lastName: type: string marketingConsent: type: boolean notification: type: boolean organization: type: string termsOfUseConsent: type: boolean trusted: type: boolean userName: type: string required: - auditImageType title: User audit image UserInfo: type: object properties: avatar: type: string email: type: string id: type: integer format: int64 userName: type: string UserResponseDto: type: object properties: avatar: type: string nullable: true avatarId: type: string nullable: true dateCreated: type: string format: date-time deleted: type: boolean description: type: string nullable: true email: type: string firstName: type: string nullable: true id: type: integer format: int64 lastAccess: type: string format: date-time lastName: type: string nullable: true lastUpdated: type: string format: date-time marketingConsent: type: boolean nullable: true notification: type: boolean nullable: true organization: type: string nullable: true termsOfUseConsent: type: boolean nullable: true userName: type: string waveBuildNotification: allOf: - $ref: '#/components/schemas/WaveBuildNotification' nullable: true UserRoleImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' context: type: string customRoleId: type: integer format: int64 organizationId: type: integer format: int64 role: type: string teamId: type: integer format: int64 userId: type: integer format: int64 workspaceId: type: integer format: int64 required: - auditImageType title: User role audit image UserSshPublicKeyDto: type: object properties: dateCreated: type: string format: date-time id: type: integer format: int64 lastUsed: type: string format: date-time name: type: string publicKey: type: string UserSshPublicKeyImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' keyHash: type: string lastUsed: type: string format: date-time required: - auditImageType title: SSH key audit image UserWorkspacePermissionDto: type: object properties: permission: type: string roles: type: array items: type: string UserWorkspaceRoleDto: type: object properties: role: type: string roleSourceType: $ref: '#/components/schemas/WspRoleSourceType' sourceTeamId: type: integer format: int64 sourceTeamName: type: string sourceTeamType: $ref: '#/components/schemas/TeamType' UserWorkspaceRolesDto: type: object properties: permissions: type: array items: $ref: '#/components/schemas/UserWorkspacePermissionDto' roles: type: array items: $ref: '#/components/schemas/UserWorkspaceRoleDto' workspaceId: type: integer format: int64 workspaceName: type: string ValidateComputeEnvResponse: type: object properties: message: description: 'Human-readable explanation of the outcome: the failure reason when the compute environment is INVALID, the provider-unreachable reason on a transient outcome, or null when the compute environment is AVAILABLE.' type: string nullable: true status: description: 'The compute environment status after the run: AVAILABLE when every applicable check passed, INVALID when a check failed. On a transient outcome this is the unchanged prior status.' allOf: - $ref: '#/components/schemas/ComputeEnv.Status' transientError: description: True when a provider could not be reached (timeout / throttle / 5xx). The persisted status is left unchanged; retry later. type: boolean ValidateCredentialsResponse: type: object properties: message: description: Provider-supplied error detail. Null when the credentials are valid. type: string nullable: true status: description: Validation health resulting from the probe. AVAILABLE = the probe succeeded; INVALID = the provider authoritatively rejected the credentials; on a transient failure this carries the unchanged persisted status. allOf: - $ref: '#/components/schemas/Credentials.Status' transientError: description: True when validation could not reach the provider (network error / 5xx). When true the persisted status is left untouched and MUST NOT be interpreted as an authoritative reject. type: boolean ValidateUrlRequest: type: object properties: url: type: string ValidateUrlResponse: type: object properties: contentLength: type: integer format: int64 errorCode: type: string errorMessage: type: string hasEtag: type: boolean mediaType: type: string valid: type: boolean Visibility: type: string enum: - PRIVATE - SHARED Vpc: type: object properties: id: type: string isDefault: type: boolean WaveBuildNotification: type: string enum: - ALWAYS_ON - ON_ERROR - ALWAYS_OFF WesErrorResponse: type: object properties: msg: type: string status_code: type: integer format: int32 WesServiceInfo: type: object properties: auth_instructions_url: type: string contact_info_url: type: string default_workflow_engine_parameters: type: array items: $ref: '#/components/schemas/DefaultWorkflowEngineParameter' supported_filesystem_protocols: type: array items: type: string supported_wes_versions: type: array items: type: string system_state_counts: type: object additionalProperties: format: int64 type: integer tags: additionalProperties: type: string type: object workflow_engine_versions: type: object additionalProperties: type: string workflow_type_versions: type: object additionalProperties: $ref: '#/components/schemas/WorkflowTypeVersion' WfFusionMeta: type: object properties: enabled: type: boolean version: type: string maxLength: 20 WfManifest: type: object properties: author: type: string maxLength: 150 defaultBranch: type: string maxLength: 20 description: type: string maxLength: 1024 gitmodules: type: string maxLength: 150 homePage: type: string maxLength: 200 icon: type: string maxLength: 255 mainScript: type: string maxLength: 100 name: type: string maxLength: 150 nextflowVersion: type: string maxLength: 20 version: type: string maxLength: 20 WfNextflow: type: object properties: build: type: string maxLength: 10 timestamp: type: string format: date-time version: type: string maxLength: 20 WfSched: type: object properties: enabled: type: boolean WfStats: type: object properties: cachedCount: type: integer format: int32 cachedCountFmt: type: string cachedDuration: type: integer format: int64 cachedPct: type: number format: float computeTimeFmt: type: string maxLength: 50 failedCount: type: integer format: int32 failedCountFmt: type: string failedDuration: type: integer format: int64 failedPct: type: number format: float ignoredCount: type: integer format: int32 ignoredCountFmt: type: string ignoredPct: type: number format: float succeedCount: type: integer format: int32 succeedCountFmt: type: string succeedDuration: type: integer format: int64 succeedPct: type: number format: float WfWaveMeta: type: object properties: enabled: type: boolean Workflow: type: object properties: attributes: allOf: - $ref: '#/components/schemas/WorkflowExtAttributes' readOnly: true commandLine: type: string maxLength: 8096 commitId: type: string maxLength: 40 complete: type: string format: date-time configFiles: type: array items: type: string configText: type: string container: type: string containerEngine: type: string dateCreated: type: string format: date-time nullable: true readOnly: true deleted: type: boolean readOnly: true duration: type: integer format: int64 errorMessage: type: string errorReport: type: string exitStatus: type: integer format: int32 fusion: $ref: '#/components/schemas/WfFusionMeta' homeDir: type: string id: type: string maxLength: 16 lastUpdated: type: string format: date-time nullable: true readOnly: true launchDir: type: string launchId: type: string maxLength: 22 logFile: type: string maxLength: 255 manifest: $ref: '#/components/schemas/WfManifest' nextflow: $ref: '#/components/schemas/WfNextflow' operationId: type: string maxLength: 110 outFile: type: string maxLength: 255 ownerId: type: integer format: int64 readOnly: true params: type: object additionalProperties: type: object profile: type: string maxLength: 100 projectDir: type: string projectName: type: string maxLength: 200 repository: type: string requiresAttention: type: boolean resume: type: boolean revision: type: string maxLength: 100 runName: type: string maxLength: 80 sched: $ref: '#/components/schemas/WfSched' scriptFile: type: string scriptId: type: string maxLength: 40 scriptName: type: string maxLength: 100 sessionId: type: string maxLength: 36 start: type: string format: date-time stats: $ref: '#/components/schemas/WfStats' status: $ref: '#/components/schemas/WorkflowStatus' submit: type: string format: date-time success: type: boolean userName: type: string maxLength: 40 wave: $ref: '#/components/schemas/WfWaveMeta' workDir: type: string required: - commandLine - projectName - runName - sessionId - submit - userName - workDir WorkflowDbDto: type: object properties: commandLine: type: string commitId: type: string complete: type: string format: date-time configFiles: type: array items: type: string configText: type: string container: type: string containerEngine: type: string dateCreated: type: string format: date-time deleted: type: boolean duration: type: integer format: int64 errorMessage: type: string errorReport: type: string exitStatus: type: integer format: int32 homeDir: type: string id: type: string lastUpdated: type: string format: date-time launchDir: type: string launchId: type: string manifest: $ref: '#/components/schemas/WfManifest' nextflow: $ref: '#/components/schemas/WfNextflow' ownerId: type: integer format: int64 params: type: object additionalProperties: type: object profile: type: string projectDir: type: string projectName: type: string repository: type: string requiresAttention: type: boolean resume: type: boolean revision: type: string runName: type: string scriptFile: type: string scriptId: type: string scriptName: type: string sessionId: type: string start: type: string format: date-time stats: $ref: '#/components/schemas/WfStats' status: $ref: '#/components/schemas/WorkflowStatus' submit: type: string format: date-time success: type: boolean userName: type: string workDir: type: string WorkflowExtAttributes: type: object properties: cost: type: number costCurrency: type: string costRetries: type: integer format: int32 empty: type: boolean instancesProvisioned: type: integer format: int32 schedRunId: type: string WorkflowImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' commandLine: type: string commitId: type: string complete: type: string format: date-time configFiles: type: array items: type: string configText: type: string container: type: string containerEngine: type: string duration: type: integer format: int64 errorMessage: type: string errorReport: type: string exitStatus: type: integer format: int32 fusion: $ref: '#/components/schemas/WfFusionMeta' homeDir: type: string launchDir: type: string launchId: type: string logFile: type: string manifest: $ref: '#/components/schemas/WfManifest' nextflow: $ref: '#/components/schemas/WfNextflow' operationId: type: string outFile: type: string params: type: string profile: type: string projectDir: type: string projectName: type: string repository: type: string requiresAttention: type: boolean resume: type: boolean revision: type: string runName: type: string scriptFile: type: string scriptId: type: string scriptName: type: string sessionId: type: string start: type: string format: date-time stats: $ref: '#/components/schemas/WfStats' status: type: string submit: type: string format: date-time success: type: boolean userName: type: string wave: $ref: '#/components/schemas/WfWaveMeta' workDir: type: string required: - auditImageType title: Workflow audit image WorkflowLaunchRequest: type: object properties: commitId: type: string computeEnvId: type: string configProfiles: type: array items: type: string configText: type: string dateCreated: type: string format: date-time entryName: type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 id: type: string labelIds: type: array items: format: int64 type: integer launchContainer: type: string mainScript: type: string nextflowVersion: description: Nextflow release version to run this workflow with; must exist in the system catalog and satisfy the minimum configured for the compute environment's type. type: string nullable: true optimizationId: type: string optimizationTargets: type: string outputDir: description: Per-run output directory passed as Nextflow -output-dir (requires Nextflow 24.10.0 or later and workflow outputs syntax). type: string nullable: true paramsText: type: string pipeline: type: string pipelineSchemaId: type: integer format: int64 postRunScript: type: string preRunScript: type: string pullLatest: type: boolean resume: type: boolean revision: type: string runName: type: string schemaName: type: string sessionId: type: string stubRun: type: boolean syntaxParser: type: string enum: - v1 - v2 nullable: true towerConfig: type: string userSecrets: type: array items: type: string workDir: type: string workspaceSecrets: type: array items: type: string WorkflowLaunchResponse: type: object properties: commitId: type: string computeEnv: $ref: '#/components/schemas/ComputeEnv_ComputeConfig_' configProfiles: type: array items: type: string configText: type: string dateCreated: type: string format: date-time entryName: type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 id: type: string mainScript: type: string nextflowVersion: description: Nextflow release version this workflow was launched with; used to pre-select the same version on relaunch/resume. type: string nullable: true optimizationId: type: string optimizationTargets: type: string outputDir: description: Per-run output directory passed as Nextflow -output-dir (requires Nextflow 24.10.0 or later and workflow outputs syntax). type: string nullable: true paramsText: type: string pipeline: type: string pipelineId: type: integer format: int64 pipelineSchemaId: type: integer format: int64 postRunScript: type: string preRunScript: type: string pullLatest: type: boolean resume: type: boolean resumeCommitId: type: string resumeDir: type: string revision: type: string schemaName: type: string sessionId: type: string stubRun: type: boolean syntaxParser: type: string enum: - v1 - v2 nullable: true towerConfig: type: string userSecrets: type: array items: type: string workDir: type: string workspaceSecrets: type: array items: type: string WorkflowLaunchValidationErrorResponse: type: object properties: errors: description: Every blocker that prevented the launch, in evaluation order; absent on single-failure responses type: array items: $ref: '#/components/schemas/LaunchValidationError' nullable: true message: description: Composed prose listing every blocker — same field as ErrorResponse.message type: string required: - message WorkflowLoad: type: object properties: aborted: type: integer format: int64 cached: type: integer format: int64 cost: type: number cpuEfficiency: type: number format: float cpuLoad: type: integer format: int64 cpus: type: integer format: int64 cpuShareMillis: type: integer format: int64 nullable: true cpuShares: type: integer format: int64 nullable: true cpuTime: type: integer format: int64 dateCreated: type: string format: date-time executors: type: array items: type: string failed: type: integer format: int64 ignored: type: integer format: int64 invCtxSwitch: type: integer format: int64 lastUpdated: type: string format: date-time loadCpus: type: integer format: int64 loadMemory: type: integer format: int64 loadTasks: type: integer format: int64 memoryEfficiency: type: number format: float memoryReq: type: integer format: int64 memoryRss: type: integer format: int64 netCost: type: number netCpuLoad: type: integer format: int64 netCpus: type: integer format: int64 netCpuShareMillis: type: integer format: int64 nullable: true netCpuShares: type: integer format: int64 nullable: true netCpuTime: type: integer format: int64 netInvCtxSwitch: type: integer format: int64 netMemoryConsumption: type: number netMemoryReq: type: integer format: int64 netMemoryRss: type: integer format: int64 netReadBytes: type: integer format: int64 netVolCtxSwitch: type: integer format: int64 netWriteBytes: type: integer format: int64 numSpotInterruptions: type: integer format: int32 peakCpus: type: integer format: int64 peakMemory: type: integer format: int64 peakTasks: type: integer format: int64 pending: type: integer format: int64 readBytes: type: integer format: int64 requestedCpuTime: type: integer format: int64 nullable: true requestedMemory: type: integer format: int64 nullable: true retries: type: integer format: int64 running: type: integer format: int64 submitted: type: integer format: int64 succeeded: type: integer format: int64 version: type: integer format: int64 volCtxSwitch: type: integer format: int64 writeBytes: type: integer format: int64 required: - aborted - cached - cpuLoad - cpuTime - cpus - failed - ignored - invCtxSwitch - loadCpus - loadMemory - loadTasks - memoryReq - memoryRss - peakCpus - peakMemory - peakTasks - pending - readBytes - retries - running - submitted - succeeded - volCtxSwitch - writeBytes WorkflowLogResponse: type: object properties: log: $ref: '#/components/schemas/LogPage' WorkflowMaxDbDto: type: object allOf: - $ref: '#/components/schemas/WorkflowDbDto' - properties: configProfiles: type: array items: type: string nullable: true fusion: $ref: '#/components/schemas/WfFusionMeta' logFile: type: string nextflowConfig: type: string nullable: true nextflowVersion: type: string nullable: true operationId: type: string outFile: type: string postRunScript: type: string nullable: true preRunScript: type: string nullable: true syntaxParser: type: string nullable: true towerConfig: type: string nullable: true wave: $ref: '#/components/schemas/WfWaveMeta' type: object WorkflowMetrics: type: object properties: cpu: $ref: '#/components/schemas/ResourceData' cpuUsage: $ref: '#/components/schemas/ResourceData' gpuMemAvg: $ref: '#/components/schemas/ResourceData' gpuMemPeak: $ref: '#/components/schemas/ResourceData' gpuUsage: $ref: '#/components/schemas/ResourceData' id: type: integer format: int64 nullable: true mem: $ref: '#/components/schemas/ResourceData' memUsage: $ref: '#/components/schemas/ResourceData' process: type: string maxLength: 255 reads: $ref: '#/components/schemas/ResourceData' time: $ref: '#/components/schemas/ResourceData' timeUsage: $ref: '#/components/schemas/ResourceData' vmem: $ref: '#/components/schemas/ResourceData' writes: $ref: '#/components/schemas/ResourceData' required: - process WorkflowQueryAttribute: type: string enum: - optimized - labels - messages - minimal - pipelineInfo x-enum-varnames: - optimized - labels - messages - minimal - pipelineInfo WorkflowStatus: type: string enum: - SUBMITTED - RUNNING - SUCCEEDED - FAILED - CANCELLED - UNKNOWN WorkflowTypeVersion: type: object properties: workflow_type_version: type: array items: type: string Workspace: type: object properties: dateCreated: type: string format: date-time description: type: string maxLength: 1000 fullName: type: string maxLength: 100 id: type: integer format: int64 nullable: true lastUpdated: type: string format: date-time name: type: string maxLength: 40 pattern: ^[a-zA-Z\d](?:[a-zA-Z\d]|[-_](?=[a-zA-Z\d])){1,38}$ visibility: $ref: '#/components/schemas/Visibility' required: - fullName - name - visibility WorkspaceDbDto: type: object properties: description: type: string nullable: true fullName: type: string id: type: integer format: int64 name: type: string visibility: $ref: '#/components/schemas/Visibility' WorkspaceImage: type: object properties: auditImageType: $ref: '#/components/schemas/AuditImageType' description: type: string fullName: type: string name: type: string visibility: $ref: '#/components/schemas/Visibility' required: - auditImageType title: Workspace audit image WorkspaceParticipantResponseDto: type: object properties: orgId: type: integer format: int64 orgName: type: string participantId: type: integer format: int64 participantRole: type: string workspaceFullName: type: string workspaceId: type: integer format: int64 workspaceName: type: string WspRole: type: string enum: - owner - admin - maintain - launch - connect - view x-enum-varnames: - owner - admin - maintain - launch - connect - view WspRoleSourceType: type: string enum: - individual - team x-enum-varnames: - individual - team securitySchemes: BearerAuth: bearerFormat: jwt scheme: bearer type: http