openapi: 3.0.1 info: contact: email: info@seqera.io url: https://seqera.io description: | The Seqera Platform Terraform Provider enables infrastructure-as-code management of Seqera Platform resources. This provider allows you to programmatically create, configure, and manage organizations, workspaces, compute environments, pipelines, credentials, and other Seqera Platform components using Terraform. title: Seqera API version: 1.159.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: 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Action#create /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Action#delete 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Action#read 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Action#update /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 /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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ComputeEnv#create x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 # 5 seconds maxInterval: 5000 # 5 seconds (fixed interval) maxElapsedTime: 30000 # 30 seconds exponent: 1.0 # No exponential backoff, fixed interval statusCodes: - 429 # Rate limiting - should retry - 500 # Internal server error - 502 # Bad gateway - 503 # Service unavailable - 504 # Gateway timeout /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ComputeEnv#delete 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 required: true - 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ComputeEnv#read 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ComputeEnv#update /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: | Designates a compute environment as the primary (default) compute environment for a workspace. The primary compute environment is used by default when launching workflows in the workspace. parameters: - name: computeEnvId in: path description: Compute environment string identifier to designate as primary required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier where the compute environment will be set as primary schema: type: integer format: int64 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: PrimaryComputeEnv#create /credentials: get: operationId: ListCredentialsDataSource summary: List credentials description: | Lists all credentials accessible to the authenticated user. Use `workspace_id` to filter credentials in a specific workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier to filter credentials required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListCredentialsDataSourceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] - BearerAuth: [] tags: - credentials - credentials x-speakeasy-entity-operation: terraform-datasource: Credentials#read x-speakeasy-name-override: ListCredentials 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Credential#create /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Credential#delete 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Credential#read 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 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Credential#update /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 /data-links: get: operationId: ListDataLinksDataSource summary: List data links description: | Lists all data links accessible to the authenticated user. Use `workspace_id` to filter data links in a specific workspace context. parameters: - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 - name: workspaceId in: query description: Workspace numeric identifier to filter data links required: false schema: type: integer format: int64 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDataLinksDataSourceResponse' '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ListDataLinksDataSourceResponse' '400': description: Bad request 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: [] - BearerAuth: [] tags: - data-links - data-links x-speakeasy-entity-operation: terraform-datasource: DataLinks#read x-speakeasy-name-override: ListDataLinks 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: DataLink#create /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: DataLink#delete 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: DataLink#read 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: DataLink#update /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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Datasets#create /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Dataset#delete 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Dataset#update /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Dataset#read /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 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 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 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 nullable: true - 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Labels#read 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Labels#create /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 x-speakeasy-param-readonly: true - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Labels#delete 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 x-speakeasy-param-readonly: true - name: workspaceId in: query description: Workspace numeric identifier schema: type: integer format: int64 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Labels#update /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 /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Orgs#create /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 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Orgs#delete 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 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Orgs#read 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 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Orgs#update /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}/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}/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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: false 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Teams#create /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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Teams#delete 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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Teams#read 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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Teams#update /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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true 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 x-speakeasy-param-optional: true - name: teamId in: path description: Team numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 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 x-speakeasy-param-optional: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workspaces#read 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 x-speakeasy-param-optional: false 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workspace#create /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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-name-override: id 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workspace#delete 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 x-speakeasy-param-optional: true - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-name-override: id 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workspace#read 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 x-speakeasy-param-optional: true - name: workspaceId in: path description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-name-override: id 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workspace#update /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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 x-speakeasy-param-optional: true - 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 where the secret will be stored schema: type: integer format: int64 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: PipelineSecret#create /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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: PipelineSecret#delete 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: PipelineSecret#read 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: PipelineSecret#update /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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Pipeline#create /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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Pipeline#delete 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 required: true - 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Pipeline#read#1 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 required: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Pipeline#update /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Pipeline#read#2 /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`.\n `200 - OK` responses include the pipeline schema.\n `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID.\n " 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`. \n **Note**: If `labelIds` is `null`, empty, or omitted, existing pipeline labels are removed.\n Include `labelIds: [,]` to override existing labels. Labels to be preserved must be included.\n 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 /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 required: true x-speakeasy-param-force-new: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CustomRole#create /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 x-speakeasy-match: name - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 required: true x-speakeasy-param-force-new: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CustomRole#delete 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 x-speakeasy-match: name - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 required: true x-speakeasy-param-force-new: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CustomRole#read 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 x-speakeasy-match: name - name: orgId in: query description: Numeric identifier of the organization schema: type: integer format: int64 required: true x-speakeasy-param-force-new: true 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CustomRole#update /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Studios#create x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 # 5 seconds maxInterval: 5000 # 5 seconds (fixed interval) maxElapsedTime: 30000 # 30 seconds exponent: 1.0 # No exponential backoff, fixed interval statusCodes: - 400 /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 x-speakeasy-param-optional: true - 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Studios#delete x-speakeasy-retries: strategy: backoff backoff: initialInterval: 3000 maxInterval: 10000 maxElapsedTime: 30000 exponent: 1.5 statusCodes: - 400 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 x-speakeasy-param-optional: true - 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Studios#read 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}/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 # Disable data source generation - tokens list is for internal resource use only x-speakeasy-entity-operation: terraform-resource: Tokens#read terraform-datasource: null 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 x-speakeasy-entity-operation: Tokens#create /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 x-speakeasy-match: id 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 x-speakeasy-entity-operation: Tokens#delete /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: UserWorkspaces#read /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: User#read 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 required: true - 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 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed security: - BearerAuth: [] tags: - workflows x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workflows#create x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 # 5 seconds maxInterval: 5000 # 5 seconds (fixed interval) maxElapsedTime: 30000 # 30 seconds exponent: 1.0 # No exponential backoff, fixed interval statusCodes: - 400 /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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workflows#delete 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 x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: Workflows#read /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 x-speakeasy-group: WorkflowStar 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 x-speakeasy-group: WorkflowStar 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 x-speakeasy-group: WorkflowStar /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 "/compute-envs#aws-compute-env": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSComputeEnv#create x-speakeasy-name-override: CreateAWSComputeEnv summary: Create AWS compute environment description: Creates a new AWS compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateAWSComputeEnv parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: AWS compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateAWSComputeEnvRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateAWSComputeEnvResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#aws-compute-env": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSComputeEnv#read x-speakeasy-name-override: DescribeAWSComputeEnv summary: Describe AWS compute environment description: Retrieves the details of the AWS compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeAWSComputeEnv parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeAWSComputeEnvResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSComputeEnv#update x-speakeasy-name-override: UpdateAWSComputeEnv summary: Update AWS compute environment description: Updates name, description, or credentials of the AWS compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateAWSComputeEnv parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSComputeEnv#delete x-speakeasy-name-override: DeleteAWSComputeEnv summary: Delete AWS compute environment description: Deletes the AWS compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteAWSComputeEnv parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#aws": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSBatchCE#create x-speakeasy-name-override: CreateAWSBatchCE summary: Create AWS compute environment description: Creates a new AWS compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateAWSBatchCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: AWS compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateAWSBatchCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateAWSBatchCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#aws": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSBatchCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeAWSBatchCE summary: Describe AWS compute environment description: Retrieves the details of the AWS compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeAWSBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeAWSBatchCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSBatchCE#update x-speakeasy-name-override: UpdateAWSBatchCE summary: Update AWS Batch compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateAWSBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSBatchCE#delete x-speakeasy-name-override: DeleteAWSBatchCE summary: Delete AWS compute environment description: Deletes the AWS compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteAWSBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#aws-cloud": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AwsCloudCE#create x-speakeasy-name-override: CreateAwsCloudCE summary: Create AWS Cloud compute environment description: Creates a new AWS Cloud compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateAwsCloudCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: AWS Cloud compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateAwsCloudCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateAwsCloudCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#aws-cloud": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AwsCloudCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeAwsCloudCE summary: Describe AWS Cloud compute environment description: Retrieves the details of the AWS Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeAwsCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeAwsCloudCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AwsCloudCE#update x-speakeasy-name-override: UpdateAwsCloudCE summary: Update AWS Cloud compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateAwsCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AwsCloudCE#delete x-speakeasy-name-override: DeleteAwsCloudCE summary: Delete AWS Cloud compute environment description: Deletes the AWS Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteAwsCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#azure-batch": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureBatchCE#create x-speakeasy-name-override: CreateAzureBatchCE summary: Create Azure Batch compute environment description: Creates a new Azure Batch compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateAzureBatchCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: Azure Batch compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateAzureBatchCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateAzureBatchCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#azure-batch": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureBatchCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeAzureBatchCE summary: Describe Azure Batch compute environment description: Retrieves the details of the Azure Batch compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeAzureBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeAzureBatchCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureBatchCE#update x-speakeasy-name-override: UpdateAzureBatchCE summary: Update Azure Batch compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateAzureBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureBatchCE#delete x-speakeasy-name-override: DeleteAzureBatchCE summary: Delete Azure Batch compute environment description: Deletes the Azure Batch compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteAzureBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#azure-cloud": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCE#create x-speakeasy-name-override: CreateAzureCloudCE summary: Create Azure Cloud compute environment description: Creates a new Azure Cloud compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateAzureCloudCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: Azure Cloud compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateAzureCloudCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateAzureCloudCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#azure-cloud": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeAzureCloudCE summary: Describe Azure Cloud compute environment description: Retrieves the details of the Azure Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeAzureCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeAzureCloudCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCE#update x-speakeasy-name-override: UpdateAzureCloudCE summary: Update Azure Cloud compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateAzureCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCE#delete x-speakeasy-name-override: DeleteAzureCloudCE summary: Delete Azure Cloud compute environment description: Deletes the Azure Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteAzureCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#gcp-batch": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPBatchCE#create x-speakeasy-name-override: CreateGCPBatchCE summary: Create GCP Batch compute environment description: Creates a new Google Cloud Batch compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateGCPBatchCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: GCP Batch compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateGCPBatchCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateGCPBatchCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#gcp-batch": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPBatchCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeGCPBatchCE summary: Describe GCP Batch compute environment description: Retrieves the details of the Google Cloud Batch compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeGCPBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeGCPBatchCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPBatchCE#update x-speakeasy-name-override: UpdateGCPBatchCE summary: Update GCP Batch compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateGCPBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPBatchCE#delete x-speakeasy-name-override: DeleteGCPBatchCE summary: Delete GCP Batch compute environment description: Deletes the Google Cloud Batch compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteGCPBatchCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#gcp-cloud": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPCloudCE#create x-speakeasy-name-override: CreateGCPCloudCE summary: Create GCP Cloud compute environment description: Creates a new Google Cloud compute environment. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateGCPCloudCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: GCP Cloud compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateGCPCloudCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateGCPCloudCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#gcp-cloud": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPCloudCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeGCPCloudCE summary: Describe GCP Cloud compute environment description: Retrieves the details of the Google Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeGCPCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeGCPCloudCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPCloudCE#update x-speakeasy-name-override: UpdateGCPCloudCE summary: Update GCP Cloud compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateGCPCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GCPCloudCE#delete x-speakeasy-name-override: DeleteGCPCloudCE summary: Delete GCP Cloud compute environment description: Deletes the Google Cloud compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteGCPCloudCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] "/compute-envs#seqeracompute": post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ManagedComputeCE#create x-speakeasy-name-override: CreateManagedComputeCE summary: Create Seqera Compute compute environment description: | Creates a new Seqera Compute compute environment. Seqera Compute is a fully managed compute service that handles infrastructure provisioning automatically. Append `?workspaceId` to create the environment in a workspace context. x-speakeasy-retries: strategy: backoff backoff: initialInterval: 5000 maxInterval: 5000 maxElapsedTime: 30000 exponent: 1.0 statusCodes: - 429 - 500 - 502 - 503 - 504 tags: - compute-envs operationId: CreateManagedComputeCE parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true requestBody: description: Seqera Compute compute environment create request content: application/json: schema: $ref: "#/components/schemas/CreateManagedComputeCERequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateManagedComputeCEResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] "/compute-envs/{computeEnvId}#seqeracompute": get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ManagedComputeCE#read # 400/404 = soft-deleted/missing CE; 403 stays a real error so auth issues remain visible. x-speakeasy-entity-missing-codes: - 400 - 404 x-speakeasy-name-override: DescribeManagedComputeCE summary: Describe Seqera Compute compute environment description: Retrieves the details of the Seqera Compute compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DescribeManagedComputeCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 required: true - 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/DescribeManagedComputeCEResponse" "400": description: Bad request 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" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ManagedComputeCE#update x-speakeasy-name-override: UpdateManagedComputeCE summary: Update Seqera Compute compute environment description: Updates name, description, or credentials of the compute environment identified by the given `computeEnvId`. Other fields require resource replacement. tags: - compute-envs operationId: UpdateManagedComputeCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ManagedComputeCE#delete x-speakeasy-name-override: DeleteManagedComputeCE summary: Delete Seqera Compute compute environment description: Deletes the Seqera Compute compute environment identified by the given `computeEnvId`. tags: - compute-envs operationId: DeleteManagedComputeCE parameters: - name: computeEnvId in: path description: Compute environment string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#aws: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSCredential#create#1 x-speakeasy-name-override: CreateAWSCredentials summary: Create AWS credentials description: Creates new AWS credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateAWSCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true - name: useExternalId in: query description: Generate External ID for AWS credentials (requires IAM Role ARN) schema: type: boolean requestBody: description: AWS credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateAWSCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAWSCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#aws: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: - AWSCredential#read - AWSCredential#create#2 x-speakeasy-name-override: DescribeAWSCredentials summary: Describe AWS credentials description: Retrieves the details of the AWS credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeAWSCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeAWSCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSCredential#update x-speakeasy-name-override: UpdateAWSCredentials summary: Update AWS credentials description: Updates the details of the AWS credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateAWSCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true 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: AWS credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateAWSCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AWSCredential#delete x-speakeasy-name-override: DeleteAWSCredentials summary: Delete AWS credentials description: Deletes the AWS credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteAWSCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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 '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] /credentials#azure: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCredential#create x-speakeasy-name-override: CreateAzureCredentials summary: Create Azure credentials description: Creates new Azure credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateAzureCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Azure credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateAzureCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAzureCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#azure: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCredential#read x-speakeasy-name-override: DescribeAzureCredentials summary: Describe Azure credentials description: Retrieves the details of the Azure credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeAzureCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeAzureCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCredential#update x-speakeasy-name-override: UpdateAzureCredentials summary: Update Azure credentials description: Updates the details of the Azure credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateAzureCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Azure credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateAzureCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCredential#delete x-speakeasy-name-override: DeleteAzureCredentials summary: Delete Azure credentials description: Deletes the Azure credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteAzureCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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 '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] /credentials#azure-entra: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureEntraCredential#create x-speakeasy-name-override: CreateAzureEntraCredentials summary: Create Azure Entra credentials description: Creates new Azure Batch credentials authenticating via an Entra service principal in a workspace. tags: - credentials operationId: CreateAzureEntraCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Azure Entra credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateAzureEntraCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAzureEntraCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#azure-entra: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureEntraCredential#read x-speakeasy-name-override: DescribeAzureEntraCredentials summary: Describe Azure Entra credentials description: Retrieves the details of the Azure Entra credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeAzureEntraCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeAzureEntraCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureEntraCredential#update x-speakeasy-name-override: UpdateAzureEntraCredentials summary: Update Azure Entra credentials description: Updates the details of the Azure Entra credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateAzureEntraCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Azure Entra credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateAzureEntraCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureEntraCredential#delete x-speakeasy-name-override: DeleteAzureEntraCredentials summary: Delete Azure Entra credentials description: Deletes the Azure Entra credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteAzureEntraCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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 '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] /credentials#azure-cloud: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCredential#create x-speakeasy-name-override: CreateAzureCloudCredentials summary: Create Azure Cloud credentials description: Creates new Azure Cloud (SingleVM) credentials authenticating via an Entra service principal in a workspace. tags: - credentials operationId: CreateAzureCloudCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Azure Cloud credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateAzureCloudCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateAzureCloudCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#azure-cloud: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCredential#read x-speakeasy-name-override: DescribeAzureCloudCredentials summary: Describe Azure Cloud credentials description: Retrieves the details of the Azure Cloud credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeAzureCloudCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeAzureCloudCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCredential#update x-speakeasy-name-override: UpdateAzureCloudCredentials summary: Update Azure Cloud credentials description: Updates the details of the Azure Cloud credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateAzureCloudCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Azure Cloud credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateAzureCloudCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: AzureCloudCredential#delete x-speakeasy-name-override: DeleteAzureCloudCredentials summary: Delete Azure Cloud credentials description: Deletes the Azure Cloud credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteAzureCloudCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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 '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] /credentials#bitbucket: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: BitbucketCredential#create x-speakeasy-name-override: CreateBitbucketCredentials summary: Create Bitbucket credentials description: Creates new Bitbucket credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateBitbucketCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Bitbucket credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateBitbucketCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateBitbucketCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#bitbucket: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: BitbucketCredential#read x-speakeasy-name-override: DescribeBitbucketCredentials summary: Describe Bitbucket credentials description: Retrieves the details of the Bitbucket credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeBitbucketCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeBitbucketCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: BitbucketCredential#update x-speakeasy-name-override: UpdateBitbucketCredentials summary: Update Bitbucket credentials description: Updates the details of the Bitbucket credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateBitbucketCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Bitbucket credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateBitbucketCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: BitbucketCredential#delete x-speakeasy-name-override: DeleteBitbucketCredentials summary: Delete Bitbucket credentials description: Deletes the Bitbucket credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteBitbucketCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#codecommit: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CodecommitCredential#create#1 x-speakeasy-name-override: CreateCodecommitCredentials summary: Create Codecommit credentials description: Creates new Codecommit credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateCodecommitCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Codecommit credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateCodecommitCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateCodecommitCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#codecommit: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: - CodecommitCredential#read - CodecommitCredential#create#2 x-speakeasy-name-override: DescribeCodecommitCredentials summary: Describe Codecommit credentials description: Retrieves the details of the Codecommit credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeCodecommitCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeCodecommitCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CodecommitCredential#update x-speakeasy-name-override: UpdateCodecommitCredentials summary: Update Codecommit credentials description: Updates the details of the Codecommit credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateCodecommitCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Codecommit credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateCodecommitCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: CodecommitCredential#delete x-speakeasy-name-override: DeleteCodecommitCredentials summary: Delete Codecommit credentials description: Deletes the Codecommit credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteCodecommitCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#container-registry: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ContainerRegistryCredential#create x-speakeasy-name-override: CreateContainerRegistryCredentials summary: Create container registry credentials description: Creates new container registry credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateContainerRegistryCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Container registry credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateContainerRegistryCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateContainerRegistryCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#container-registry: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ContainerRegistryCredential#read x-speakeasy-name-override: DescribeContainerRegistryCredentials summary: Describe container registry credentials description: Retrieves the details of the container registry credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeContainerRegistryCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeContainerRegistryCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ContainerRegistryCredential#update x-speakeasy-name-override: UpdateContainerRegistryCredentials summary: Update container registry credentials description: Updates the details of the container registry credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateContainerRegistryCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Container registry credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateContainerRegistryCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: ContainerRegistryCredential#delete x-speakeasy-name-override: DeleteContainerRegistryCredentials summary: Delete container registry credentials description: Deletes the container registry credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteContainerRegistryCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#google: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GoogleCredential#create#1 x-speakeasy-name-override: CreateGoogleCredentials summary: Create Google credentials description: Creates new Google credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateGoogleCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier where the credentials will be stored required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Google credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateGoogleCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateGoogleCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#google: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: - GoogleCredential#read - GoogleCredential#create#2 x-speakeasy-name-override: DescribeGoogleCredentials summary: Describe Google credentials description: Retrieves the details of the Google credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeGoogleCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeGoogleCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GoogleCredential#update x-speakeasy-name-override: UpdateGoogleCredentials summary: Update Google credentials description: Updates the details of the Google credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateGoogleCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Google credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateGoogleCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GoogleCredential#delete x-speakeasy-name-override: DeleteGoogleCredentials summary: Delete Google credentials description: Deletes the Google credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteGoogleCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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 '409': description: Running jobs block the deletion of this credentials content: application/json: schema: $ref: '#/components/schemas/DeleteCredentialsConflictResponse' security: - BearerAuth: [] /credentials#gitea: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GiteaCredential#create x-speakeasy-name-override: CreateGiteaCredentials summary: Create Gitea credentials description: Creates new Gitea credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateGiteaCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Gitea credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateGiteaCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateGiteaCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#gitea: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GiteaCredential#read x-speakeasy-name-override: DescribeGiteaCredentials summary: Describe Gitea credentials description: Retrieves the details of the Gitea credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeGiteaCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeGiteaCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GiteaCredential#update x-speakeasy-name-override: UpdateGiteaCredentials summary: Update Gitea credentials description: Updates the details of the Gitea credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateGiteaCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Gitea credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateGiteaCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GiteaCredential#delete x-speakeasy-name-override: DeleteGiteaCredentials summary: Delete Gitea credentials description: Deletes the Gitea credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteGiteaCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#github: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubCredential#create x-speakeasy-name-override: CreateGithubCredentials summary: Create GitHub credentials description: Creates new GitHub credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateGithubCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: GitHub credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateGithubCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateGithubCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#github: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubCredential#read x-speakeasy-name-override: DescribeGithubCredentials summary: Describe GitHub credentials description: Retrieves the details of the GitHub credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeGithubCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeGithubCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubCredential#update x-speakeasy-name-override: UpdateGithubCredentials summary: Update GitHub credentials description: Updates the details of the GitHub credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateGithubCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: GitHub credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateGithubCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubCredential#delete x-speakeasy-name-override: DeleteGithubCredentials summary: Delete GitHub credentials description: Deletes the GitHub credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteGithubCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#github_app: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubAppCredential#create x-speakeasy-name-override: CreateGithubAppCredentials summary: Create GitHub App credentials description: Creates new GitHub App credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateGithubAppCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: GitHub App credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateGithubAppCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateGithubAppCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#github_app: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubAppCredential#read x-speakeasy-name-override: DescribeGithubAppCredentials summary: Describe GitHub App credentials description: Retrieves the details of the GitHub App credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeGithubAppCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeGithubAppCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubAppCredential#update x-speakeasy-name-override: UpdateGithubAppCredentials summary: Update GitHub App credentials description: Updates the details of the GitHub App credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateGithubAppCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: GitHub App credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateGithubAppCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GithubAppCredential#delete x-speakeasy-name-override: DeleteGithubAppCredentials summary: Delete GitHub App credentials description: Deletes the GitHub App credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteGithubAppCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#gitlab: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GitlabCredential#create x-speakeasy-name-override: CreateGitlabCredentials summary: Create GitLab credentials description: Creates new GitLab credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateGitlabCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: GitLab credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateGitlabCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateGitlabCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#gitlab: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GitlabCredential#read x-speakeasy-name-override: DescribeGitlabCredentials summary: Describe GitLab credentials description: Retrieves the details of the GitLab credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeGitlabCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeGitlabCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GitlabCredential#update x-speakeasy-name-override: UpdateGitlabCredentials summary: Update GitLab credentials description: Updates the details of the GitLab credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateGitlabCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: GitLab credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateGitlabCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: GitlabCredential#delete x-speakeasy-name-override: DeleteGitlabCredentials summary: Delete GitLab credentials description: Deletes the GitLab credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteGitlabCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#k8s: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: KubernetesCredential#create x-speakeasy-name-override: CreateKubernetesCredentials summary: Create Kubernetes credentials description: Creates new Kubernetes credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateKubernetesCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Kubernetes credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateKubernetesCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateKubernetesCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#k8s: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: KubernetesCredential#read x-speakeasy-name-override: DescribeKubernetesCredentials summary: Describe Kubernetes credentials description: Retrieves the details of the Kubernetes credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeKubernetesCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeKubernetesCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: KubernetesCredential#update x-speakeasy-name-override: UpdateKubernetesCredentials summary: Update Kubernetes credentials description: Updates the details of the Kubernetes credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateKubernetesCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Kubernetes credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateKubernetesCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: KubernetesCredential#delete x-speakeasy-name-override: DeleteKubernetesCredentials summary: Delete Kubernetes credentials description: Deletes the Kubernetes credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteKubernetesCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#ssh: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: SSHCredential#create x-speakeasy-name-override: CreateSSHCredentials summary: Create SSH credentials description: Creates new SSH credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateSSHCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: SSH credentials create request content: application/json: schema: $ref: '#/components/schemas/CreateSSHCredentialsRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSSHCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '409': description: Conflict - resource already exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] /credentials/{credentialsId}#ssh: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: SSHCredential#read x-speakeasy-name-override: DescribeSSHCredentials summary: Describe SSH credentials description: Retrieves the details of the SSH credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeSSHCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeSSHCredentialsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Operation not allowed '404': description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: SSHCredential#update x-speakeasy-name-override: UpdateSSHCredentials summary: Update SSH credentials description: Updates the details of the SSH credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateSSHCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: SSH credentials update request content: application/json: schema: $ref: '#/components/schemas/UpdateSSHCredentialsRequest' required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: SSHCredential#delete x-speakeasy-name-override: DeleteSSHCredentials summary: Delete SSH credentials description: Deletes the SSH credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteSSHCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] /credentials#agent: post: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: TowerAgentCredential#create#1 x-speakeasy-name-override: CreateTowerAgentCredentials summary: Create Tower Agent credentials description: Creates new Tower Agent credentials in a user context. Append `?workspaceId` to create the credentials in a workspace context. tags: - credentials operationId: CreateTowerAgentCredentials parameters: - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 x-speakeasy-param-force-new: true requestBody: description: Tower Agent credentials create request content: application/json: schema: $ref: "#/components/schemas/CreateTowerAgentCredentialsRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/CreateTowerAgentCredentialsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "409": description: Conflict - resource already exists content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] /credentials/{credentialsId}#agent: get: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: - TowerAgentCredential#read - TowerAgentCredential#create#2 x-speakeasy-name-override: DescribeTowerAgentCredentials summary: Describe Tower Agent credentials description: Retrieves the details of the Tower Agent credentials identified by the given `credentialsId`. tags: - credentials operationId: DescribeTowerAgentCredentials parameters: - name: credentialsId in: path description: Credentials string identifier 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/DescribeTowerAgentCredentialsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "403": description: Operation not allowed "404": description: Not Found - Credential does not exist or has been deleted content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] put: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: TowerAgentCredential#update x-speakeasy-name-override: UpdateTowerAgentCredentials summary: Update Tower Agent credentials description: Updates the details of the Tower Agent credentials identified by the given `credentialsId`. tags: - credentials operationId: UpdateTowerAgentCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query description: Workspace numeric identifier required: true schema: type: integer format: int64 requestBody: description: Tower Agent credentials update request content: application/json: schema: $ref: "#/components/schemas/UpdateTowerAgentCredentialsRequest" required: true 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: [] delete: x-speakeasy-entity-operation: terraform-datasource: null terraform-resource: TowerAgentCredential#delete x-speakeasy-name-override: DeleteTowerAgentCredentials summary: Delete Tower Agent credentials description: Deletes the Tower Agent credentials identified by the given `credentialsId`. tags: - credentials operationId: DeleteTowerAgentCredentials parameters: - name: credentialsId in: path description: Credentials string identifier required: true schema: type: string - name: workspaceId in: query 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: [] 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: dateCreated: type: string format: date-time description: Timestamp when the token was created x-speakeasy-param-ordering: 3 x-speakeasy-param-readonly: true id: type: integer format: int64 description: Unique identifier for the token x-speakeasy-param-ordering: 1 x-speakeasy-param-readonly: true lastUsed: type: string format: date-time nullable: true description: Timestamp when the token was last used for authentication (null if never used) x-speakeasy-param-ordering: 4 x-speakeasy-param-readonly: true name: type: string maxLength: 50 minLength: 1 description: Display name for the token (1-50 characters). Used to identify the token's purpose. x-speakeasy-param-ordering: 2 required: - name x-speakeasy-entity: Tokens x-speakeasy-entity-description: | Manage API access tokens for authentication. Tokens provide secure API access for programmatic access to platform resources and services. Use tokens for CI/CD integration, automation scripts, and external tools. IMPORTANT: The token value (access_key) is only available immediately after creation. Store it securely as it cannot be retrieved later. description: | API access token for platform authentication. Contains the token ID, name, and usage metadata. 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 ActionQueryAttribute: type: string enum: - labels x-enum-varnames: - labels ActionResponseDto: type: object properties: config: $ref: '#/components/schemas/Action.ConfigType' description: Configuration type and settings for the action trigger x-speakeasy-param-ordering: 4 error: type: string hookId: type: string nullable: true description: Identifier for the webhook associated with this action x-speakeasy-param-ordering: 7 x-speakeasy-param-readonly: true hookUrl: type: string nullable: true description: URL endpoint for the webhook that triggers this action x-speakeasy-param-ordering: 8 x-speakeasy-param-readonly: true id: type: string description: Unique identifier for the action x-speakeasy-param-ordering: 1 x-speakeasy-param-readonly: true launch: $ref: '#/components/schemas/LaunchDbDto' description: Launch configuration and parameters for the pipeline execution x-speakeasy-param-ordering: 5 name: type: string nullable: true description: Human-readable name for the action x-speakeasy-param-ordering: 2 nextExecution: type: string format: date-time source: $ref: '#/components/schemas/Action.Source' description: "Event source that triggers this action. Defaults to 'tower' (programmatic webhook). Use 'github' for GitHub webhook events (requires linked GitHub account)." x-speakeasy-param-ordering: 3 status: $ref: '#/components/schemas/Action.Status' description: Current execution status of the action x-speakeasy-param-ordering: 6 x-speakeasy-param-readonly: true x-speakeasy-entity: Action x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage pipeline actions for event-based workflow automation. This resource allows the management of pipeline actions. Actions enable event-based pipeline execution, such as triggering a pipeline launch with a GitHub webhook whenever the pipeline repository is updated. Seqera Platform currently offers support for native GitHub webhooks and a general Tower webhook that can be invoked programmatically. description: | Represents a pipeline action in the Seqera Platform. Contains action configuration, triggers, and execution settings for automated pipeline workflows. 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' AgentSecurityKeys: type: object properties: connectionId: type: string nullable: true discriminator: type: string x-speakeasy-terraform-ignore: true shared: type: boolean workDir: type: string title: Tower Agent credentials AltairPbsComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true 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 required: - workDir Analytics: type: object properties: hubspotId: type: string posthogApiHost: type: string posthogApiKey: type: string 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 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 description: | Path to AWS CLI on compute instances. AWS CLI must be available at this path. example: "/home/ec2-user/miniconda/bin/aws" x-speakeasy-param-force-new: true computeJobRole: type: string description: | IAM role ARN for compute jobs. Jobs assume this role during execution. Must have permissions for S3, CloudWatch, etc. Format: arn:aws:iam::account-id:role/role-name example: "arn:aws:iam::123456789012:role/BatchJobRole" x-speakeasy-param-force-new: true computeQueue: type: string description: Name of the AWS Batch compute queue x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true dragenInstanceType: type: string description: | EC2 instance type for DRAGEN jobs (e.g., f1.2xlarge). Only applicable when DRAGEN is enabled. x-speakeasy-param-force-new: true dragenQueue: type: string description: | Name of the AWS Batch queue for DRAGEN jobs. Only applicable when DRAGEN is enabled. x-speakeasy-param-force-new: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' description: | Array of environment variables for the compute environment. Each variable can target the head node, compute nodes, or both. executionRole: type: string description: | IAM role ARN for Batch execution (pulling container images, writing logs). Must have permissions for ECR and CloudWatch Logs. Format: arn:aws:iam::account-id:role/role-name example: "arn:aws:iam::123456789012:role/BatchExecutionRole" x-speakeasy-param-force-new: true forge: $ref: '#/components/schemas/ForgeConfig' fusion2Enabled: type: boolean x-speakeasy-name-override: enable_fusion x-speakeasy-plan-validators: FusionEnabledValidator description: | Allow access to your AWS S3-hosted data via the Fusion v2 virtual distributed file system, speeding up most operations. Requires `enable_wave = true`. fusionSnapshots: type: boolean description: | Enable Fusion Snapshots (beta). This feature allows Fusion to automatically restore a job when it is interrupted by a spot reclamation. Requires `enable_fusion = true`. example: false x-speakeasy-param-force-new: true # NOTE: enable_fusion dependency is enforced by `FusionSnapshotsValidator` # (internal/validators/boolvalidators/fusion_snapshots_validator.go). # Speakeasy emits an over-deep AtParent path for the schema-level # `x-speakeasy-required-with: [../fusion2Enabled]` directive AND uses # the pre-rename name (`fusion2_enabled`) instead of the renamed # `enable_fusion`, so we rely on the custom validator instead. x-speakeasy-plan-validators: FusionSnapshotsValidator headJobCpus: type: integer format: int32 description: "Number of CPUs allocated for the head job (default: 1)" example: 4 x-speakeasy-param-force-new: true headJobMemoryMb: type: integer format: int32 description: "Memory allocation for the head job in MB (default: 1024)" example: 8192 x-speakeasy-param-force-new: true headJobRole: type: string description: | IAM role ARN for the head job. Format: arn:aws:iam::account-id:role/role-name example: "arn:aws:iam::123456789012:role/BatchHeadJobRole" x-speakeasy-param-force-new: true headQueue: type: string description: Name of the head job queue x-speakeasy-param-force-new: true logGroup: type: string description: | CloudWatch Log group name for pipeline execution logs. If specified, logs are sent to this existing log group instead of the default. example: "/aws/batch/seqera" x-speakeasy-param-force-new: true lustreId: type: string deprecated: true nextflowConfig: type: string description: | Nextflow configuration settings that override repository defaults. Applied globally to all pipelines launched in this compute environment. x-speakeasy-param-force-new: true nvnmeStorageEnabled: type: boolean x-speakeasy-name-override: nvme_storage_enabled x-speakeasy-plan-validators: NvmeStorageValidator description: | Allow the use of NVMe instance storage to speed up I/O and disk access operations. Requires `enable_fusion = true`. example: true x-speakeasy-param-force-new: true postRunScript: description: | Bash script to run after workflow execution completes. Use for cleanup, archiving results, sending notifications, etc. type: string x-speakeasy-param-force-new: true x-speakeasy-plan-validators: RunScriptSizeValidator preRunScript: description: | Bash script to run before workflow execution begins. Use for environment setup, loading modules, downloading reference data, etc. type: string x-speakeasy-param-force-new: true x-speakeasy-plan-validators: RunScriptSizeValidator region: type: string description: | AWS region where the Batch compute environment will be created. Examples: us-east-1, eu-west-1, ap-southeast-2 example: "us-east-1" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false storageType: type: string deprecated: true volumes: type: array items: type: string description: | List of volume mount specifications for compute instances. Format follows Docker volume mount syntax. x-speakeasy-param-force-new: true waveEnabled: type: boolean title: "Wave Enabled" description: | Allow access to private container repositories and the provisioning of containers in your Nextflow pipelines via the Wave containers service. Required when `enable_fusion` is true. x-speakeasy-name-override: enable_wave workDir: description: | S3 bucket path for Nextflow work directory where intermediate files will be stored. Format: s3://bucket-name/path type: string example: "s3://my-nextflow-bucket/work" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false x-speakeasy-plan-validators: WorkDirS3Validator title: AWS Batch configuration x-speakeasy-plan-validators: awsForgeValidator required: - region 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 description: | List of additional S3 bucket names that compute jobs are allowed to access. The work directory bucket is automatically included. x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue arm64Enabled: type: boolean description: | Enable ARM64 (Graviton) CPU architecture for compute instances. When enabled, Graviton-based EC2 instances will be selected for cost savings. example: false x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true ebsBootSize: type: integer format: int32 description: | Size of the boot disk (root volume) in GB for EC2 instances in this compute environment. When using Fusion v2 without fast instance storage, this defaults to 100 GB with GP3 volume type. example: 100 x-speakeasy-param-force-new: true ec2KeyPair: type: string description: | EC2 key pair name for SSH access to compute instances. Key pair must exist in the specified region. example: "my-keypair" x-speakeasy-param-force-new: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean x-speakeasy-terraform-ignore: true gpuEnabled: type: boolean description: | Enable GPU support for compute instances. When enabled, GPU-capable instance types will be selected. example: false x-speakeasy-param-force-new: true imageId: type: string description: | Custom Amazon Machine Image (AMI) ID for compute instances. If not specified, the default ECS-optimized AMI is used. example: "ami-0123456789abcdef0" x-speakeasy-param-force-new: true instanceProfileArn: type: string description: | IAM instance profile ARN for compute instances. Format: arn:aws:iam::account-id:instance-profile/profile-name example: "arn:aws:iam::123456789012:instance-profile/BatchInstanceProfile" x-speakeasy-param-force-new: true instanceType: type: string description: | EC2 instance type for the compute environment (e.g., m5.xlarge, c5.2xlarge). example: "m5.xlarge" x-speakeasy-param-force-new: true logGroup: type: string description: | CloudWatch Log group name for pipeline execution logs. If specified, logs are sent to this existing log group instead of the default. example: "/aws/batch/seqera" x-speakeasy-param-force-new: 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 x-speakeasy-plan-validators: RunScriptSizeValidator region: type: string description: | AWS region where the compute environment will be created. Examples: us-east-1, eu-west-1, ap-southeast-2 example: "us-east-1" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false schedConfig: $ref: '#/components/schemas/SchedConfig' x-speakeasy-name-override: intelligent_compute_config nullable: true description: | Optional scheduler configuration used when `intelligent_compute_enabled = true` (Seqera Intelligent Compute mode). Defines the EC2 provisioning strategy and, optionally, the eligible instance-type catalog. Leave null to accept the platform defaults. Must be omitted (or null) when `intelligent_compute_enabled = false`. x-speakeasy-param-force-new: true schedEnabled: type: boolean x-speakeasy-name-override: intelligent_compute_enabled description: | Enable Seqera Intelligent Compute (Preview). When `true`, tasks are distributed across multiple EC2 instances with optimized scheduling and resource allocation. When `false` (default), all tasks run on a single instance (Classic mode). `intelligent_compute_config` is optional in both modes: leave it null to accept the platform defaults, or provide it (only when `intelligent_compute_enabled = true`) to pin the provisioning strategy or instance-type catalog. Setting this to `true` requires the `SEQERA_SCHEDULER` feature toggle to be enabled on the target workspace/org; otherwise the API returns HTTP 403. example: false x-speakeasy-param-force-new: true securityGroups: type: array items: type: string description: | List of security group IDs to attach to compute instances. Security groups must allow necessary network access. example: ["sg-12345678"] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue subnetId: type: string description: | Subnet ID where compute instances will be launched. Must be in the same VPC and region as the compute environment. example: "subnet-12345678" x-speakeasy-param-force-new: true waveEnabled: type: boolean x-speakeasy-terraform-ignore: true workDir: description: | S3 working directory for workflow execution. Must be a `s3://` URI in the same region as the compute environment (e.g. `s3://my-bucket/work`). Max 100 characters. type: string example: "s3://my-bucket/work" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false x-speakeasy-plan-validators: WorkDirS3Validator title: AWS Cloud configuration x-speakeasy-plan-validators: schedConfigConsistencyValidator required: - region 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 x-enum-varnames: - keys - role x-type: String AwsSecurityKeys: type: object properties: accessKey: type: string nullable: true assumeRoleArn: type: string nullable: true discriminator: type: string x-speakeasy-terraform-ignore: true secretKey: type: string writeOnly: true nullable: true title: AWS credentials AzBatchConfig: type: object properties: autoPoolMode: type: boolean deprecated: true deleteJobsOnCompletion: allOf: - $ref: '#/components/schemas/JobCleanupPolicy' nullable: true readOnly: false deprecated: true x-speakeasy-deprecation-message: | Replaced by `delete_jobs_on_completion_enabled` (and optionally `delete_pools_on_completion`, `delete_tasks_on_completion`) in Seqera Platform v26.1+. Kept settable here for backwards compatibility with Platform v25.1 and earlier — on those versions this string is the only way to control job cleanup. On v26.1+ it is read-only on the server and the boolean fields are authoritative. deleteJobsOnCompletionEnabled: type: boolean nullable: true deletePoolsOnCompletion: type: boolean deleteTasksOnCompletion: type: boolean nullable: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' forge: $ref: '#/components/schemas/AzBatchForgeConfig' fusion2Enabled: type: boolean x-speakeasy-name-override: enable_fusion x-speakeasy-plan-validators: FusionEnabledValidator description: | Allow access to your cloud-hosted data via the Fusion v2 virtual distributed file system, speeding up most operations. Requires `enable_wave = true`. 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 title: "Wave Enabled" description: | Allow access to private container repositories and the provisioning of containers in your Nextflow pipelines via the Wave containers service. Required when `enable_fusion` is true. x-speakeasy-name-override: enable_wave workDir: description: Must be a valid Azure Blob container URL with format az://container-name/path type: string title: "Azure Batch Work Directory" example: "az://my-container/work" pattern: "^az://.+" x-speakeasy-param-optional: false x-speakeasy-param-force-new: true workerPool: type: string title: Azure Batch configuration required: - region 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 description: | List of Azure Container Registry IDs whose images compute jobs may pull. x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue 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' required: - vmCount 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: dataCollectionEndpoint: type: string description: | Azure Monitor data collection endpoint URL for diagnostic telemetry. x-speakeasy-param-force-new: true dataCollectionRuleId: type: string description: | Azure Monitor data collection rule resource ID associated with the endpoint. x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' description: | Array of environment variables for the compute environment. Each variable can target the head node, compute nodes, or both. fusion2Enabled: type: boolean x-speakeasy-terraform-ignore: true instanceType: type: string description: | Azure VM size for compute instances (e.g., Standard_D4s_v3, Standard_F8s_v2). example: "Standard_D4s_v3" x-speakeasy-param-force-new: true logTableName: type: string description: | Azure Log Analytics table name for execution logs. x-speakeasy-param-force-new: true logWorkspaceId: type: string description: | Azure Log Analytics workspace ID for execution logs. x-speakeasy-param-force-new: true managedIdentityClientId: type: string description: | Azure managed identity client ID for compute instances. x-speakeasy-param-force-new: true managedIdentityId: type: string description: | Azure managed identity resource ID for compute instances. x-speakeasy-param-force-new: true networkId: type: string description: | Azure VNet resource ID for compute instance networking. Required when using private network isolation. x-speakeasy-param-force-new: true nextflowConfig: type: string description: | Nextflow configuration settings that override repository defaults. Applied globally to all pipelines launched in this compute environment. x-speakeasy-param-force-new: true 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 x-speakeasy-plan-validators: RunScriptSizeValidator region: type: string description: | Azure region where the compute environment will be created. Examples: eastus, westus2, northeurope example: "eastus" x-speakeasy-param-optional: false x-speakeasy-param-force-new: true resourceGroup: type: string description: | Read-only. The Forge-created resource group that holds the compute environment's resources (named `TowerForge--`). Forge always provisions its own RG at the subscription scope and ignores any user-supplied value, so this field is computed by the backend rather than configured. example: "TowerForge-my-ce-abc123XYZ" x-speakeasy-param-readonly: true x-speakeasy-param-computed: true subscriptionId: type: string description: | Azure subscription ID where compute resources will be created. example: "00000000-0000-0000-0000-000000000000" x-speakeasy-param-force-new: true waveEnabled: type: boolean x-speakeasy-terraform-ignore: true workDir: description: | Azure Blob Storage container path for Nextflow work directory. Format: az://container-name/path type: string title: "Azure Blob Work Directory" example: "az://my-container/work" pattern: "^az://.+" x-speakeasy-param-optional: false x-speakeasy-param-force-new: true 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 warnings: type: array items: type: string title: Azure Cloud platform metainfo 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 x-speakeasy-terraform-ignore: true password: type: string writeOnly: true token: type: string writeOnly: true nullable: true username: type: string nullable: true title: Azure Repos credentials AzureSecurityKeys: type: object properties: batchKey: type: string writeOnly: true nullable: true batchName: type: string nullable: true discriminator: type: string x-speakeasy-terraform-ignore: true storageKey: type: string writeOnly: true nullable: true storageName: type: string nullable: true title: Azure credentials BitBucketSecurityKeys: type: object properties: discriminator: type: string x-speakeasy-terraform-ignore: true password: type: string writeOnly: true nullable: true token: type: string writeOnly: true nullable: true username: type: string nullable: true title: BitBucket credentials Bucket: type: object properties: path: type: string BucketActionConfig: type: object properties: bucketName: type: string dataLinkId: type: string datasetId: 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 datasetId: 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 nullable: true CodeCommitSecurityKeys: type: object properties: discriminator: type: string x-speakeasy-terraform-ignore: true password: type: string writeOnly: true nullable: true token: type: string nullable: true username: type: string nullable: true title: AWS CodeCommit credentials ComputeConfig: type: object properties: discriminator: description: Read-only property identifying the compute platform type type: string x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' description: Array of environment variables for the compute environment nextflowConfig: type: string description: Nextflow configuration settings and parameters postRunScript: description: Shell script to execute after workflow completes type: string x-speakeasy-plan-validators: RunScriptSizeValidator preRunScript: description: Shell script to execute before workflow starts type: string x-speakeasy-plan-validators: RunScriptSizeValidator workDir: description: Working directory path for workflow execution type: string x-speakeasy-param-optional: false x-speakeasy-param-force-new: true 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' description: | Configuration settings for compute environments including work directories, pre/post run scripts, and environment-specific parameters. ComputeEnv.Status: type: string enum: - CREATING - AVAILABLE - DISABLED - DELETING - ERRORED - INVALID - DELETED ComputeEnvDbDto: type: object properties: id: type: string name: type: string nullable: true platform: type: string nullable: true region: type: string nullable: true description: Compute environment region nullable: true 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 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 nullable: true description: Associated credentials ID (null if using managed identity or none) dateCreated: type: string format: date-time x-speakeasy-param-readonly: true deleted: type: boolean nullable: true description: Whether compute environment is deleted (null means not deleted) x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true description: type: string nullable: true description: Compute environment description id: type: string x-speakeasy-name-override: computeEnvId labels: type: array items: $ref: '#/components/schemas/LabelDbDto' lastUpdated: type: string format: date-time x-speakeasy-param-readonly: true lastUsed: type: string format: date-time nullable: true description: Last time this compute environment was used (null if never used) x-speakeasy-param-readonly: true managedIdentityId: type: string nullable: true description: Associated managed identity ID (null if using credentials or none) message: type: string nullable: true description: Status message (null if no message) 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 nullable: true description: Whether this is the primary compute environment resources: allOf: - $ref: '#/components/schemas/ComputeEnvResources' nullable: true status: $ref: '#/components/schemas/ComputeEnv.Status' workspaceId: type: integer format: int64 x-speakeasy-entity: ComputeEnv x-speakeasy-entity-version: 2 x-speakeasy-entity-description: | Seqera Platform compute environments define the execution platform where a pipeline will run. Compute environments enable users to launch pipelines on a growing number of cloud and on-premises platforms. Each compute environment must be configured to enable Seqera to submit tasks. Compute environments define the computational resources and configuration needed to run Nextflow workflows, including cloud provider settings, resource limits, and execution parameters. ComputeEnv_ComputeConfig_: type: object properties: config: $ref: '#/components/schemas/ComputeConfig' x-speakeasy-param-force-new: true credentialsId: type: string dateCreated: type: string format: date-time readOnly: true x-speakeasy-param-readonly: true deleted: type: boolean readOnly: true x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true description: type: string maxLength: 2000 id: type: string maxLength: 22 readOnly: true x-speakeasy-param-readonly: true x-speakeasy-name-override: computeEnvId lastUpdated: type: string format: date-time readOnly: true x-speakeasy-param-readonly: true lastUsed: type: string format: date-time readOnly: true x-speakeasy-param-readonly: true message: type: string maxLength: 4096 name: type: string maxLength: 100 orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true platform: type: string enum: - aws-batch - aws-cloud - google-lifesciences - google-batch - google-cloud - azure-batch - azure-cloud - k8s-platform - eks-platform - gke-platform - uge-platform - slurm-platform - lsf-platform - altair-platform - moab-platform - seqeracompute-platform maxLength: 25 x-speakeasy-plan-validators: ComputeConfigValidator x-speakeasy-param-optional: false x-speakeasy-param-force-new: true primary: type: boolean readOnly: true status: allOf: - $ref: '#/components/schemas/ComputeEnv.Status' readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true required: - config - name - platform - credentialsId x-speakeasy-entity: ComputeEnv 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 description: | Whether this environment variable should be applied to compute/worker nodes. At least one of 'head' or 'compute' must be set to true. Both can be true to target both environments. Requires replacement if changed. default: false head: type: boolean description: | Whether this environment variable should be applied to the head/master node. At least one of 'head' or 'compute' must be set to true. Both can be true to target both environments. Requires replacement if changed. default: false name: type: string value: type: string x-speakeasy-plan-validators: ConfigEnvVariableValidator description: | Environment variable configuration. Each variable must specify whether it applies to the head node, compute nodes, or both. At least one of 'head' or 'compute' must be set to true. Both can be true to target both head and compute nodes. 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 x-speakeasy-terraform-ignore: true password: type: string writeOnly: true nullable: true registry: type: string nullable: true userName: type: string nullable: true title: Container registry credentials CreateAccessTokenRequest: type: object properties: name: type: string description: Display name for the token (1-50 characters) example: "ci-cd-pipeline-token" CreateAccessTokenResponse: type: object properties: accessKey: type: string description: | The actual token value for authentication. This sensitive value is ONLY returned when the token is created and cannot be retrieved later. Store this securely. x-speakeasy-param-ordering: 1 x-speakeasy-param-readonly: true x-speakeasy-param-sensitive: true token: $ref: '#/components/schemas/AccessToken' description: Token metadata returned after creation x-speakeasy-param-ordering: 2 id: type: integer format: int64 description: Unique identifier for the token. Mirrors `token.id`. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Tokens x-speakeasy-transform-from-api: jq: '. + { id: .token.id }' CreateActionRequest: type: object properties: bucket: $ref: '#/components/schemas/BucketActionRequest' cron: $ref: '#/components/schemas/CronActionRequest' launch: $ref: '#/components/schemas/ActionLaunchRequest' name: type: string source: $ref: '#/components/schemas/Action.Source' default: "tower" x-speakeasy-param-optional: true required: - name - launch CreateActionResponse: type: object properties: actionId: type: string id: type: string description: Alias of `action_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-transform-from-api: jq: ". + { id: .actionId }" 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 x-speakeasy-entity: ComputeEnv x-speakeasy-entity-description: | This resource allows the management of Seqera compute environments. Seqera Platform compute environments define the execution platform where a pipeline will run. Compute environments enable users to launch pipelines on a growing number of cloud and on-premises platforms. Compute environments define the computational resources and configuration needed to run Nextflow workflows, including cloud provider settings, resource limits, and execution parameters. required: - computeEnv - credentialsId - config - name - platform CreateComputeEnvResponse: type: object properties: computeEnvId: type: string id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' x-speakeasy-entity: ComputeEnv CreateCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/Credentials' CreateCredentialsResponse: type: object properties: credentialsId: type: string id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' CreateDatasetRequest: type: object properties: description: type: string example: "Dataset containing sample genomic data" name: type: string example: "my-dataset" sourceType: $ref: '#/components/schemas/SourceType' x-speakeasy-entity: Datasets required: - name CreateDatasetResponse: type: object properties: dataset: $ref: '#/components/schemas/DatasetDto' CreateLabelRequest: type: object properties: isDefault: type: boolean description: "Whether this label is automatically applied to new resources. Can only be true when resource=true." x-speakeasy-plan-validators: LabelIsDefaultValidator example: false name: type: string title: "Label Name" description: "Label name (key). Must be 2-39 alphanumeric characters, dashes, or underscores. Example: 'environment', 'team', 'cost-center'" example: "environment" x-speakeasy-plan-validators: LabelNameValidator resource: type: boolean description: "Whether this is a resource label. Resource labels (true) can have values and be applied to resources. Non-resource labels (false) are simple tags. Requires replacement if changed." example: true value: type: string title: "Label Value" description: "Label value. Must be 2-39 alphanumeric characters, dashes, or underscores, or a dynamic placeholder (${sessionId}, ${workflowId}, ${userName}) for resource labels. Required when resource=true. Example: 'production', 'data-science', '${sessionId}'" example: "production" x-speakeasy-plan-validators: LabelValueResourceValidator x-speakeasy-entity: Labels x-speakeasy-entity-description: | Manage labels for organizing and categorizing resources. Labels provide metadata tagging capabilities for pipelines, workflows, and other platform resources, enabling resource organization, filtering, and management across the platform. CreateLabelResponse: type: object properties: id: type: integer format: int64 isDefault: type: boolean name: type: string resource: type: boolean value: type: string label_id: type: integer format: int64 description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Labels x-speakeasy-transform-from-api: jq: '. + { label_id: .id }' 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: organization: $ref: '#/components/schemas/Organization' CreateOrganizationResponse: type: object properties: organization: $ref: '#/components/schemas/OrganizationDbDto' CreatePipelineRequest: type: object properties: description: type: string icon: type: string nullable: true description: Icon identifier or URL for visual representation labelIds: type: array items: format: int64 type: integer launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string version: $ref: '#/components/schemas/CreatePipelineVersionRequest' required: - name - launch - workspace_id CreatePipelineResponse: type: object properties: pipeline: $ref: '#/components/schemas/PipelineDbDto' x-speakeasy-entity: Pipelines CreatePipelineSchemaRequest: type: object properties: content: type: string CreatePipelineSchemaResponse: type: object properties: pipelineSchema: $ref: '#/components/schemas/PipelineSchemaDbDto' CreatePipelineSecretRequest: type: object properties: name: type: string description: Secret name used to reference the secret in workflows (max 100 characters) example: "api_key" value: type: string x-speakeasy-param-sensitive: true description: The sensitive secret value to store (will be encrypted) example: "secret_value_here" required: - name - value - workspace_id CreatePipelineSecretResponse: type: object properties: secretId: type: integer format: int64 id: type: integer format: int64 description: Alias of `secret_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-transform-from-api: jq: '. + { id: .secretId }' 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 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 example: "avatar-123456" 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 pattern: '' nullable: true description: Base URL for the credential provider x-speakeasy-param-computed: false example: "https://www.googleapis.com" category: type: string maxLength: 20 nullable: true description: Credentials category x-speakeasy-param-computed: false example: "cloud" dateCreated: type: string format: date-time readOnly: true x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true description: Timestamp when the credential was created deleted: type: boolean readOnly: true nullable: true description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true description: type: string nullable: true description: Optional description explaining the purpose of the credential x-speakeasy-param-computed: false example: "Google Cloud credentials for production workloads" id: type: string maxLength: 22 x-speakeasy-param-suppress-computed-diff: true description: Unique identifier for the credential (max 22 characters) keys: $ref: '#/components/schemas/SecurityKeys' x-speakeasy-param-computed: false lastUpdated: type: string format: date-time readOnly: true x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time readOnly: true nullable: true description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true name: type: string maxLength: 100 example: "my-gcp-credentials" description: Display name for the credential (max 100 characters) provider: type: string enum: - aws - azure - azure_entra - azure-cloud - google - github - gitlab - bitbucket - ssh - k8s - container-reg - tw-agent - codecommit - gitea - azurerepos - seqeracompute maxLength: 16 x-speakeasy-name-override: providerType x-speakeasy-plan-validators: CredentialsConfigValidator x-speakeasy-param-computed: false example: "google" description: | Cloud or service provider type. The value must match the corresponding `keys.*` block: - `azure` → `keys.azure` (Azure Batch, shared-key auth) - `azure_entra` → `keys.azure_entra` (Azure Batch, Entra service principal) - `azure-cloud` → `keys.azure_cloud` (Azure Cloud / SingleVM, Entra service principal) required: - name - provider - keys x-speakeasy-entity: Credential x-speakeasy-entity-description: | Manage workspace credentials in Seqera platform using this resource. Credentials store authentication information for accessing cloud providers, Git repositories, container registries, and other external services within the Seqera Platform workflows. description: | Represents credentials used for authentication with various platforms and services. Contains authentication information for accessing cloud providers, Git repositories, and other external services within the Seqera Platform. 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 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 example: "aws-credentials-id" description: type: string example: "S3 bucket for production data storage" name: type: string example: "my-s3-datalink" provider: $ref: '#/components/schemas/DataLinkProvider' example: "aws" publicAccessible: type: boolean example: false resourceRef: type: string example: "s3://my-bucket" type: $ref: '#/components/schemas/DataLinkType' example: "bucket" required: - description - name - provider - publicAccessible - resourceRef - type 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: Array of credentials required to access the data link description: type: string nullable: true description: Description of the data link's purpose and contents hidden: type: boolean id: type: string description: Unique identifier for the data link message: type: string nullable: true name: type: string nullable: true description: Display name for the data link connection provider: $ref: '#/components/schemas/DataLinkProvider' description: Cloud provider hosting the data link publicAccessible: type: boolean region: type: string nullable: true description: Geographic region where the data link is hosted resourceRef: type: string nullable: true description: Reference identifier for the external resource status: allOf: - $ref: '#/components/schemas/DataLink.Status' readOnly: true type: $ref: '#/components/schemas/DataLinkType' description: Type of data link (e.g., S3, Azure Blob, etc.) data_link_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: DataLink x-speakeasy-entity-description: | Manage connections to external storage systems and data repositories. Data links provide access to cloud storage for pipeline input/output operations, enabling seamless data integration. x-speakeasy-transform-from-api: jq: '. + { data_link_id: .id }' description: | Represents a data link connection to external storage systems. Provides access to cloud storage, file systems, and data repositories for pipeline input/output operations. DataLinkFinishMultiPartUploadRequest: type: object properties: fileName: type: string tags: items: $ref: '#/components/schemas/UploadEtag' type: array uploadId: type: string withError: type: boolean DataLinkItem: type: object properties: 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 DataLinkMultiPartUploadRequest: type: object properties: contentLength: type: integer format: int64 contentType: type: string fileName: type: string DataLinkMultiPartUploadResponse: type: object properties: uploadId: type: string uploadUrls: type: array items: type: string DataLinkProvider: type: string enum: - aws - google - azure - azure_entra - seqeracompute x-speakeasy-name-override: providerType 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 nullable: true description: Date checkpoint was saved (null if not saved) 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 x-speakeasy-entity: Studios DataStudioConfiguration: type: object properties: condaEnvironment: type: string maxLength: 2048 nullable: true cpu: type: integer format: int32 minimum: 0 nullable: true description: Number of CPU cores to allocate. Set to 0 to use the compute environment configured defaults. example: 2 default: 2 environment: type: object additionalProperties: type: string nullable: true description: Studio-specific environment variables as key-value pairs. Variable names must contain only alphanumeric and underscore characters, and cannot begin with a number. x-speakeasy-param-force-new: true x-speakeasy-param-optional: true x-speakeasy-plan-validators: StudioEnvironmentVariableValidator gpu: type: integer format: int32 minimum: 0 nullable: true description: Set to 0 to disable GPU or 1 to enable GPU. example: 0 default: 0 lifespanHours: type: integer format: int32 minimum: 0 nullable: true description: Maximum lifespan of the Studio session in hours example: 2 memory: type: integer format: int32 minimum: 0 nullable: true description: Memory allocation for the Studio session in megabytes (MB). Set to 0 to use the compute environment configured defaults. example: 4096 default: 8192 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 x-speakeasy-entity: Studios x-speakeasy-entity-description: | Studios is a unified platform where you can host a combination of container images and compute environments for interactive analysis using your preferred tools, like JupyterLab, an R-IDE, Visual Studio Code IDEs, or Xpra remote desktops. Each Studio session is an individual interactive environment that encapsulates the live environment for dynamic data analysis. Note: On Seqera Cloud, the free tier permits only one running Studio session at a time. To run simultaneous sessions, contact Seqera for a Seqera Cloud Pro license. DataStudioCreateRequest: type: object properties: computeEnvId: type: string minLength: 1 example: "compute-env-id" configuration: $ref: '#/components/schemas/DataStudioConfiguration' dataStudioToolUrl: type: string example: "public.cr.seqera.io/platform/data-studio-jupyter:4.2.5-0.8" description: type: string maxLength: 2048 example: "Jupyter studio for data analysis and visualization" initialCheckpointId: type: integer format: int64 isPrivate: type: boolean labelIds: type: array items: format: int64 type: integer nullable: true description: List of resource label IDs to associate with this Studio. Reference labels using seqera_labels.label_name.id name: type: string maxLength: 80 minLength: 1 example: "my-jupyter-studio" spot: type: boolean nullable: true description: Whether to use spot or on-demand instances. Studios using Spot instances are not compatible with batch compute environments. x-speakeasy-entity: Studios x-speakeasy-entity-description: | Studios is a unified platform where you can host a combination of container images and compute environments for interactive analysis using your preferred tools, like JupyterLab, an R-IDE, Visual Studio Code IDEs, or Xpra remote desktops. Each Studio session is an individual interactive environment that encapsulates the live environment for dynamic data analysis. Note: On Seqera Cloud, the free tier permits only one running Studio session at a time. To run simultaneous sessions, contact Seqera for a Seqera Cloud Pro license. required: - computeEnvId - dataStudioToolUrl - name - configuration DataStudioCreateResponse: type: object properties: studio: $ref: '#/components/schemas/DataStudioDto' DataStudioDto: type: object properties: configuration: $ref: '#/components/schemas/DataStudioConfiguration' description: type: string nullable: true description: Description of the Studio session's purpose isPrivate: type: boolean nullable: true name: type: string description: Display name for the Studio session sessionId: type: string x-speakeasy-param-readonly: true x-speakeasy-name-override: sessionId x-speakeasy-param-optional: true description: Unique identifier for the Studio session sshDetails: allOf: - $ref: '#/components/schemas/StudioSshDetailsDto' nullable: true workspaceId: type: integer format: int64 description: Numeric identifier of the workspace containing the Studio x-speakeasy-param-optional: false x-speakeasy-param-force-new: true id: type: string description: Alias of `session_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Studios x-speakeasy-transform-from-api: jq: '. + { id: .sessionId }' description: | Represents a Studio session for interactive data analysis. Contains configuration and runtime information for Jupyter-based computational environments. DataStudioDto.ParentCheckpoint: type: object properties: checkpointId: type: integer format: int64 nullable: true checkpointName: type: string nullable: true sessionId: type: string nullable: true studioName: type: string nullable: true nullable: true 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 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 nullable: true description: Step warnings (can be null) DataStudioProgressStep.Status: type: string enum: - pending - in-progress - succeeded - errored nullable: true DataStudioQueryAttribute: type: string enum: - labels x-enum-varnames: - labels DataStudioStartRequest: type: object properties: 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 nullable: true DataStudioStatusInfo: type: object properties: lastUpdate: type: string format: date-time message: type: string nullable: true status: $ref: '#/components/schemas/DataStudioStatus' stopReason: $ref: '#/components/schemas/DataStudioStopReason' DataStudioStopReason: type: string nullable: true enum: - CREDITS_RUN_OUT - LIFESPAN_EXPIRED - SPOT_RECLAMATION 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 nullable: true description: Icon identifier or URL for visual representation 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 nullable: true 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: description: type: string nullable: true description: Detailed description of the dataset contents and purpose (max 1000 characters) id: type: string description: Unique identifier for the dataset (max 22 characters) lastUpdated: type: string format: date-time x-speakeasy-param-readonly: true description: Timestamp when the dataset was last modified mediaType: type: string nullable: true description: MIME type or media type of the dataset content (max 80 characters) name: type: string description: Dataset name following naming conventions (1-100 characters) sourceType: $ref: '#/components/schemas/SourceType' workspaceId: type: integer format: int64 description: Numeric identifier of the workspace containing this dataset x-speakeasy-entity: Datasets x-speakeasy-entity-description: | Manage datasets for storing and versioning research data. Datasets in Seqera are CSV (comma-separated values) and TSV (tab-separated values) files stored in a workspace. They are used as inputs to pipelines to simplify data management, minimize user data-input errors, and facilitate reproducible workflows. description: | Represents a dataset in the Seqera Platform. Contains dataset metadata, versioning information, and access controls for data management and sharing. 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 nullable: true description: Last used timestamp (null if never used) runsCount: type: integer format: int64 nullable: true description: Number of runs nullable: true 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 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/DeleteCredentialsConflictResponse.Conflict' credentialsId: type: string DeleteCredentialsConflictResponse.Conflict: type: object properties: id: type: string name: type: string type: type: string url: 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/DeleteManagedCredentialsConflictResponse.Conflict' managedCredentialsId: type: string DeleteManagedCredentialsConflictResponse.Conflict: type: object properties: id: type: string name: type: string type: type: string url: 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' DescribeComputeEnvResponse: type: object properties: computeEnv: $ref: '#/components/schemas/ComputeEnvResponseDto' x-speakeasy-entity: ComputeEnv x-speakeasy-entity: ComputeEnv DescribeCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/Credentials' 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' 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 needConsent: type: boolean user: $ref: '#/components/schemas/UserResponseDto' DescribeWorkflowLaunchResponse: type: object properties: launch: $ref: '#/components/schemas/WorkflowLaunchResponse' DescribeWorkflowResponse: type: object properties: pipelineInfo: allOf: - $ref: "#/components/schemas/PipelineMinInfoResponse" x-speakeasy-param-suppress-computed-diff: true schedEnabled: type: boolean nullable: true x-speakeasy-name-override: intelligent_compute_enabled x-speakeasy-param-suppress-computed-diff: true workflow: allOf: - $ref: "#/components/schemas/WorkflowMaxDbDto" x-speakeasy-terraform-ignore: true workspaceId: type: integer format: int64 nullable: true x-speakeasy-entity: Workflows x-speakeasy-entity-description: | Launch and track an individual workflow run on the Seqera Platform — equivalent to a Run on the Runs page. Each `seqera_workflows` resource maps to one execution of a Nextflow pipeline against a specific compute environment. Use it when Terraform itself should trigger runs (one-off validations, CI fan-outs, post-CE-change smoke tests). Reach for `seqera_pipeline` instead when you want a persistent, re-launchable definition on the Launchpad rather than a single run. DescribeWorkspaceResponse: type: object properties: workspace: $ref: '#/components/schemas/Workspace' 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 x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean x-speakeasy-name-override: enable_fusion x-speakeasy-plan-validators: FusionEnabledValidator description: | Allow access to your AWS S3-hosted data via the Fusion v2 virtual distributed file system, speeding up most operations. Requires `enable_wave = true`. 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 title: "Wave Enabled" description: | Allow access to private container repositories and the provisioning of containers in your Nextflow pipelines via the Wave containers service. Required when `enable_fusion` is true. x-speakeasy-name-override: enable_wave workDir: description: Compute environment working directory type: string title: Amazon EKS cluster configuration required: - region - clusterName 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 x-speakeasy-terraform-ignore: true 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 description: | Strategy for allocating compute resources: - BEST_FIT: Selects instance type that best fits job requirements - BEST_FIT_PROGRESSIVE: Similar to BEST_FIT but widens search progressively - SPOT_CAPACITY_OPTIMIZED: For Spot instances, selects from pools with optimal capacity - SPOT_PRICE_CAPACITY_OPTIMIZED: Optimizes for both price and capacity Note: SPOT_CAPACITY_OPTIMIZED only valid when type is SPOT example: "SPOT_CAPACITY_OPTIMIZED" x-speakeasy-param-force-new: true allowBuckets: type: array items: type: string description: | List of additional S3 bucket ARNs or names that compute jobs are allowed to access. The work directory bucket is automatically included. example: ["s3://my-input-bucket", "s3://my-output-bucket", "s3://my-input-bucket", "s3://my-output-bucket"] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue arm64Enabled: type: boolean description: | Enable this option to deploy Graviton-based (ARM64) EC2 instances to run your pipeline compute jobs. Requires `fargate_head_enabled = true`, `enable_wave = true`, and `enable_fusion = true`. example: false x-speakeasy-param-force-new: true x-speakeasy-plan-validators: GravitonValidator bidPercentage: type: integer format: int32 title: "Bid Percentage" description: | The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty. Must be a whole number between 0 and 100 (inclusive). example: 20 minimum: 0 maximum: 100 disposeOnDeletion: type: boolean description: | When set to true for AWS Batch forge environments, automatically deletes AWS resources created during compute environment setup when the Terraform resource is destroyed. The following AWS resources will be deleted: 1. AWS Batch Compute Environments - The Batch compute environment itself 2. AWS Batch Job Queues - Associated job queues (head queue, compute queue, dragen queue) 3. EC2 Launch Templates - Launch templates for the compute instances 4. IAM Roles - Execution roles, head job roles, and other service roles 5. IAM Instance Profiles - Instance profiles attached to compute instances 6. FSx File Systems - FSx for Lustre file systems (if created during forge) 7. EFS File Systems - Elastic File Systems (if created during forge) Note: The AWS credentials associated with this compute environment must have appropriate permissions to delete these resources. Important: Deleting a workspace with active compute environments will bypass this cleanup and require manual removal of AWS resources. We recommend deleting compute environments before deleting workspaces. example: true x-speakeasy-param-force-new: true dragenAmiId: type: string description: | Custom AMI ID for DRAGEN-enabled instances. Only applicable when dragen_enabled is true. x-speakeasy-param-force-new: true # NOTE: dragen_enabled dependency is enforced by `awsForgeValidator`. dragenEnabled: type: boolean description: | Enable Illumina DRAGEN support for the compute environment. When enabled, DRAGEN-specific instance types and AMIs will be used. example: false x-speakeasy-param-force-new: true dragenInstanceType: type: string description: | EC2 instance type to use for DRAGEN jobs (e.g., f1.2xlarge, f1.16xlarge). Only applicable when dragen_enabled is true. x-speakeasy-param-force-new: true # NOTE: dragen_enabled dependency is enforced by `awsForgeValidator`. ebsAutoScale: type: boolean description: | Deprecated. Enable automatic EBS volume expansion. When enabled, additional EBS volumes are dynamically attached and mounted (typically at /scratch) as disk space runs low. This feature is deprecated and is not compatible with Fusion v2. Use ebs_boot_size to configure a larger root volume instead. deprecated: true example: false x-speakeasy-param-force-new: true ebsBlockSize: type: integer format: int32 description: | Deprecated. Size in GB of each EBS auto-expandable block added when the volume begins to run out of free space. Only applies when ebs_auto_scale is enabled. This is NOT the root/boot volume size — use ebs_boot_size for that. This feature is deprecated and is not compatible with Fusion v2. deprecated: true example: 100 x-speakeasy-param-force-new: true # NOTE: dependency on ebs_auto_scale is enforced by `awsForgeValidator`. ebsBootSize: type: integer format: int32 description: | Size of the boot disk (root volume) in GB for EC2 instances in this compute environment. When using Fusion v2 without fast instance storage, this defaults to 100 GB with GP3 volume type. example: 100 x-speakeasy-param-force-new: true ec2KeyPair: type: string description: | EC2 key pair name for SSH access to compute instances. Key pair must exist in the specified region. example: "my-keypair" x-speakeasy-param-force-new: true ecsConfig: type: string description: | Custom ECS agent configuration parameters appended to the ECS config file on compute instances. Use for advanced ECS tuning. x-speakeasy-param-force-new: true efsCreate: type: boolean description: Automatically create an EFS file system example: false x-speakeasy-param-force-new: true # NOTE: mutual exclusion with efs_id is enforced by `awsForgeValidator`. efsId: type: string description: | EFS file system ID to mount. Format: fs- followed by hexadecimal characters. EFS must be in the same VPC and region. example: "fs-1234567890abcdef0" x-speakeasy-param-force-new: true efsMount: type: string description: | Path where EFS will be mounted in the container. example: "/mnt/efs" x-speakeasy-param-force-new: true fargateHeadEnabled: type: boolean description: | Run the Nextflow head job using the Fargate container service. This speeds up the launch of your pipeline execution. Requires `enable_fusion = true` and forge `type = "SPOT"`. Not compatible with EFS (`efs_create`, `efs_id`) or FSx (`fsx_name`) file systems. example: false x-speakeasy-param-force-new: true fsxMount: type: string description: | Path where FSx will be mounted in the container. example: "/fsx" x-speakeasy-param-force-new: true fsxName: type: string description: | FSx for Lustre file system name. example: "my-fsx-filesystem" x-speakeasy-param-force-new: true fsxSize: type: integer format: int32 description: | Size of FSx file system in GB. example: 1200 x-speakeasy-param-force-new: true gpuEnabled: type: boolean description: | Enable GPU support for compute instances. When enabled, GPU-capable instance types will be selected. example: false x-speakeasy-param-force-new: true imageId: type: string description: | Custom Amazon Machine Image (AMI) ID for compute instances. If not specified, AWS Batch selects the default ECS-optimized AMI. example: "ami-0123456789abcdef0" x-speakeasy-param-force-new: true instanceTypes: type: array items: type: string description: | List of EC2 instance types to use. Examples: ["m5.xlarge", "m5.2xlarge"], ["c5.2xlarge"], ["p3.2xlarge"] Default: ["optimal"] - AWS Batch selects appropriate instances example: ["m5.xlarge", "m5.2xlarge", "m5.xlarge", "m5.2xlarge"] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue maxCpus: type: integer format: int32 description: | Maximum number of CPUs available in the compute environment. Subject to AWS service quotas. example: 256 x-speakeasy-param-force-new: true minCpus: type: integer format: int32 description: | Minimum number of CPUs to maintain in the compute environment. Setting to 0 allows environment to scale to zero when idle. example: 0 x-speakeasy-param-force-new: true x-speakeasy-param-optional: true securityGroups: type: array items: type: string description: | List of security group IDs to attach to compute instances. Security groups must allow necessary network access. example: ["sg-12345678", "sg-12345678"] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue subnets: type: array items: type: string description: | List of subnet IDs for compute instances. Subnets must be in the specified VPC. Use multiple subnets for high availability. Must have sufficient IP addresses. example: ["subnet-12345", "subnet-67890", "subnet-12345", "subnet-67890"] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue type: type: string enum: - SPOT - EC2 description: | Type of compute instances to provision: - SPOT: Use EC2 Spot instances (cost-effective, can be interrupted) - EC2: Use On-Demand EC2 instances (reliable, higher cost) - FARGATE: Use AWS Fargate serverless compute example: "SPOT" x-speakeasy-param-force-new: true vpcId: type: string description: | VPC ID where compute environment will be deployed. Format: vpc- followed by hexadecimal characters example: "vpc-1234567890abcdef0" x-speakeasy-param-force-new: true x-speakeasy-plan-validators: FargateHeadValidator required: - type - minCpus - maxCpus 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 x-speakeasy-terraform-ignore: true password: type: string writeOnly: true nullable: true x-speakeasy-param-sensitive: true x-speakeasy-param-suppress-computed-diff: true token: type: string writeOnly: true nullable: true username: type: string nullable: true 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 x-speakeasy-terraform-ignore: true password: type: string writeOnly: true nullable: true token: type: string writeOnly: true nullable: true username: type: string nullable: true title: GitLab credentials GiteaSecurityKeys: type: object properties: discriminator: type: string x-speakeasy-terraform-ignore: true password: type: string writeOnly: true token: type: string writeOnly: true nullable: true username: type: string nullable: true title: Gitea credentials GithubActionConfig: type: object properties: discriminator: 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 description: | Kubernetes service account for compute/task pods (default: default account in the namespace). example: "default" x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean x-speakeasy-name-override: enable_fusion x-speakeasy-plan-validators: FusionEnabledValidator description: | Allow access to your cloud-hosted data via the Fusion v2 virtual distributed file system, speeding up most operations. Requires `enable_wave = true`. headJobCpus: type: integer format: int32 description: | Number of CPUs allocated for the Nextflow head/launcher pod. example: 4 x-speakeasy-param-force-new: true headJobMemoryMb: type: integer format: int32 description: | Memory allocation for the Nextflow head/launcher pod in MB. example: 8192 x-speakeasy-param-force-new: true headPodSpec: type: string description: | Custom pod specification (YAML) for the Nextflow head/launcher pod. Use for nodeSelector, affinity, tolerations, etc. x-speakeasy-param-force-new: true headServiceAccount: type: string description: | Kubernetes service account for the Nextflow head/launcher pod (default: tower-launcher-sa). Must have access to the storage bucket when using Fusion v2. example: "tower-launcher-sa" x-speakeasy-param-force-new: true namespace: type: string description: | Kubernetes namespace for running Nextflow workloads (default: tower-nf). example: "tower-nf" x-speakeasy-param-force-new: true nextflowConfig: type: string podCleanup: $ref: '#/components/schemas/PodCleanupPolicy' description: | Policy for cleaning up terminated pods. Controls when Kubernetes pods are deleted after completion. x-speakeasy-param-force-new: true 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 description: | GKE cluster API server endpoint URL. x-speakeasy-param-force-new: true servicePodSpec: type: string description: | Custom pod specification (YAML) for the compute environment service pod. x-speakeasy-param-force-new: true sslCert: type: string description: | SSL certificate for authenticating with the GKE cluster API server. x-speakeasy-param-force-new: true storageClaimName: type: string description: | Persistent Volume Claim name for the pipeline scratch filesystem (default: tower-scratch). Not required when using Fusion v2. example: "tower-scratch" x-speakeasy-param-force-new: true storageMountPath: type: string description: | Mount path for the persistent volume claim on the pod filesystem (default: /scratch). example: "/scratch" x-speakeasy-param-force-new: true waveEnabled: type: boolean title: "Wave Enabled" description: | Allow access to private container repositories and the provisioning of containers in your Nextflow pipelines via the Wave containers service. Required when `enable_fusion` is true. x-speakeasy-name-override: enable_wave workDir: description: Compute environment working directory type: string title: Google GKE cluster configuration required: - region - clusterName 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 description: | Size of the boot (persistent) disk in GB allocated per task and head job VM. example: 50 x-speakeasy-param-force-new: true computeJobsInstanceTemplate: type: string description: | Google Cloud instance template name or self-link for compute job VMs. Overrides other VM configuration settings for compute jobs. x-speakeasy-param-force-new: true computeJobsMachineType: type: array items: type: string description: | List of Google Cloud machine types compute jobs may use. x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue copyImage: type: string description: | Container image used for file staging (copying data to/from Cloud Storage). x-speakeasy-param-force-new: true cpuPlatform: type: string description: | Minimum CPU platform for compute instances (e.g., "Intel Cascade Lake"). See Google Cloud documentation for available CPU platforms per region. x-speakeasy-param-force-new: true debugMode: type: integer format: int32 description: | Debug mode level for the compute environment. Set to a non-zero value to enable additional debug logging. example: 0 x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' fusion2Enabled: type: boolean x-speakeasy-name-override: enable_fusion x-speakeasy-plan-validators: FusionEnabledValidator description: | Allow access to your cloud-hosted data via the Fusion v2 virtual distributed file system, speeding up most operations. Requires `enable_wave = true`. fusionSnapshots: type: boolean headJobCpus: type: integer format: int32 description: | Number of CPUs allocated for the Nextflow head job. example: 4 x-speakeasy-param-force-new: true headJobInstanceTemplate: type: string description: | Google Cloud instance template name or self-link for the Nextflow head job VM. Overrides other VM configuration settings for the head job. x-speakeasy-param-force-new: true headJobMemoryMb: type: integer format: int32 description: | Memory allocation for the Nextflow head job in MB. example: 8192 x-speakeasy-param-force-new: true labels: type: object additionalProperties: type: string description: | Static Google Cloud resource labels applied to compute resources at creation time, for cost tracking and organization. For per-run dynamic resource labels, attach seqera_labels via label_ids. x-speakeasy-param-force-new: true x-speakeasy-plan-validators: GoogleResourceLabelsValidator location: type: string description: | Google Cloud region where pipelines will execute (e.g., us-central1, europe-west1). example: "us-central1" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false machineType: type: string description: | Google Cloud machine type for compute instances (e.g., n1-standard-4, c2-standard-8). Supports patterns like "c2-*" to allow any machine in a family. example: "n1-standard-4" x-speakeasy-param-force-new: true network: type: string description: | Google Cloud VPC network name or self-link for compute instances. example: "default" x-speakeasy-param-force-new: true networkTags: type: array items: type: string description: | Network tags applied to compute instances for VPC firewall rule targeting. x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue nextflowConfig: type: string nfsMount: type: string description: | Local mount path for the NFS file system on compute instances. example: "/mnt/nfs" x-speakeasy-param-force-new: true nfsTarget: type: string description: | NFS server hostname or IP address for shared file system access. Format: hostname:/export/path x-speakeasy-param-force-new: true 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 x-speakeasy-plan-validators: RunScriptSizeValidator projectId: type: string description: | Google Cloud project for compute resources. Read-only and derived automatically from the credential; to use a different project, supply a credential for that project. x-speakeasy-param-readonly: true serviceAccount: type: string description: | Google Cloud service account email for compute instances. If not specified, the default compute service account is used. example: "my-sa@my-project.iam.gserviceaccount.com" x-speakeasy-param-force-new: true spot: type: boolean description: | Use Spot (preemptible) VMs for reduced cost. Spot VMs may be reclaimed by Google Cloud at any time, so pipelines must be able to handle interruptions. example: false x-speakeasy-param-force-new: true sshDaemon: type: boolean description: | Enable SSH daemon on compute instances for debugging access. example: false x-speakeasy-param-force-new: true sshImage: type: string description: | Custom container image for the SSH daemon sidecar. Only applicable when ssh_daemon is enabled. x-speakeasy-param-force-new: true subnetwork: type: string description: | Google Cloud VPC subnetwork name or self-link for compute instances. Must be in the same region as the compute environment location. x-speakeasy-param-force-new: true usePrivateAddress: type: boolean description: | Restrict compute instances to private IP addresses only (no public internet access). Instances must have access to Google APIs via Private Google Access or a NAT gateway. example: false x-speakeasy-param-force-new: true waveEnabled: type: boolean title: "Wave Enabled" description: | Allow access to private container repositories and the provisioning of containers in your Nextflow pipelines via the Wave containers service. Required when `enable_fusion` is true. x-speakeasy-name-override: enable_wave workDir: description: | Google Cloud Storage bucket path for Nextflow work directory where intermediate files will be stored. Format: gs://bucket-name/path type: string example: "gs://my-nextflow-bucket/work" pattern: "^gs://.+" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false title: Google Batch service configuration required: - location GoogleBucket: type: object properties: path: type: string GoogleCloudConfig: type: object properties: arm64Enabled: type: boolean description: | Enable ARM64 (Tau T2A) machine types for compute instances. When enabled, ARM-based machines will be selected for cost savings. example: false x-speakeasy-param-force-new: true bootDiskSizeGb: type: integer format: int32 description: | Size of the boot disk in GB for compute instances. example: 50 x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' description: | Array of environment variables for the compute environment. Each variable can target the head node, compute nodes, or both. fusion2Enabled: type: boolean x-speakeasy-terraform-ignore: true gpuEnabled: type: boolean description: | Enable GPU support for compute instances. When enabled, GPU-capable machine types will be selected. example: false x-speakeasy-param-force-new: true imageId: type: string description: | Custom VM image self-link or family for compute instances. If not specified, the default Seqera-managed image is used. x-speakeasy-param-force-new: true instanceType: type: string description: | Google Cloud machine type for compute instances (e.g., n1-standard-4, c2-standard-8). example: "n1-standard-4" x-speakeasy-param-force-new: true nextflowConfig: type: string description: | Nextflow configuration settings that override repository defaults. Applied globally to all pipelines launched in this compute environment. x-speakeasy-param-force-new: true 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 x-speakeasy-plan-validators: RunScriptSizeValidator 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 x-speakeasy-plan-validators: RunScriptSizeValidator projectId: type: string description: | Google Cloud project ID where compute resources will be created. example: "my-gcp-project" x-speakeasy-param-force-new: true region: type: string description: | Google Cloud region where the compute environment will be created. Examples: us-central1, europe-west1, asia-east1 example: "us-central1" x-speakeasy-param-optional: false x-speakeasy-param-force-new: true serviceAccountEmail: type: string description: | Google Cloud service account email for compute instances. If not specified, the default compute service account is used. example: "my-sa@my-project.iam.gserviceaccount.com" x-speakeasy-param-force-new: true waveEnabled: type: boolean x-speakeasy-terraform-ignore: true workDir: description: | Google Cloud Storage bucket path for Nextflow work directory where intermediate files will be stored. Format: gs://bucket-name/path type: string title: "Google Cloud Storage Work Directory" example: "gs://my-nextflow-bucket/work" pattern: "^gs://.+" x-speakeasy-param-optional: false x-speakeasy-param-force-new: true zone: type: string description: | Google Cloud zone within the configured region (e.g., us-central1-a). If not specified, the platform selects a zone automatically. example: "us-central1-a" x-speakeasy-param-force-new: true 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' 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 description: | Size of the boot disk in GB for compute VMs. example: 50 x-speakeasy-param-force-new: true copyImage: type: string description: | Container image used for file staging (copying data to/from Cloud Storage). x-speakeasy-param-force-new: true debugMode: type: integer format: int32 description: | Debug mode level. Set to a non-zero value to enable additional debug logging. example: 0 x-speakeasy-param-force-new: true discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true environment: type: array items: $ref: '#/components/schemas/ConfigEnvVariable' headJobCpus: type: integer format: int32 description: | Number of CPUs allocated for the Nextflow head job. example: 4 x-speakeasy-param-force-new: true headJobMemoryMb: type: integer format: int32 description: | Memory allocation for the Nextflow head job in MB. example: 8192 x-speakeasy-param-force-new: true labels: type: object additionalProperties: type: string description: | Static Google Cloud resource labels applied to compute resources at creation time, for cost tracking and organization. For per-run dynamic resource labels, attach seqera_labels via label_ids. x-speakeasy-param-force-new: true x-speakeasy-plan-validators: GoogleResourceLabelsValidator location: type: string description: | Google Cloud location for the Life Sciences API endpoint. example: "us-central1" x-speakeasy-param-force-new: true nextflowConfig: type: string nfsMount: type: string description: | Local mount path for the NFS file system on compute instances. example: "/mnt/nfs" x-speakeasy-param-force-new: true nfsTarget: type: string description: | NFS server hostname or IP address for shared file system access. Format: hostname:/export/path x-speakeasy-param-force-new: true 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 description: | Use preemptible VMs for reduced cost. Preemptible VMs may be reclaimed at any time and last at most 24 hours. example: false x-speakeasy-param-force-new: true 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 description: | Google Cloud project for compute resources. Read-only and derived automatically from the credential; to use a different project, supply a credential for that project. x-speakeasy-param-readonly: true region: type: string description: | Google Cloud region for the Life Sciences API (e.g., us-central1, europe-west1). example: "us-central1" x-speakeasy-param-force-new: true sshDaemon: type: boolean description: | Enable SSH daemon on compute instances for debugging access. example: false x-speakeasy-param-force-new: true sshImage: type: string description: | Custom container image for the SSH daemon sidecar. Only applicable when ssh_daemon is enabled. x-speakeasy-param-force-new: true usePrivateAddress: type: boolean description: | Restrict compute instances to private IP addresses only (no public internet access). Instances must have access to Google APIs via Private Google Access or a NAT gateway. example: false x-speakeasy-param-force-new: true workDir: description: Compute environment working directory type: string zones: type: array items: type: string description: | List of Google Cloud zones where compute instances can be created. Zones must be within the specified region. example: ["us-central1-a", "us-central1-b"] x-speakeasy-param-force-new: true title: Google Life Sciences configuration (retired) 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 nullable: true x-speakeasy-param-sensitive: true x-speakeasy-param-suppress-computed-diff: true discriminator: type: string x-speakeasy-terraform-ignore: true serviceAccountEmail: type: string tokenAudience: type: string workloadIdentityProvider: type: string title: Google credentials x-speakeasy-plan-validators: GoogleKeysCrdentialValidator 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 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: array nullable: true items: type: string description: Iterator of strings (can be null) JobCleanupPolicy: type: string enum: - on_success - always - never x-enum-varnames: - on_success - always - never JobInfoDto: type: object properties: exitCode: type: integer format: int32 nullable: true id: type: integer format: int64 message: type: string nullable: true operationId: type: string nullable: true status: type: string nullable: true nullable: true 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 x-speakeasy-terraform-ignore: true 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 required: - server - namespace - sslCert - headServiceAccount - storageClaimName 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 writeOnly: true nullable: true discriminator: type: string x-speakeasy-terraform-ignore: true privateKey: type: string writeOnly: true nullable: true token: type: string writeOnly: true nullable: true title: Kubernetes credentials LabelDbDto: type: object properties: dateCreated: type: string format: date-time description: Timestamp when the label was created id: type: integer format: int64 x-speakeasy-param-readonly: true description: Unique numeric identifier for the label isDefault: type: boolean description: Flag indicating if this is a default system label name: type: string description: Name or key of the label resource: type: boolean description: Flag indicating if this is a resource-level label value: type: string nullable: true description: Value associated with the label description: | Represents a label for organizing and categorizing resources. Provides metadata tagging capabilities for pipelines, workflows, and other platform resources. 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 LaunchDbDto: type: object properties: computeEnv: x-speakeasy-param-readonly: true allOf: - $ref: "#/components/schemas/ComputeEnv_ComputeConfig_" x-speakeasy-terraform-ignore: true configProfiles: type: array items: type: string configText: type: string nullable: true description: Nextflow configuration text x-speakeasy-param-computed: false entryName: type: string maxLength: 80 nullable: true description: Entry workflow name x-speakeasy-param-computed: false headJobCpus: type: integer format: int32 nullable: true description: Head job CPU allocation x-speakeasy-param-computed: false headJobMemoryMb: type: integer format: int32 nullable: true description: Head job memory allocation in MB x-speakeasy-param-computed: false id: type: string x-speakeasy-param-readonly: true launchContainer: type: string x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true mainScript: type: string maxLength: 200 nullable: true description: Main script path x-speakeasy-param-computed: false optimizationId: type: string nullable: true description: Optimization profile ID x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true optimizationTargets: type: string nullable: true description: Optimization targets x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true paramsText: type: string nullable: true description: Pipeline parameters text x-speakeasy-param-computed: false pipeline: type: string pipelineSchemaId: type: integer format: int64 x-speakeasy-param-computed: false postRunScript: type: string nullable: true description: Script to run after pipeline execution x-speakeasy-param-computed: false preRunScript: type: string nullable: true description: Script to run before pipeline execution x-speakeasy-param-computed: false pullLatest: type: boolean resume: type: boolean x-speakeasy-terraform-ignore: true resumeLaunchId: type: string maxLength: 22 nullable: true description: Launch ID to resume from x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true revision: type: string maxLength: 100 nullable: true description: Pipeline revision x-speakeasy-param-computed: false runName: type: string maxLength: 80 nullable: true description: Custom run name x-speakeasy-param-computed: false schemaName: type: string maxLength: 100 nullable: true description: Pipeline schema name x-speakeasy-param-computed: false sessionId: type: string maxLength: 36 nullable: true description: Session ID for resuming x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true stubRun: type: boolean syntaxParser: type: string enum: - v1 - v2 nullable: true towerConfig: type: string nullable: true description: Tower-specific configuration x-speakeasy-param-computed: false userSecrets: type: array items: type: string workDir: type: string nullable: true description: Working directory x-speakeasy-param-computed: false workspaceId: type: integer format: int64 x-speakeasy-param-suppress-computed-diff: true workspaceSecrets: type: array items: 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 nullable: true error: type: string event: $ref: '#/components/schemas/Action.EventType' hint: type: string id: type: string labels: type: array items: $ref: '#/components/schemas/LabelDbDto' nullable: true lastSeen: type: string format: date-time nullable: true description: Last seen timestamp (null if never seen) name: type: string nullable: true nextExecution: type: string format: date-time pipeline: type: string nullable: true description: Pipeline name source: $ref: '#/components/schemas/Action.Source' type: string nullable: true status: $ref: '#/components/schemas/Action.Status' usageCmd: type: string nullable: true 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 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 status: $ref: '#/components/schemas/ComputeEnv.Status' visibility: type: string 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' ListLabelsResponse: type: object properties: {} 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 nullable: true description: Whether workflow is optimized orgId: type: integer format: int64 nullable: true description: Organization ID orgName: type: string nullable: true description: Organization name pipelineInfo: $ref: '#/components/schemas/PipelineMinInfoResponse' progress: $ref: '#/components/schemas/ProgressData' starred: type: boolean nullable: true description: Whether workflow is starred workflow: $ref: '#/components/schemas/WorkflowDbDto' workspaceId: type: integer format: int64 nullable: true description: Workspace ID workspaceName: type: string nullable: true description: Workspace name 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' x-speakeasy-name-override: intelligent_compute_config schedEnabled: type: boolean x-speakeasy-name-override: intelligent_compute_enabled waveEnabled: type: boolean workDir: description: Compute environment working directory type: string title: Local execution configuration required: - workDir 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: type: array nullable: true items: type: string description: Log entries (can be null) forwardToken: type: string nullable: true message: type: string nullable: true description: Log message (can be null) pending: type: boolean rewindToken: type: string nullable: true 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 x-speakeasy-terraform-ignore: true 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 required: - workDir ManagedCredentialsDbDto: type: object properties: id: type: integer format: int64 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 Map.Entry_String.String_: type: object properties: key: type: string value: type: string MemberDbDto: type: object properties: avatar: type: string email: type: string firstName: type: string lastName: type: string memberId: type: integer format: int64 role: $ref: '#/components/schemas/OrgRole' userId: type: integer format: int64 userName: type: string MoabComputeConfig: type: object properties: computeQueue: type: string discriminator: description: property to select the compute config platform type: string x-speakeasy-terraform-ignore: true 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 required: - workDir 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' NavbarConfig.NavbarMenu: type: object properties: label: type: string url: type: string 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 OrgRole: type: string enum: - owner - member - collaborator x-enum-varnames: - owner - member - collaborator 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 nullable: true description: Detailed description of the organization's purpose and activities. example: "Put your organization description here" fullName: type: string maxLength: 100 description: Complete formal display name of the organization. Required. example: "My Organization" id: type: integer format: int64 nullable: true readOnly: true x-speakeasy-param-optional: true lastUpdated: type: string format: date-time readOnly: true location: type: string maxLength: 100 nullable: true description: Geographic location or address of the organization. example: "Toronto, CA" name: type: string maxLength: 40 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ description: Short name or handle for the organization (used in URLs and resource paths). Required. example: "my-org" website: type: string pattern: '' nullable: true description: Official website URL for the organization. example: "https://www.mybiotech.com" required: - fullName - name x-speakeasy-entity: Orgs x-speakeasy-entity-description: | Manage your organization in Seqera platform using this resource. Organizations are the top-level structure and contain workspaces, members, and teams. You can create multiple organizations, each of which can contain multiple workspaces with shared users and resources. This means you can customize and organize the use of resources while maintaining an access control layer for users associated with a workspace. ~> **Warning:** Destroying an organization resource will permanently delete the organization and all its associated resources including workspaces, members, teams, compute environments, pipelines, and credentials. This action cannot be undone. Use Terraform lifecycle rules to protect critical organizations from accidental deletion: ```terraform resource "seqera_orgs" "production" { name = "production-org" full_name = "Production Organization" lifecycle { prevent_destroy = true } } ``` OrganizationDbDto: type: object properties: description: type: string nullable: true description: Detailed description of the organization's purpose and activities fullName: type: string nullable: true description: Complete formal display name of the organization location: type: string nullable: true description: Geographic location or address of the organization memberId: type: integer format: int64 nullable: true description: Member ID (can be null for collaborators) memberRole: type: string nullable: true enum: - owner - member - collaborator description: Member role (can be null for collaborators) name: type: string description: Short name or handle for the organization (used in URLs and paths) orgId: type: integer format: int64 description: Unique numeric identifier for the organization website: type: string nullable: true description: Official website URL for the organization id: type: integer format: int64 description: Alias of `org_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Orgs x-speakeasy-transform-from-api: jq: '. + { id: .orgId }' description: | Represents an organization in the Seqera Platform. Contains organizational metadata, settings, and member management information for multi-tenant environments. 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 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: description: type: string nullable: true description: Detailed description of the pipeline's purpose and functionality x-speakeasy-param-ordering: 3 icon: type: string nullable: true description: Icon identifier or URL for visual representation x-speakeasy-param-ordering: 5 name: type: string description: Display name for the pipeline x-speakeasy-param-ordering: 2 pipelineId: type: integer format: int64 description: Unique numeric identifier for the pipeline x-speakeasy-param-ordering: 1 x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true repository: type: string description: Git repository URL containing the pipeline source code x-speakeasy-param-ordering: 4 userFirstName: type: string nullable: true description: User first name x-speakeasy-param-suppress-computed-diff: true userId: type: integer format: int64 x-speakeasy-param-suppress-computed-diff: true userName: type: string x-speakeasy-param-suppress-computed-diff: true version: $ref: '#/components/schemas/PipelineVersionFullInfoDto' workspaceId: type: integer format: int64 id: type: integer format: int64 description: Alias of `pipeline_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Pipeline x-speakeasy-entity-description: | Manage saved pipeline definitions on the Seqera Platform Launchpad. A `seqera_pipeline` is a reusable launch template — repository, revision, default parameters, and a default compute environment — that users can launch on demand from the UI or API. Reach for `seqera_workflows` instead when Terraform itself should trigger an individual workflow run (for example, a validation launch after a compute environment change). description: | Represents a pipeline configuration in the Seqera Platform. Contains pipeline metadata, configuration settings, and execution parameters for Nextflow workflows. x-speakeasy-transform-from-api: jq: ". + { id: .pipelineId }" PipelineInfo: type: object properties: commitId: type: string nullable: true provider: type: string x-speakeasy-name-override: repositoryProvider revisionName: type: string nullable: true 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 nullable: true 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 x-speakeasy-param-readonly: true description: Timestamp when the secret was created id: type: integer format: int64 nullable: true x-speakeasy-param-readonly: true description: Unique numeric identifier for the secret lastUpdated: type: string format: date-time readOnly: true lastUsed: type: string format: date-time readOnly: true nullable: true description: Timestamp when the secret was last accessed by a workflow x-speakeasy-param-readonly: true name: type: string maxLength: 100 pattern: ^[a-zA-Z_][0-9A-Za-z_]*$ description: Secret name used to reference the secret in workflows (max 100 characters). Required. required: - name x-speakeasy-entity: PipelineSecret x-speakeasy-entity-description: | Manage secure secrets for pipeline execution. Pipeline secrets store encrypted sensitive data such as API keys, passwords, and configuration values used in workflows, providing secure access to external services and resources. description: | Represents a secure secret for pipeline execution. Contains encrypted sensitive data such as API keys, passwords, and configuration values used in workflows. 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' grid: '#/components/schemas/GridPlatformMetainfo' k8s-platform: '#/components/schemas/K8sPlatformMetaInfo' local-platform: '#/components/schemas/LocalPlatformMetainfo' propertyName: discriminator oneOf: - $ref: "#/components/schemas/AwsBatchPlatformMetainfo" - $ref: "#/components/schemas/AwsCloudPlatformMetainfo" - $ref: "#/components/schemas/GooglePlatformMetainfo" - $ref: "#/components/schemas/AzBatchPlatformMetainfo" - $ref: "#/components/schemas/EksPlatformMetaInfo" - $ref: "#/components/schemas/GkePlatformMetaInfo" - $ref: "#/components/schemas/K8sPlatformMetaInfo" - $ref: "#/components/schemas/GridPlatformMetainfo" - $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 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 running: type: integer format: int64 submitted: type: integer format: int64 succeeded: 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 - invCtxSwitch - loadCpus - loadMemory - loadTasks - memoryReq - memoryRss - peakCpus - peakMemory - peakTasks - pending - process - readBytes - 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' nullable: true 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 nullable: true RoleDto: type: object properties: description: type: string minLength: 1 maxLength: 120 description: Human-readable description of what the role grants. isPredefined: type: boolean description: Always `false` for roles managed by this resource. x-speakeasy-name-override: is_predefined x-speakeasy-param-readonly: true name: type: string maxLength: 40 description: | Role name. Unique within the organization. Up to 40 characters. Changing the name replaces the role — Terraform will destroy the existing custom role and create a new one. Workspace participants assigned to the old role need to be reassigned via `seqera_workspace_participant`. x-speakeasy-param-force-new: true permissions: type: array items: type: string uniqueItems: true description: | Set of permission strings the role grants. Permission names follow the `resource:verb` convention (e.g. `pipeline:read`, `workflow:execute`, `compute_environment:write`). The full catalogue can be retrieved from `GET /roles/permissions`. x-speakeasy-entity: CustomRole x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: custom_role required: - name - description - permissions x-speakeasy-entity-description: | Manage a custom role in a Seqera organization. Custom roles are named permission sets that admins can assign to workspace participants alongside the predefined `owner` / `admin` / `maintain` / `launch` / `view` / `connect` roles. Renaming a role is supported in place — assignments on existing participants are automatically updated to track the new name. Custom roles require the `CUSTOM_ROLES` feature toggle on the organization's tier. Without it the API returns HTTP 403. There is also a per-org quota (`tower.limits.max-custom-roles`, default 20); reaching it surfaces as HTTP 400 on create. 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 nullable: true discriminator: type: string pathStyleAccessEnabled: type: boolean secretKey: type: string writeOnly: true nullable: true title: S3-compatible credentials SSHSecurityKeys: type: object properties: discriminator: type: string x-speakeasy-terraform-ignore: true passphrase: type: string writeOnly: true nullable: true privateKey: type: string writeOnly: true nullable: true title: SSH credentials SchedConfig: type: object properties: machineTypes: description: | EC2 instance types eligible for Seqera Intelligent Compute nodes. Leave empty (`[]`) to let the scheduler pick the most cost-optimal types per task. When populated, the scheduler is restricted to this whitelist; types outside the platform's filtered catalog for the scheduler are accepted by the API but may produce warnings. type: array items: type: string example: [] x-speakeasy-param-force-new: true x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework/types/basetypes schemaType: "basetypes.ListType{ElemType: basetypes.StringType{}}" valueType: basetypes.ListValue provisioningModel: type: string enum: - spot - spotFirst - ondemand - spot - spotFirst - ondemand description: | EC2 provisioning strategy for Seqera Intelligent Compute nodes. Case-sensitive — must be one of: - `spotFirst` (default): try spot instances first, fall back to on-demand if capacity is unavailable. Recommended for cost. - `spot`: spot instances only — lower cost, but jobs may be interrupted if capacity is reclaimed. - `ondemand`: on-demand instances only — maximum reliability at a higher cost. Note: `"onDemand"` / `"on-demand"` are rejected by the API. default: spotFirst example: "spotFirst" x-speakeasy-param-force-new: true SecurityGroup: type: object properties: id: type: string name: type: string vpcId: type: string SecurityKeys: type: object properties: discriminator: type: string x-speakeasy-terraform-ignore: true 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' x-speakeasy-param-computed: false 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 required: - region # Pipeline requests SeqeraComputeSecurityKeys: type: object properties: accessKey: type: string assumeRoleArn: type: string discriminator: type: string x-speakeasy-terraform-ignore: true secretKey: type: string writeOnly: true title: Seqera Compute credentials ServiceInfo: type: object properties: allowInstanceCredentials: type: boolean allowLocalRepos: type: boolean deprecated: true allowNextflowCliLogs: type: boolean analytics: $ref: '#/components/schemas/Analytics' apiVersion: type: string authTypes: type: array items: type: string commitId: type: string contactEmail: type: string contentMaxFileSize: type: integer format: int64 contentUrl: type: string evalWorkspaceIds: type: array items: format: int64 type: integer forgePrefix: type: string groundswellAllowedWorkspaces: type: array items: format: int64 type: integer groundswellEnabled: type: boolean heartbeatInterval: type: integer format: int32 landingUrl: type: string launchParamsTextMaxSize: type: integer format: int32 llmEnabled: type: boolean loginPath: type: string logoutUrl: type: string nullable: true navbar: $ref: '#/components/schemas/NavbarConfig' 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 x-speakeasy-terraform-ignore: true 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 required: - workDir SourceType: type: string enum: - UPLOADED - LINKED State: type: string enum: - UNKNOWN - QUEUED - INITIALIZING - RUNNING - PAUSED - COMPLETE - EXECUTOR_ERROR - SYSTEM_ERROR - CANCELED - CANCELING nullable: true StudioCheckpointStatus: type: string enum: - empty - interim - finalized - invalid x-enum-varnames: - empty - interim - finalized - invalid nullable: true 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' required: - launch SubmitWorkflowLaunchResponse: type: object properties: workflowId: type: string x-speakeasy-param-suppress-computed-diff: true Subnet: type: object properties: id: type: string vpcId: type: string zone: type: string Task: type: object properties: attempt: type: integer format: int32 nullable: true description: Attempt number cloudZone: type: string nullable: true description: Cloud zone/region complete: type: string format: date-time nullable: true description: Task completion time container: type: string nullable: true description: Container image cost: type: number nullable: true description: Estimated cost cpus: type: integer format: int32 nullable: true description: CPU allocation dateCreated: type: string format: date-time nullable: true disk: type: integer format: int64 nullable: true description: Disk allocation in bytes duration: type: integer format: int64 nullable: true description: Task duration in milliseconds env: type: string nullable: true description: Environment variables errorAction: type: string nullable: true description: Error handling action errorMessage: type: string nullable: true executor: type: string nullable: true description: Executor name exit: type: string format: int32 nullable: true description: Task exit value (can be string) exitStatus: type: integer format: int32 nullable: true description: Exit status code gpuMetrics: allOf: - $ref: '#/components/schemas/GpuMetrics' nullable: true hash: type: string id: type: integer format: int64 nullable: true invCtxt: type: integer format: int64 nullable: true description: Involuntary context switches lastUpdated: type: string format: date-time nullable: true logStreamId: type: string machineType: type: string nullable: true description: Cloud machine type memory: type: integer format: int64 nullable: true description: Memory allocation in bytes module: type: array items: type: string name: type: string nativeId: type: string nullable: true description: Native job ID from executor numSpotInterruptions: type: integer format: int32 pcpu: type: number format: double nullable: true description: CPU usage percentage peakRss: type: integer format: int64 nullable: true description: Peak resident set size peakVmem: type: integer format: int64 nullable: true description: Peak virtual memory size pmem: type: number format: double nullable: true description: Memory usage percentage priceModel: $ref: '#/components/schemas/CloudPriceModel' process: type: string nullable: true description: Process name queue: type: string nullable: true description: Execution queue rchar: type: integer format: int64 nullable: true description: Characters read readBytes: type: integer format: int64 nullable: true description: Bytes read from disk realtime: type: integer format: int64 nullable: true description: Real execution time in milliseconds resourceAllocation: $ref: '#/components/schemas/ResourceAllocation' rss: type: integer format: int64 nullable: true description: Resident set size scratch: type: string nullable: true description: Scratch directory script: type: string nullable: true description: Task script start: type: string format: date-time nullable: true description: Task start time status: $ref: '#/components/schemas/TaskStatus' submit: type: string format: date-time nullable: true description: Task submission time syscr: type: integer format: int64 nullable: true description: System read calls syscw: type: integer format: int64 nullable: true description: System write calls tag: type: string nullable: true description: Task tag taskId: type: integer format: int64 time: type: integer format: int64 nullable: true description: Time limit in milliseconds vmem: type: integer format: int64 nullable: true description: Virtual memory size volCtxt: type: integer format: int64 nullable: true description: Voluntary context switches wchar: type: integer format: int64 nullable: true description: Characters written workdir: type: string nullable: true description: Working directory writeBytes: type: integer format: int64 nullable: true description: Bytes written to disk 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 nullable: true description: Team description example: "Team responsible for bioinformatics analysis and pipeline development" id: type: integer format: int64 nullable: true readOnly: true x-speakeasy-param-optional: true x-speakeasy-name-override: teamId lastUpdated: type: string format: date-time readOnly: true name: type: string maxLength: 40 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ example: "bioinformatics-team" required: - name x-speakeasy-entity: Teams x-speakeasy-entity-description: | Manage teams within organizations. Teams are organizational units that allow organization owners to group users together, managing team members and access permissions as a whole. TeamDbDto: type: object properties: avatarUrl: type: string description: URL to the team's avatar or profile image description: type: string nullable: true description: Description of the team's purpose and responsibilities membersCount: type: integer format: int64 description: Total number of members in the team name: type: string description: Display name for the team teamId: type: integer format: int64 x-speakeasy-param-optional: true x-speakeasy-name-override: teamId description: Unique numeric identifier for the team id: type: integer format: int64 description: Alias of `team_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true x-speakeasy-entity: Teams x-speakeasy-transform-from-api: jq: '. + { id: .teamId }' description: | Represents a team within an organization. Contains team membership, permissions, and access controls for collaborative workspace management. 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 nullable: true 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 x-speakeasy-terraform-ignore: true 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 required: - workDir UpdateActionRequest: type: object properties: bucket: $ref: '#/components/schemas/BucketActionRequest' cron: $ref: '#/components/schemas/CronActionRequest' launch: $ref: '#/components/schemas/ActionLaunchRequest' name: type: string UpdateComputeEnvRequest: type: object properties: credentialsId: type: string description: type: string maxLength: 2000 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 description: "Whether this label is automatically applied to new resources. Can only be true when resource=true." x-speakeasy-plan-validators: LabelIsDefaultValidator name: type: string title: "Label Name" description: "Label name (key). Must be 2-39 alphanumeric characters, dashes, or underscores. Example: 'environment', 'team', 'cost-center'" example: "environment" x-speakeasy-plan-validators: LabelNameValidator value: type: string title: "Label Value" description: "Label value. Must be 2-39 alphanumeric characters, dashes, or underscores, or a dynamic placeholder (${sessionId}, ${workflowId}, ${userName}) for resource labels. Required when resource=true. Example: 'production', 'data-science', '${sessionId}'" example: "production" x-speakeasy-plan-validators: LabelValueResourceValidator 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 nullable: true description: Icon identifier or URL for visual representation labelIds: type: array items: format: int64 type: integer launch: $ref: '#/components/schemas/WorkflowLaunchRequest' name: type: string title: "Pipeline Name" description: "Pipeline name must contain a minimum of 2 and a maximum of 99 alphanumeric characters separated by dashes, dots or underscores" example: "rna-seq-analysis" x-speakeasy-plan-validators: PipelineNameValidator UpdatePipelineResponse: type: object properties: pipeline: $ref: '#/components/schemas/PipelineDbDto' UpdatePipelineSecretRequest: type: object properties: value: type: string x-speakeasy-param-sensitive: true 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 name: type: string 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 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 required: - email - userName UserInfo: type: object properties: avatar: type: string email: type: string id: type: integer format: int64 userName: type: string nullable: true UserResponseDto: type: object properties: avatar: type: string avatarId: type: string dateCreated: type: string format: date-time deleted: type: boolean description: type: string email: type: string firstName: type: string id: type: integer format: int64 lastAccess: type: string format: date-time lastName: type: string lastUpdated: type: string format: date-time marketingConsent: type: boolean notification: type: boolean organization: type: string termsOfUseConsent: type: boolean userName: type: string 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 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 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 x-speakeasy-param-optional: false Vpc: type: object properties: id: type: string isDefault: type: boolean 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 nullable: true defaultBranch: type: string maxLength: 20 nullable: true description: type: string maxLength: 1024 nullable: true gitmodules: type: string maxLength: 150 nullable: true homePage: type: string maxLength: 200 nullable: true icon: type: string maxLength: 255 nullable: true mainScript: type: string maxLength: 100 nullable: true name: type: string maxLength: 150 nullable: true nextflowVersion: type: string maxLength: 20 nullable: true version: type: string maxLength: 20 nullable: true nullable: true WfNextflow: type: object properties: build: type: string maxLength: 10 timestamp: type: string format: date-time version: type: string maxLength: 20 nullable: true WfStats: type: object properties: cachedCount: type: integer format: int32 nullable: true cachedCountFmt: type: string nullable: true cachedDuration: type: integer format: int64 nullable: true cachedPct: type: number format: float nullable: true computeTimeFmt: type: string maxLength: 50 nullable: true failedCount: type: integer format: int32 nullable: true failedCountFmt: type: string nullable: true failedDuration: type: integer format: int64 nullable: true failedPct: type: number format: float nullable: true ignoredCount: type: integer format: int32 nullable: true ignoredCountFmt: type: string nullable: true ignoredPct: type: number format: float nullable: true succeedCount: type: integer format: int32 nullable: true succeedCountFmt: type: string nullable: true succeedDuration: type: integer format: int64 nullable: true succeedPct: type: number format: float nullable: true nullable: true WfWaveMeta: type: object properties: enabled: type: boolean Workflow: type: object properties: commandLine: type: string maxLength: 8096 complete: type: string format: date-time nullable: true description: Workflow completion time (null if not completed) configFiles: type: array items: type: string nullable: true configText: type: string nullable: true container: type: string nullable: true containerEngine: type: string nullable: true dateCreated: type: string format: date-time nullable: true readOnly: true deleted: type: boolean readOnly: true nullable: true duration: type: integer format: int64 nullable: true errorMessage: type: string nullable: true description: Error message (null if no error) errorReport: type: string nullable: true description: Error report (null if no error) exitStatus: type: integer format: int32 nullable: true homeDir: type: string nullable: true id: type: string maxLength: 16 lastUpdated: type: string format: date-time nullable: true readOnly: true launchDir: type: string nullable: true launchId: type: string maxLength: 22 nullable: true logFile: type: string maxLength: 255 nullable: true manifest: $ref: '#/components/schemas/WfManifest' nextflow: $ref: '#/components/schemas/WfNextflow' operationId: type: string maxLength: 110 nullable: true outFile: type: string maxLength: 255 nullable: true ownerId: type: integer format: int64 readOnly: true params: type: object additionalProperties: true nullable: true profile: type: string maxLength: 100 nullable: true projectDir: type: string nullable: true projectName: type: string maxLength: 200 repository: type: string nullable: true requiresAttention: type: boolean resume: type: boolean nullable: true revision: type: string maxLength: 100 nullable: true runName: type: string maxLength: 80 scriptFile: type: string nullable: true scriptId: type: string maxLength: 40 nullable: true scriptName: type: string maxLength: 100 nullable: true sessionId: type: string maxLength: 36 start: type: string format: date-time nullable: true description: Workflow start time (null if not started) stats: $ref: '#/components/schemas/WfStats' status: $ref: '#/components/schemas/WorkflowStatus' submit: type: string format: date-time success: type: boolean nullable: true userName: type: string maxLength: 40 workDir: type: string required: - commandLine - projectName - runName - sessionId - submit - userName - workDir WorkflowDbDto: type: object properties: commandLine: type: string nullable: true description: Command line x-speakeasy-terraform-ignore: true complete: type: string format: date-time nullable: true description: Timestamp when the workflow execution completed x-speakeasy-param-readonly: true configFiles: type: array items: type: string nullable: true description: Config files (can be null) x-speakeasy-terraform-ignore: true configText: type: string nullable: true description: Config text x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time x-speakeasy-param-readonly: true deleted: type: boolean nullable: true description: Whether the workflow is deleted x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true id: type: string description: Unique identifier for the workflow execution x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time x-speakeasy-param-readonly: true launchId: type: string nullable: true description: Launch ID ownerId: type: integer format: int64 nullable: true description: Numeric identifier of the user who owns this workflow x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true params: type: object additionalProperties: true nullable: true description: Workflow parameters (can be null) x-speakeasy-terraform-ignore: true profile: type: string nullable: true description: Profile x-speakeasy-terraform-ignore: true projectName: type: string nullable: true description: Project name repository: type: string nullable: true description: Repository requiresAttention: type: boolean nullable: true description: Requires attention flag x-speakeasy-terraform-ignore: true resume: type: boolean nullable: true description: Resume flag revision: type: string nullable: true description: Revision runName: type: string nullable: true description: Run name scriptName: type: string nullable: true description: Script name x-speakeasy-terraform-ignore: true sessionId: type: string nullable: true description: Session ID start: type: string format: date-time nullable: true description: Timestamp when the workflow execution actually started x-speakeasy-param-readonly: true status: $ref: '#/components/schemas/WorkflowStatus' x-speakeasy-param-readonly: true submit: type: string format: date-time description: Timestamp when the workflow was submitted for execution x-speakeasy-param-readonly: true workDir: type: string nullable: true description: Work directory description: | Represents a workflow execution record. Contains execution status, metadata, and results from pipeline runs including logs and performance metrics. WorkflowLaunchRequest: type: object properties: computeEnvId: type: string x-speakeasy-param-optional: true example: "4g09tT4pW4JFUvXTHdB6zP" configProfiles: type: array items: type: string default: [] example: ["docker", "aws"] configText: type: string nullable: true description: Nextflow configuration text x-speakeasy-param-computed: false example: | process { executor = 'awsbatch' queue = 'my-queue' } entryName: type: string nullable: true description: Entry workflow name x-speakeasy-param-computed: false example: "main.nf" headJobCpus: type: integer format: int32 nullable: true description: Head job CPU allocation x-speakeasy-param-computed: false example: 2 headJobMemoryMb: type: integer format: int32 nullable: true description: Head job memory allocation in MB x-speakeasy-param-computed: false example: 4096 id: type: string description: Server-generated launch identifier. x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true labelIds: type: array items: format: int64 type: integer example: [1001, 1002, 1003] mainScript: type: string nullable: true description: Main script path x-speakeasy-param-computed: false example: "main.nf" paramsText: type: string nullable: true description: Pipeline parameters text x-speakeasy-param-computed: false example: | { "input": "s3://my-bucket/input.csv", "output_dir": "s3://my-bucket/results" } pipeline: type: string example: "https://github.com/nextflow-io/hello" pipelineSchemaId: type: integer format: int64 x-speakeasy-param-computed: false postRunScript: type: string nullable: true description: Script to run after pipeline execution x-speakeasy-param-computed: false example: | #!/bin/bash echo "Workflow completed" aws s3 sync ./results s3://my-bucket/results x-speakeasy-plan-validators: RunScriptSizeValidator preRunScript: type: string nullable: true description: Script to run before pipeline execution x-speakeasy-param-computed: false example: | #!/bin/bash echo "Starting workflow execution" aws s3 sync s3://my-bucket/data ./data x-speakeasy-plan-validators: RunScriptSizeValidator pullLatest: type: boolean default: false example: true resume: type: boolean x-speakeasy-terraform-ignore: true revision: type: string nullable: true description: Pipeline revision x-speakeasy-param-computed: false example: "main" runName: type: string nullable: true description: Custom run name x-speakeasy-param-computed: false example: "nextflow-hello" schemaName: type: string nullable: true description: Pipeline schema name x-speakeasy-param-computed: false example: "nextflow_schema.json" stubRun: type: boolean default: false example: false syntaxParser: type: string enum: - v1 - v2 nullable: true towerConfig: type: string nullable: true description: Tower-specific configuration x-speakeasy-param-computed: false userSecrets: type: array items: type: string default: [] example: ["MY_API_KEY", "DATABASE_PASSWORD"] workDir: type: string nullable: true description: Working directory for pipeline execution. Must start with a valid cloud storage prefix (s3://, gs://, az://) or be an absolute local path (/). Do not include a trailing slash — the API strips trailing slashes at launch time, which causes plan diffs. Required for pipelines in private workspaces and personal context; optional for shared workspaces. You can reference the work_dir from your compute environment instead of duplicating the value, e.g. seqera_compute_env.my_ce.compute_env.config.aws_batch.work_dir or seqera_aws_batch_compute_env.my_ce.config.work_dir. title: "Working Directory" example: "s3://my-bucket/work" x-speakeasy-plan-validators: WorkDirFormatValidator x-speakeasy-param-optional: true x-speakeasy-param-computed: false workspaceSecrets: type: array items: type: string default: [] example: ["WORKSPACE_TOKEN", "SHARED_CREDENTIALS"] required: [pipeline, workDir] x-speakeasy-entity: Workflows 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 optimizationId: type: string optimizationTargets: type: string 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 towerConfig: type: string userSecrets: type: array items: type: string workDir: type: string workspaceSecrets: type: array items: type: string 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 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 netCpuShareMillis: type: integer format: int64 nullable: true netCpuShares: type: integer format: int64 nullable: true 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 running: type: integer format: int64 submitted: type: integer format: int64 succeeded: type: integer format: int64 volCtxSwitch: type: integer format: int64 writeBytes: type: integer format: int64 required: - aborted - cached - cpuLoad - cpuTime - cpus - failed - invCtxSwitch - loadCpus - loadMemory - loadTasks - memoryReq - memoryRss - peakCpus - peakMemory - peakTasks - pending - readBytes - running - submitted - succeeded - volCtxSwitch - writeBytes WorkflowLogResponse: type: object properties: log: $ref: '#/components/schemas/LogPage' WorkflowMaxDbDto: type: object allOf: - $ref: '#/components/schemas/WorkflowDbDto' - properties: fusion: $ref: '#/components/schemas/WfFusionMeta' logFile: type: string nextflowConfig: type: string nullable: true operationId: type: string outFile: type: string postRunScript: type: string nullable: true preRunScript: 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 x-speakeasy-param-readonly: true description: type: string maxLength: 1000 nullable: true description: Workspace description x-speakeasy-param-readonly: false example: "Workspace for genomics research projects and computational biology workflows" fullName: type: string maxLength: 100 x-speakeasy-param-readonly: false example: "Genomics Research Workspace" id: type: integer format: int64 nullable: true x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time x-speakeasy-param-readonly: true name: type: string maxLength: 40 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$ x-speakeasy-param-readonly: false example: "genomics-research" visibility: $ref: '#/components/schemas/Visibility' x-speakeasy-param-readonly: false example: "PRIVATE" required: - fullName - name - visibility x-speakeasy-entity: Workspace x-speakeasy-entity-description: | Manage workspaces for organizing projects and resources. Workspaces provide isolated environments for organizing pipelines, compute environments, and data, with configurable permissions and access controls for collaborative research projects. Each user has a unique user workspace to manage resources such as pipelines, compute environments, and credentials. You can also create multiple workspaces within an organization context and associate each of these workspaces with dedicated teams of users, while providing fine-grained access control for each of the teams. Organization workspaces extend the functionality of user workspaces by adding the ability to fine-tune access levels for specific members, collaborators, or teams. This is achieved by managing participants in the organization workspaces. Organizations consist of members, while workspaces consist of participants. WorkspaceDbDto: type: object properties: description: type: string nullable: true description: Detailed description of the workspace's purpose fullName: type: string description: Complete display name for the workspace id: type: integer format: int64 description: Unique numeric identifier for the workspace name: type: string description: Short name or handle for the workspace visibility: $ref: '#/components/schemas/Visibility' description: Visibility level of the workspace (public, private, etc.) description: | Represents a workspace in the Seqera Platform. Contains workspace configuration, member permissions, and resource isolation settings for project organization. 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 WspRoleSourceType: type: string enum: - individual - team x-enum-varnames: - individual - team ActionLaunchRequest: type: object description: Launch payload for `seqera_action` Create / Update endpoints. allOf: - $ref: "#/components/schemas/WorkflowLaunchRequest" properties: id: type: string description: Server-generated launch identifier; echoed back on Update. x-speakeasy-param-readonly: true # AWS-specific compute environment schema AWSComputeEnv_ComputeConfig: x-speakeasy-entity: AWSComputeEnv x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage AWS compute environments in Seqera platform using this resource. AWS compute environments define the execution platform where a pipeline will run on AWS infrastructure (AWS Batch, AWS Cloud, EKS). required: - config - name - platform - credentialsId type: object properties: credentialsId: type: string description: AWS credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. deprecated: true x-speakeasy-deprecation-message: | The `seqera_aws_compute_env` resource is superseded by `seqera_aws_batch_ce`. The two resources share the same schema and API; `seqera_aws_batch_ce` is the canonical resource going forward. Migrate with a `moved {}` block — see the resource docs. description: type: string description: Optional description of the compute environment platform: type: string enum: - aws-batch description: AWS platform type x-speakeasy-param-optional: false x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true config: description: AWS-specific compute environment configuration $ref: '#/components/schemas/AwsBatchConfig' x-speakeasy-param-force-new: true # AWS-specific request/response schemas CreateAWSComputeEnvRequest: type: object properties: computeEnv: $ref: '#/components/schemas/AWSComputeEnv_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateAWSComputeEnvResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateAWSComputeEnvRequest: type: object properties: computeEnv: $ref: '#/components/schemas/AWSComputeEnv_ComputeConfig' DescribeAWSComputeEnvResponse: type: object properties: computeEnv: $ref: '#/components/schemas/AWSComputeEnv_ComputeConfig' ListAWSComputeEnvsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/AWSComputeEnv_ComputeConfig' totalSize: type: integer format: int64 # AWS-specific compute environment schema AWSBatchCE_ComputeConfig: x-speakeasy-entity: AWSBatchCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage AWS compute environments in Seqera platform using this resource. AWS compute environments define the execution platform where a pipeline will run on AWS infrastructure (AWS Batch, AWS Cloud, EKS). required: - config - name - credentialsId type: object properties: credentialsId: type: string description: AWS credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - aws-batch default: aws-batch description: AWS platform type. Always "aws-batch" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: AWS-specific compute environment configuration $ref: '#/components/schemas/AwsBatchConfig' x-speakeasy-param-force-new: true # AWS-specific request/response schemas CreateAWSBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AWSBatchCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateAWSBatchCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateAWSBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AWSBatchCE_ComputeConfig' DescribeAWSBatchCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/AWSBatchCE_ComputeConfig' ListAWSBatchCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/AWSBatchCE_ComputeConfig' totalSize: type: integer format: int64 # AWS Cloud compute environment schema AwsCloudCE_ComputeConfig: x-speakeasy-entity: AwsCloudCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage AWS Cloud compute environments in Seqera Platform. AWS Cloud compute environments execute Nextflow pipelines directly on EC2 instances managed by Seqera (rather than via AWS Batch). All configuration fields (region, work_dir, allow_buckets, instance_type, scripts, env, etc.) are identical between the two compute modes — the scheduler only *adds* the `intelligent_compute_config` block; nothing else is hidden or unlocked. Two compute modes are supported, selected via `intelligent_compute_enabled`. In **Classic** mode (`intelligent_compute_enabled = false`, the default), worker fleet and spot-vs-on-demand strategy are managed by Tower Forge. Omit the `intelligent_compute_config` block in this mode. In **Seqera Intelligent Compute** mode (Preview, `intelligent_compute_enabled = true`), tasks are distributed across multiple EC2 instances with optimized scheduling and resource allocation. The `intelligent_compute_config` block is optional — leave it null to accept the platform defaults, or set it to override the EC2 provisioning strategy or restrict the instance-type catalog. Note: `instance_type` sets the **head node** EC2 type and applies in both modes (defaults: `m5d.large`, or `m6gd.large` when `arm64_enabled = true`). **Backend feature flag.** Enabling Seqera Intelligent Compute requires the `SEQERA_SCHEDULER` feature toggle on the target workspace/org. Without it, a create with `intelligent_compute_enabled = true` returns HTTP 403. The toggle is controlled centrally — there is no API to flip it, so coordinate with the Platform team before applying. required: - config - name - credentialsId type: object properties: credentialsId: type: string description: AWS credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - aws-cloud default: aws-cloud description: AWS platform type. Always "aws-cloud" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: AWS Cloud compute environment configuration $ref: '#/components/schemas/AwsCloudConfig' x-speakeasy-param-force-new: true # AWS Cloud request/response schemas CreateAwsCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AwsCloudCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateAwsCloudCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateAwsCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AwsCloudCE_ComputeConfig' DescribeAwsCloudCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/AwsCloudCE_ComputeConfig' ListAwsCloudCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/AwsCloudCE_ComputeConfig' totalSize: type: integer format: int64 # Azure Batch compute environment schema AzureBatchCE_ComputeConfig: x-speakeasy-entity: AzureBatchCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Azure Batch compute environments in Seqera platform. Azure Batch compute environments execute Nextflow pipelines on Azure Batch using Azure-managed pools of VMs. Use this resource for batch-style workloads where Azure Batch schedules and manages the underlying compute instances. required: - config - name - credentialsId type: object properties: credentialsId: type: string description: Azure credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - azure-batch default: azure-batch description: Azure platform type. Always "azure-batch" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: Azure Batch compute environment configuration $ref: '#/components/schemas/AzBatchConfig' x-speakeasy-param-force-new: true # Azure Batch request/response schemas CreateAzureBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AzureBatchCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateAzureBatchCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateAzureBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AzureBatchCE_ComputeConfig' DescribeAzureBatchCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/AzureBatchCE_ComputeConfig' ListAzureBatchCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/AzureBatchCE_ComputeConfig' totalSize: type: integer format: int64 # Azure Cloud compute environment schema AzureCloudCE_ComputeConfig: x-speakeasy-entity: AzureCloudCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Azure Cloud compute environments in Seqera platform. Azure Cloud compute environments execute Nextflow pipelines directly on Azure VMs managed by Seqera. Use this resource for long-running or interactive workloads where Seqera provisions and manages the underlying compute instances directly (rather than via Azure Batch). required: - config - name - credentialsId type: object properties: credentialsId: type: string description: Azure credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - azure-cloud default: azure-cloud description: Azure platform type. Always "azure-cloud" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: Azure Cloud compute environment configuration $ref: '#/components/schemas/AzCloudConfig' x-speakeasy-param-force-new: true # Azure Cloud request/response schemas CreateAzureCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AzureCloudCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateAzureCloudCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateAzureCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/AzureCloudCE_ComputeConfig' DescribeAzureCloudCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/AzureCloudCE_ComputeConfig' ListAzureCloudCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/AzureCloudCE_ComputeConfig' totalSize: type: integer format: int64 # GCP Batch compute environment schema GCPBatchCE_ComputeConfig: x-speakeasy-entity: GCPBatchCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Google Cloud Batch compute environments in Seqera platform. GCP Batch compute environments execute Nextflow pipelines on Google Cloud Batch using Google-managed VMs. Use this resource for batch-style workloads where Google Cloud schedules and manages the underlying compute instances. required: - config - name - credentialsId type: object properties: credentialsId: type: string description: Google Cloud credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - google-batch default: google-batch description: GCP platform type. Always "google-batch" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: Google Cloud Batch compute environment configuration $ref: '#/components/schemas/GoogleBatchConfig' x-speakeasy-param-force-new: true # GCP Batch request/response schemas CreateGCPBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/GCPBatchCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateGCPBatchCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateGCPBatchCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/GCPBatchCE_ComputeConfig' DescribeGCPBatchCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/GCPBatchCE_ComputeConfig' ListGCPBatchCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/GCPBatchCE_ComputeConfig' totalSize: type: integer format: int64 # GCP Cloud compute environment schema GCPCloudCE_ComputeConfig: x-speakeasy-entity: GCPCloudCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Google Cloud compute environments in Seqera platform. GCP Cloud compute environments execute Nextflow pipelines directly on Google Compute Engine VMs managed by Seqera. Use this resource for long-running or interactive workloads where Seqera provisions and manages the underlying compute instances directly (rather than via Google Batch). required: - config - name - credentialsId type: object properties: credentialsId: type: string description: Google Cloud credentials identifier orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment platform: type: string enum: - google-cloud default: google-cloud description: GCP platform type. Always "google-cloud" for this resource — set by the provider, not user-configurable. x-speakeasy-param-readonly: true x-speakeasy-param-force-new: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true config: description: Google Cloud compute environment configuration $ref: '#/components/schemas/GoogleCloudConfig' x-speakeasy-param-force-new: true # GCP Cloud request/response schemas CreateGCPCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/GCPCloudCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateGCPCloudCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateGCPCloudCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/GCPCloudCE_ComputeConfig' DescribeGCPCloudCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/GCPCloudCE_ComputeConfig' ListGCPCloudCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/GCPCloudCE_ComputeConfig' totalSize: type: integer format: int64 # Seqera Managed Compute environment schema # Uses transform-based hoisting (see docs-internal/OVERLAY_GUIDE.md # → Hoisting Nested API Structures). The platform wire format is # `{ name, ..., config: { region, instanceTypeSize, ... } }`. The # jq transforms flatten that on read and re-nest on write so the # Terraform schema sees `region`, `instance_size`, `work_dir`, etc. # at the resource root with no `config` block. ManagedComputeCE_ComputeConfig: x-speakeasy-entity: ManagedComputeCE x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Seqera Managed Compute environments in Seqera Platform. Seqera Managed Compute is a fully managed compute service that handles infrastructure provisioning and management automatically. Unlike AWS Batch or other compute environments where you need to configure VPCs, subnets, and IAM roles, Seqera Managed Compute only requires you to specify the region and instance size. Key benefits: - No infrastructure setup required - Automatic scaling and resource management - Simplified configuration with just region and instance size Available instance sizes: - SMALL: Suitable for lightweight workflows (default) - MEDIUM: Balanced compute resources - LARGE: High-performance compute for demanding workflows x-speakeasy-transform-from-api: jq: '. + { region: .config.region, instance_size: .config.instanceTypeSize, work_dir: .config.workDir, data_retention_policy: .config.defaultDataRetentionPolicy, resource_label_ids: .config.resourceLabelIds, pre_run_script: .config.preRunScript, post_run_script: .config.postRunScript, nextflow_config: .config.nextflowConfig, environment: .config.environment } | del(.config)' x-speakeasy-transform-to-api: jq: '. + { config: { discriminator: "seqeracompute-platform", region: .region, instanceTypeSize: .instance_size, workDir: .work_dir, defaultDataRetentionPolicy: .data_retention_policy, resourceLabelIds: .resource_label_ids, preRunScript: .pre_run_script, postRunScript: .post_run_script, nextflowConfig: .nextflow_config, environment: .environment } } | del(.region, .instance_size, .work_dir, .data_retention_policy, .resource_label_ids, .pre_run_script, .post_run_script, .nextflow_config, .environment)' required: - name type: object properties: orgId: type: integer format: int64 readOnly: true x-speakeasy-param-readonly: true workspaceId: type: integer format: int64 description: Workspace numeric identifier x-speakeasy-param-force-new: true id: type: string description: Unique identifier for the compute environment x-speakeasy-param-readonly: true name: maxLength: 100 type: string pattern: '^[a-zA-Z0-9_-]+$' description: A unique name for this compute environment. Use only alphanumeric, dash, and underscore characters. description: type: string description: Optional description of the compute environment x-speakeasy-terraform-ignore: true platform: type: string enum: - seqeracompute-platform default: "seqeracompute-platform" description: Platform type for Seqera Managed Compute environment. x-speakeasy-param-readonly: true status: type: string description: Compute environment status x-speakeasy-param-readonly: true dateCreated: type: string format: date-time description: Timestamp when the compute environment was created x-speakeasy-param-readonly: true lastUpdated: type: string format: date-time description: Timestamp when the compute environment was last updated x-speakeasy-param-readonly: true lastUsed: type: string format: date-time description: Timestamp when the compute environment was last used x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the compute environment has been deleted x-speakeasy-param-readonly: true x-speakeasy-soft-delete-property: true region: type: string description: | AWS region for Seqera Managed Compute resources. Examples: us-east-1, eu-west-1, ap-southeast-2 example: "us-east-1" x-speakeasy-param-force-new: true x-speakeasy-param-optional: false x-speakeasy-plan-validators: SeqeraComputeRegionValidator instance_size: type: string enum: - SMALL - MEDIUM - LARGE description: | Size of the compute instance. - SMALL: Lightweight workflows (default) - MEDIUM: Balanced compute resources - LARGE: High-performance compute for demanding workflows example: "SMALL" default: "SMALL" x-speakeasy-param-force-new: true x-speakeasy-param-optional: true x-speakeasy-plan-validators: InstanceTypeSizeValidator work_dir: type: string description: | Work directory suffix relative to the S3 bucket provisioned by Seqera. Optional - a default work directory is used if not specified. example: "work" x-speakeasy-param-optional: true x-speakeasy-param-force-new: true data_retention_policy: type: boolean description: | Enable automatic data retention policy. When enabled, intermediary files are automatically deleted after 28 days. default: true x-speakeasy-param-optional: true x-speakeasy-param-force-new: true resource_label_ids: type: array items: type: integer format: int64 description: List of resource label IDs to associate with this compute environment. x-speakeasy-param-optional: true x-speakeasy-param-force-new: true pre_run_script: type: string description: Bash script to run before workflow execution begins. x-speakeasy-param-force-new: true x-speakeasy-param-optional: true post_run_script: type: string description: Bash script to run after workflow execution completes. x-speakeasy-param-force-new: true x-speakeasy-param-optional: true nextflow_config: type: string description: Global Nextflow configuration settings for workflows. x-speakeasy-param-force-new: true x-speakeasy-param-optional: true environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" description: Environment variables for the compute environment. x-speakeasy-param-force-new: true x-speakeasy-param-optional: true # Seqera Compute request/response schemas CreateManagedComputeCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/ManagedComputeCE_ComputeConfig' labelIds: type: array items: type: integer format: int64 CreateManagedComputeCEResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .computeEnvId }' properties: id: type: string description: Alias of `compute_env_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true computeEnvId: type: string UpdateManagedComputeCERequest: type: object properties: computeEnv: $ref: '#/components/schemas/ManagedComputeCE_ComputeConfig' DescribeManagedComputeCEResponse: type: object properties: computeEnv: $ref: '#/components/schemas/ManagedComputeCE_ComputeConfig' ListManagedComputeCEsResponse: type: object properties: computeEnvs: type: array items: $ref: '#/components/schemas/ManagedComputeCE_ComputeConfig' totalSize: type: integer format: int64 AWSCredential: x-speakeasy-entity: AWSCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Manage AWS credentials in Seqera platform using this resource. AWS credentials store authentication information for accessing AWS services within the Seqera Platform workflows. x-speakeasy-transform-from-api: jq: '. + { access_key: .keys.accessKey, secret_key: .keys.secretKey, assume_role_arn: .keys.assumeRoleArn, mode: .keys.mode, external_id: .keys.externalId, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { accessKey: .access_key, secretKey: .secret_key, assumeRoleArn: .assume_role_arn, mode: .mode, externalId: .external_id } } | del(.access_key, .secret_key, .assume_role_arn, .mode, .external_id, .credentials_id)' required: - name type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - aws default: aws description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true access_key: type: string minLength: 16 maxLength: 128 pattern: ^(AKIA|ASIA|AIDA)[A-Z0-9]{16,}$ description: AWS access key ID. Must start with AKIA (standard) or ASIA (temporary). Required unless assume_role_arn is provided. example: AKIAIOSFODNN7EXAMPLE x-speakeasy-param-computed: false x-speakeasy-param-optional: true x-speakeasy-plan-validators: AWSCredentialKeysValidator secret_key: type: string minLength: 40 description: AWS secret access key (sensitive). Must be at least 40 characters. Required unless assume_role_arn is provided. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true x-speakeasy-param-optional: true example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY x-speakeasy-plan-validators: AWSCredentialKeysValidator writeOnly: true assume_role_arn: type: string pattern: ^arn:aws:iam::[0-9]{12}:role/.+$ description: 'IAM role ARN to assume. Format: arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME. Either this or both access_key and secret_key must be provided.' example: arn:aws:iam::123456789012:role/SeqeraRole x-speakeasy-param-computed: false x-speakeasy-param-optional: true x-speakeasy-plan-validators: AWSCredentialKeysValidator writeOnly: true mode: $ref: '#/components/schemas/AwsCredentialsMode' description: 'Authentication mode: "keys" for access key/secret key, "role" for IAM role assumption.' x-speakeasy-param-optional: true external_id: type: string description: External ID for cross-account IAM role assumption. Generated by the platform when useExternalId is enabled. x-speakeasy-param-readonly: true x-speakeasy-param-sensitive: true CreateAWSCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/AWSCredential' CreateAWSCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateAWSCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/AWSCredential' DescribeAWSCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/AWSCredential' AzureCredential: x-speakeasy-entity: AzureCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | Manage Azure Batch credentials using shared-key authentication. This is the credential type required for Azure Batch compute environments in Forge mode. For other Azure credential types, use a dedicated typed resource: - **Azure Batch with Entra service principal**: `seqera_azure_entra_credential` - **Azure Cloud (SingleVM) with Entra service principal**: `seqera_azure_cloud_credential` The `tenant_id`, `client_id`, and `client_secret` fields are kept for backwards compatibility with earlier provider releases but have no effect on this credential type. Use the typed resources above for service-principal credentials so they surface in the correct compute-environment picker. x-speakeasy-transform-from-api: jq: '. + { batch_name: .keys.batchName, storage_name: .keys.storageName, batch_key: .keys.batchKey, storage_key: .keys.storageKey, tenant_id: .keys.tenantId, client_id: .keys.clientId, client_secret: .keys.clientSecret, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { discriminator: "azure", batchName: .batch_name, storageName: .storage_name, batchKey: .batch_key, storageKey: .storage_key, tenantId: .tenant_id, clientId: .client_id, clientSecret: .client_secret } } | del(.batch_name, .storage_name, .batch_key, .storage_key, .tenant_id, .client_id, .client_secret, .credentials_id)' required: - name - batch_name - storage_name type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - azure default: azure description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true batch_name: type: string description: Azure Batch account name (required) example: myazurebatch x-speakeasy-param-computed: false storage_name: type: string description: Azure Blob Storage account name (required) example: myazurestorage x-speakeasy-param-computed: false batch_key: type: string description: Azure Batch account key (for shared key authentication) x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: YourAzureBatchAccountKeyHere== x-speakeasy-plan-validators: AzureCredentialSharedKeyValidator writeOnly: true storage_key: type: string description: Azure Storage account key (for shared key authentication) x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: YourAzureStorageAccountKeyHere== x-speakeasy-plan-validators: AzureCredentialSharedKeyValidator writeOnly: true tenant_id: type: string description: Azure tenant ID (for Entra/Cloud authentication) example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false x-speakeasy-plan-validators: AzureCredentialEntraValidator writeOnly: true client_id: type: string description: Azure service principal client ID (for Entra/Cloud authentication) example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false x-speakeasy-plan-validators: AzureCredentialEntraValidator writeOnly: true client_secret: type: string description: Azure service principal client secret (for Entra/Cloud authentication) x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: YourAzureClientSecretHere x-speakeasy-plan-validators: AzureCredentialEntraValidator writeOnly: true CreateAzureCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureCredential' CreateAzureCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateAzureCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureCredential' DescribeAzureCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/AzureCredential' AzureEntraCredential: x-speakeasy-entity: AzureEntraCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: azure_entra_credential x-speakeasy-entity-description: | Manage Azure Batch credentials authenticated via a Microsoft Entra service principal. Use this credential type for Azure Batch compute environments configured in manual mode — Forge mode requires shared-key credentials via `seqera_azure_credential`. For Azure Cloud (SingleVM) CEs, use `seqera_azure_cloud_credential` instead. x-speakeasy-transform-from-api: jq: '. + { batch_name: .keys.batchName, storage_name: .keys.storageName, tenant_id: .keys.tenantId, client_id: .keys.clientId, client_secret: .keys.clientSecret, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { discriminator: "azure_entra", batchName: .batch_name, storageName: .storage_name, tenantId: .tenant_id, clientId: .client_id, clientSecret: .client_secret } } | del(.batch_name, .storage_name, .tenant_id, .client_id, .client_secret, .credentials_id)' required: - name - batch_name - storage_name - tenant_id - client_id - client_secret type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - azure_entra default: azure_entra description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true batch_name: type: string description: Azure Batch account name. example: myazurebatch x-speakeasy-param-computed: false storage_name: type: string description: Azure Blob Storage account name. example: myazurestorage x-speakeasy-param-computed: false tenant_id: type: string description: Microsoft Entra tenant ID. example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false client_id: type: string description: Microsoft Entra service principal client (application) ID. example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false client_secret: type: string description: Microsoft Entra service principal client secret. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: YourEntraClientSecretHere writeOnly: true CreateAzureEntraCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureEntraCredential' CreateAzureEntraCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateAzureEntraCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureEntraCredential' DescribeAzureEntraCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/AzureEntraCredential' AzureCloudCredential: x-speakeasy-entity: AzureCloudCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: azure_cloud_credential x-speakeasy-entity-description: | Manage Azure Cloud (SingleVM) credentials authenticated via a Microsoft Entra service principal. Use this credential type for Azure Cloud compute environments, which run Nextflow directly on Azure VMs managed by Seqera Forge (no Azure Batch involvement). Storage access is brokered through the same service principal, so no separate storage key is required. For Azure Batch with Entra service-principal auth, use `seqera_azure_entra_credential`; for Azure Batch with shared-key auth, use `seqera_azure_credential`. x-speakeasy-transform-from-api: jq: '. + { subscription_id: .keys.subscriptionId, storage_name: .keys.storageName, tenant_id: .keys.tenantId, client_id: .keys.clientId, client_secret: .keys.clientSecret, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { discriminator: "azure-cloud", subscriptionId: .subscription_id, storageName: .storage_name, tenantId: .tenant_id, clientId: .client_id, clientSecret: .client_secret } } | del(.subscription_id, .storage_name, .tenant_id, .client_id, .client_secret, .credentials_id)' required: - name - subscription_id - storage_name - tenant_id - client_id - client_secret type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - azure-cloud default: azure-cloud description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true subscription_id: type: string description: Azure subscription ID where Forge provisions VMs. example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false storage_name: type: string description: Azure Blob Storage account name used for work_dir. example: myazurestorage x-speakeasy-param-computed: false tenant_id: type: string description: Microsoft Entra tenant ID. example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false client_id: type: string description: Microsoft Entra service principal client (application) ID. example: 00000000-0000-0000-0000-000000000000 x-speakeasy-param-computed: false client_secret: type: string description: Microsoft Entra service principal client secret. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: YourEntraClientSecretHere writeOnly: true CreateAzureCloudCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureCloudCredential' CreateAzureCloudCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateAzureCloudCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/AzureCloudCredential' DescribeAzureCloudCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/AzureCloudCredential' BitbucketCredential: x-speakeasy-entity: BitbucketCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: bitbucket_credential x-speakeasy-entity-description: 'Manage Bitbucket credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Bitbucket credentials store authentication information for accessing Bitbucket repositories within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { username: .keys.username, password: .keys.password, token: .keys.token, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { username: .username, password: .password, token: .token } } | del(.username, .password, .token, .credentials_id)' required: - name - username type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - bitbucket default: bitbucket description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Repository base URL (optional, recommended). When multiple Bitbucket credentials exist in a workspace, Seqera selects the credential whose `base_url` is the longest prefix of the target repository URL; ties are broken by most recently updated. If no credential has a `base_url`, the most recently updated Bitbucket credential is used. Example: https://bitbucket.org/seqeralabs/repo1' example: https://bitbucket.org/seqeralabs/repo1 x-speakeasy-name-override: base_url x-speakeasy-param-computed: false username: type: string description: Bitbucket account username (for app passwords) or email (for API tokens). example: myuser@example.com x-speakeasy-param-computed: false password: type: string description: Bitbucket app password or HTTP password (sensitive). Generate app passwords from Bitbucket account settings. Mutually exclusive with `token`. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true x-speakeasy-plan-validators: BitbucketPasswordValidator example: BBDC-... writeOnly: true token: type: string description: Bitbucket API token (sensitive). Mutually exclusive with `password`. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true x-speakeasy-plan-validators: BitbucketTokenValidator example: ATBB... writeOnly: true CreateBitbucketCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/BitbucketCredential' CreateBitbucketCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateBitbucketCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/BitbucketCredential' DescribeBitbucketCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/BitbucketCredential' CodecommitCredential: x-speakeasy-entity: CodecommitCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: codecommit_credential x-speakeasy-entity-description: 'Manage Codecommit credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Codecommit credentials store AWS authentication information for accessing AWS Codecommit repositories within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { access_key: .keys.username, secret_key: .keys.password, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { username: .access_key, password: .secret_key } } | del(.access_key, .secret_key, .credentials_id)' required: - name - access_key - secret_key type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - codecommit default: codecommit description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Regional AWS CodeCommit endpoint (optional, recommended). When multiple CodeCommit credentials exist in a workspace, Seqera selects the credential whose `base_url` is the longest prefix of the target repository URL; ties are broken by most recently updated. If no credential has a `base_url`, the most recently updated CodeCommit credential is used. Example: https://git-codecommit.eu-west-1.amazonaws.com' example: https://git-codecommit.us-east-1.amazonaws.com x-speakeasy-param-computed: true x-speakeasy-name-override: base_url access_key: type: string description: AWS IAM access key ID for CodeCommit. example: AKIAIOSFODNN7EXAMPLE x-speakeasy-param-computed: false secret_key: type: string description: AWS IAM secret access key for CodeCommit (sensitive). x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY writeOnly: true CreateCodecommitCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/CodecommitCredential' CreateCodecommitCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateCodecommitCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/CodecommitCredential' DescribeCodecommitCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/CodecommitCredential' ContainerRegistryCredential: x-speakeasy-entity: ContainerRegistryCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: 'Manage container registry credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Container registry credentials store authentication information for accessing container registries (Docker Hub, ECR, GCR, ACR, etc.) within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { user_name: .keys.userName, password: .keys.password, registry: .keys.registry, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { userName: .user_name, password: .password, registry: .registry } } | del(.user_name, .password, .registry, .credentials_id)' required: - name - user_name - password type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - container-reg default: container-reg description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true user_name: type: string description: Username for container registry authentication (required) example: myuser x-speakeasy-param-computed: false password: type: string description: Password or access token for container registry authentication (required, sensitive) x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: mypassword writeOnly: true registry: type: string description: 'Container registry server URL (optional). Examples: docker.io, gcr.io, account.dkr.ecr.region.amazonaws.com' example: docker.io x-speakeasy-param-computed: false CreateContainerRegistryCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/ContainerRegistryCredential' CreateContainerRegistryCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateContainerRegistryCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/ContainerRegistryCredential' DescribeContainerRegistryCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/ContainerRegistryCredential' GoogleCredential: x-speakeasy-entity: GoogleCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: | **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Manage Google credentials in Seqera platform using this resource. Google credentials authenticate to Google Cloud either with a service account key (`data`) or via Workload Identity Federation (`workload_identity_provider` and `service_account_email`). WIF is the recommended path — no long-lived key is stored in the platform. x-speakeasy-transform-from-api: jq: '. + { data: .keys.data, workload_identity_provider: .keys.workloadIdentityProvider, service_account_email: .keys.serviceAccountEmail, token_audience: .keys.tokenAudience, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { keyType: "google", data: .data, workloadIdentityProvider: .workload_identity_provider, serviceAccountEmail: .service_account_email, tokenAudience: .token_audience } } | del(.data, .workload_identity_provider, .service_account_email, .token_audience, .credentials_id)' required: - name type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - google default: google description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true data: type: string description: Google Cloud service account key JSON. Required unless workload_identity_provider and service_account_email are provided. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true x-speakeasy-param-optional: true x-speakeasy-plan-validators: GoogleCredentialKeysValidator example: "{\n \"type\": \"service_account\",\n \"project_id\": \"my-project\",\n \"private_key_id\": \"key-id\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\n \"client_email\": \"service-account@my-project.iam.gserviceaccount.com\",\n \"client_id\": \"123456789\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://oauth2.googleapis.com/token\"\n}\n" writeOnly: true workload_identity_provider: type: string pattern: '^projects/[0-9]+/locations/global/workloadIdentityPools/[^/]+/providers/[^/]+$' description: 'Full resource path of the GCP workload identity provider that trusts Seqera as an OIDC issuer. Format: projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID. Uses the GCP project number, not the project ID. Required (with service_account_email) unless data is provided.' example: projects/123456789012/locations/global/workloadIdentityPools/seqera-pool/providers/seqera-provider x-speakeasy-param-optional: true x-speakeasy-plan-validators: GoogleCredentialKeysValidator service_account_email: type: string pattern: '^[^@]+@[^.]+\.iam\.gserviceaccount\.com$' description: Email of the GCP service account that Seqera will impersonate via Workload Identity Federation. Required (with workload_identity_provider) unless data is provided. example: seqera-runner@my-project.iam.gserviceaccount.com x-speakeasy-param-optional: true x-speakeasy-plan-validators: GoogleCredentialKeysValidator token_audience: type: string description: OIDC audience claim embedded in the Seqera-issued JWT. Defaults to `//iam.googleapis.com/`, which matches GCP's allowed-audiences check. Only set when fronting multiple workload identity pools with the same credential. x-speakeasy-param-optional: true CreateGoogleCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/GoogleCredential' CreateGoogleCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateGoogleCredentialsRequest: type: object required: - credentials properties: credentials: $ref: '#/components/schemas/GoogleCredential' DescribeGoogleCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/GoogleCredential' GiteaCredential: # See docs-internal/OVERLAY_GUIDE.md → "Hoisting Nested API Structures". x-speakeasy-entity: GiteaCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: 'Manage Gitea credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Gitea credentials store authentication information for accessing Gitea repositories within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { username: .keys.username, password: .keys.password, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { username: .username, password: .password } } | del(.username, .password, .credentials_id)' required: - name - username - password type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - gitea default: gitea description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Repository base URL for the self-hosted Gitea instance (required by the credential validator). When multiple Gitea credentials exist in a workspace, Seqera selects the credential whose `base_url` is the longest prefix of the target repository URL; ties are broken by most recently updated. Example: https://gitea.mycompany.com' example: https://gitea.mycompany.com x-speakeasy-name-override: base_url x-speakeasy-param-computed: false username: type: string description: Gitea account username. example: myuser x-speakeasy-param-computed: false password: type: string description: Gitea account password or personal access token (sensitive). x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: mypassword writeOnly: true CreateGiteaCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GiteaCredential' CreateGiteaCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateGiteaCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GiteaCredential' DescribeGiteaCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/GiteaCredential' GithubCredential: x-speakeasy-entity: GithubCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: github_credential x-speakeasy-entity-description: 'Manage GitHub credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. GitHub credentials store authentication information for accessing GitHub repositories within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { username: .keys.username, access_token: .keys.password, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { username: .username, password: .access_token } } | del(.username, .access_token, .credentials_id)' required: - name - username - access_token type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - github default: github description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Repository base URL (optional, recommended). When multiple GitHub credentials exist in a workspace, Seqera selects the credential whose `base_url` is the longest prefix of the target repository URL; ties are broken by most recently updated. If no credential has a `base_url`, the most recently updated GitHub credential is used. For GitHub Enterprise Server, set this to the server URL. Example: https://github.com/seqeralabs' example: https://github.com/seqeralabs x-speakeasy-name-override: base_url x-speakeasy-param-computed: false username: type: string description: GitHub account username associated with the access token. example: octocat access_token: type: string description: GitHub Personal Access Token (PAT) — classic or fine-grained. Typically requires `repo` scope; the backend does not enforce specific scopes. Sensitive. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: ghp_1234567890abcdefghijklmnopqrstuvwxyz writeOnly: true CreateGithubCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GithubCredential' CreateGithubCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateGithubCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GithubCredential' DescribeGithubCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/GithubCredential' GithubAppCredential: x-speakeasy-entity: GithubAppCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: github_app_credential x-speakeasy-entity-description: 'Manage GitHub App credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. GitHub App credentials provide access to private repositories for pipeline execution, as an alternative to a personal access token. This resource registers a pre-existing GitHub App (one you have already created and installed on GitHub); to find the required values, go to **Settings > Developer settings > GitHub Apps > [your app]** on GitHub. ' x-speakeasy-transform-from-api: jq: '. + { app_id: .keys.appId, client_id: .keys.clientId, private_key: .keys.privateKey, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { appId: .app_id, clientId: .client_id, privateKey: .private_key } } | del(.app_id, .client_id, .private_key, .credentials_id)' required: - name - app_id - client_id - private_key type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - github_app default: github_app description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Repository base URL (optional). Use your GitHub Enterprise Server base URL, or scope to a specific repository, e.g., https://github.com/seqeralabs.' example: https://github.com/seqeralabs x-speakeasy-name-override: base_url x-speakeasy-param-computed: false app_id: type: string description: GitHub App ID. Find this in your GitHub App settings (**Settings > Developer settings > GitHub Apps > [your app]** on GitHub). example: "123456" x-speakeasy-param-computed: false client_id: type: string description: GitHub App client ID. Find this in your GitHub App settings (**Settings > Developer settings > GitHub Apps > [your app]** on GitHub). example: Iv1.1234567890abcdef x-speakeasy-param-computed: false private_key: type: string description: GitHub App private key in PEM format. Download this from your GitHub App settings. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: | -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- writeOnly: true CreateGithubAppCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GithubAppCredential' CreateGithubAppCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateGithubAppCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GithubAppCredential' DescribeGithubAppCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/GithubAppCredential' GitlabCredential: x-speakeasy-entity: GitlabCredential x-speakeasy-entity-version: 1 x-speakeasy-terraform-resource-name: gitlab_credential x-speakeasy-entity-description: 'Manage GitLab credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. GitLab credentials store authentication information for accessing GitLab repositories within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { username: .keys.username, token: .keys.token, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { username: .username, token: .token } } | del(.username, .token, .credentials_id)' required: - name - username - token type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - gitlab default: gitlab description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true baseUrl: type: string description: 'Repository base URL (optional, recommended). When multiple GitLab credentials exist in a workspace, Seqera selects the credential whose `base_url` is the longest prefix of the target repository URL; ties are broken by most recently updated. If no credential has a `base_url`, the most recently updated GitLab credential is used. For self-hosted GitLab, set this to the server URL. Example: https://gitlab.com/seqeralabs' example: https://gitlab.com/seqeralabs x-speakeasy-name-override: base_url x-speakeasy-param-computed: false username: type: string description: GitLab account username associated with the access token. example: gitlab-user token: type: string description: GitLab access token (Personal, Group, or Project). Used by Seqera to authenticate against the GitLab API. Recommended scopes are `api`, `read_api`, and `read_repository`, though the backend does not strictly enforce them. Sensitive. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true example: glpat-xxxxxxxxxxxxxxxxxxxx writeOnly: true CreateGitlabCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GitlabCredential' CreateGitlabCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateGitlabCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/GitlabCredential' DescribeGitlabCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/GitlabCredential' KubernetesCredential: x-speakeasy-entity: KubernetesCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: 'Manage Kubernetes credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Kubernetes credentials enable secure connections to Kubernetes clusters for workflow execution. Supports two authentication methods: Service Account Token and X.509 Client Certificates.' x-speakeasy-transform-from-api: jq: '. + { token: .keys.token, client_certificate: .keys.certificate, private_key: .keys.privateKey, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { keyType: "kubernetes", token: .token, certificate: .client_certificate, privateKey: .private_key } } | del(.token, .client_certificate, .private_key, .credentials_id)' required: - name type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - k8s default: k8s description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true token: type: string description: Service Account token for Kubernetes authentication (optional). Required if using token-based authentication. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true writeOnly: true client_certificate: type: string description: X.509 client certificate for Kubernetes authentication (optional). Required if using certificate-based authentication. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true writeOnly: true private_key: type: string description: Private key for X.509 client certificate (optional). Required if using certificate-based authentication. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true writeOnly: true CreateKubernetesCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/KubernetesCredential' CreateKubernetesCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateKubernetesCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/KubernetesCredential' DescribeKubernetesCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/KubernetesCredential' SSHCredential: x-speakeasy-entity: SSHCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: 'Manage SSH credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. SSH credentials store SSH private keys for secure access to remote compute environments and resources within the Seqera Platform workflows. ' x-speakeasy-transform-from-api: jq: '. + { private_key: .keys.privateKey, passphrase: .keys.passphrase, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { keyType: "ssh", privateKey: .private_key, passphrase: .passphrase } } | del(.private_key, .passphrase, .credentials_id)' required: - name - private_key type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: '^[a-zA-Z0-9_-]+$' description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - ssh default: ssh description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true private_key: type: string description: 'SSH private key content (required, sensitive). The content of the private key file from the SSH asymmetrical key pair. Generate with: ssh-keygen' x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true writeOnly: true passphrase: type: string description: Passphrase associated with the SSH private key (optional, sensitive). Leave empty if no passphrase is needed. x-speakeasy-param-sensitive: true x-speakeasy-terraform-write-only: true writeOnly: true CreateSSHCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/SSHCredential' CreateSSHCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateSSHCredentialsRequest: type: object properties: credentials: $ref: '#/components/schemas/SSHCredential' DescribeSSHCredentialsResponse: type: object properties: credentials: $ref: '#/components/schemas/SSHCredential' TowerAgentCredential: x-speakeasy-entity: TowerAgentCredential x-speakeasy-entity-version: 1 x-speakeasy-entity-description: 'Manage Tower Agent credentials in Seqera platform using this resource. **Note:** This is a workspace-scoped resource. To manage user-context (personal) credentials, use the generic `seqera_credential` resource. Tower Agent credentials store connection IDs for Tower Agent instances that enable secure communication between the Seqera Platform and compute environments. **IMPORTANT**: The Tower Agent must be running and online before creating the credential. Start the agent with your connection ID first, then create the credential resource. If the agent is not online, you will receive an error: "The agent is not online - You need to run the agent before proceeding". ' x-speakeasy-transform-from-api: jq: '. + { connection_id: .keys.connectionId, shared: .keys.shared, credentials_id: .id } | del(.keys)' x-speakeasy-transform-to-api: jq: '. + { keys: { connectionId: .connection_id, shared: .shared } } | del(.connection_id, .shared, .credentials_id)' required: - name - connection_id type: object properties: id: type: string description: Unique identifier for the credential (max 22 characters) x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentials_id: type: string description: Alias of `id`. Retained for backwards compatibility with existing customer HCL — both fields hold the same value. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true name: minLength: 2 maxLength: 99 type: string pattern: "^[a-zA-Z0-9_-]+$" description: Display name for the credential. Must be 2-99 characters using only letters, numbers, underscores, and hyphens. No spaces allowed. x-speakeasy-param-force-new: true provider: type: string enum: - tw-agent default: tw-agent description: Cloud provider type. Always set by the provider for this resource. x-speakeasy-name-override: providerType x-speakeasy-param-readonly: true deleted: type: boolean description: Flag indicating if the credential has been soft-deleted x-speakeasy-param-readonly: true x-speakeasy-param-computed: true x-speakeasy-terraform-ignore: true lastUsed: type: string format: date-time description: Timestamp when the credential was last used x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true dateCreated: type: string format: date-time description: Timestamp when the credential was created x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true lastUpdated: type: string format: date-time description: Timestamp when the credential was last updated x-speakeasy-param-readonly: true x-speakeasy-terraform-ignore: true connection_id: type: string description: Tower Agent connection ID (required). A unique UUID string used to identify the Tower Agent instance. Generate using random_uuid resource. example: 31e42060-7985-4727-aca1-4071c819ad8e x-speakeasy-param-computed: false writeOnly: true shared: type: boolean description: When enabled, all workspace users can access the same Tower Agent instance default: false x-speakeasy-param-computed: false CreateTowerAgentCredentialsRequest: type: object properties: credentials: $ref: "#/components/schemas/TowerAgentCredential" CreateTowerAgentCredentialsResponse: type: object x-speakeasy-transform-from-api: jq: '. + { id: .credentialsId }' properties: id: type: string description: Alias of `credentials_id` for Terraform convention. x-speakeasy-param-readonly: true x-speakeasy-param-suppress-computed-diff: true credentialsId: type: string UpdateTowerAgentCredentialsRequest: type: object properties: credentials: $ref: "#/components/schemas/TowerAgentCredential" DescribeTowerAgentCredentialsResponse: type: object properties: credentials: $ref: "#/components/schemas/TowerAgentCredential" ListCredentialsDataSourceResponse: type: object required: - credentials properties: workspaceId: type: integer format: int64 description: Workspace ID used for filtering credentials: type: array description: List of credentials items: type: object properties: id: type: string description: Credential ID name: type: string description: Credential name provider: type: string description: Provider type (aws, azure, google, github, gitlab, bitbucket, ssh, k8s, container-reg, tw-agent, codecommit, gitea) x-speakeasy-entity: Credentials x-speakeasy-entity-description: | Data source for listing credentials in Seqera platform. This data source returns all credentials accessible to the authenticated user, with optional filtering by workspace. Use Terraform locals with for expressions to filter by provider type or name. ListDataLinksDataSourceResponse: type: object required: - dataLinks properties: workspaceId: type: integer format: int64 description: Workspace ID used for filtering dataLinks: type: array description: List of data links items: type: object properties: id: type: string description: Data link ID name: type: string description: Data link name provider: type: string description: Provider type (aws, azure, google, azure_entra, seqeracompute) resourceRef: type: string description: Resource reference (e.g., s3://bucket-name) region: type: string description: Geographic region where the data link is hosted x-speakeasy-entity: DataLinks x-speakeasy-entity-description: | Data source for listing data links in Seqera platform. This data source returns all data links accessible to the authenticated user, with optional filtering by workspace. Use Terraform locals with for expressions to filter by provider type or name. securitySchemes: BearerAuth: bearerFormat: jwt scheme: bearer type: http x-speakeasy-retries: strategy: backoff backoff: initialInterval: 500 maxInterval: 30000 maxElapsedTime: 300000 exponent: 1.5 statusCodes: - "429" - "502" - "503" - "504" retryConnectionErrors: true servers: - url: https://api.cloud.seqera.io