Skip to main content

Custom Data Explorer links

Data Explorer enables you to browse and interact with remote data repositories from organization workspaces in Seqera Platform. It supports AWS S3, Azure Blob Storage, and Google Cloud Storage repositories.

Data links are custom bucket directory paths (for new or existing buckets) added to Data Explorer in organization workspaces. To add a data link, the workspace must contain credentials with permissions to access the data.

Path and query parameters

Name

Type

Location

Req/Opt

Description

workspaceId

integer

query

Optional

Workspace numeric identifier

credentialsId

string

query

Optional

Credentials identifier

search

string

query

Optional

Free text search criteria — data-link name and keywords: region, provider.

max

integer

query

Optional

Pagination max results

offset

integer

query

Optional

Pagination offset

visibility

string

query

Optional

Filter results by visibility

dataLinkId

string

path

Required

Data-link string identifier.

path

string

path

Required

Content path

nextPageToken

string

query

Optional

Token used to fetch the next page of items

pageSize

integer

query

Optional

Number of items to return per page. If omitted, a default maximum value is returned.

paths

array

query

Optional

List of paths to explore. Returns all files within the specified paths, including sub-paths.

filePath

string

path

Required

File path to download

filePath

string

query

Optional

File path to download within the data-link (e.g., folder/subfolder/object).

preview

boolean

query

Optional

If true, generates a URL for preview purposes. If false, generates a URL for direct download. Default: false.

dirs

array

query

Optional

List of directory paths to include in the download script.

files

array

query

Optional

List of file paths to include in the download script.

dirPath

string

path

Required

Path to the destination directory

Origin

string

header

Optional

Request body parameters

Name

Type

Req/Opt

Description

CreateCustomDataLink

Create data-link

name

string

Optional

Unique name for the data-link. Must consist of alphanumeric, dash, or underscore characters.

description

string

Optional

Description of the data-link. Maximum length: 1000 characters.

type

string

Optional

Data-link type. Currently only bucket is supported.

provider

string

Optional

Cloud provider for data-links. Supports AWS S3, Google Cloud Storage, Azure Blob Storage, Azure with Entra ID, Seqera Compute storage, and generic S3-compatible storage.

resourceRef

string

Optional

Resource path for the data-link, including the URI scheme (e.g., s3://my-bucket, gs://my-bucket, az://account.container).

publicAccessible

boolean

Optional

Whether the data-link is publicly accessible. If true, no credentials are required. If false, credentialsId must be provided.

credentialsId

string

Optional

Credentials string identifier. Required when publicAccessible is false.

UpdateCustomDataLink

Update data-link

name

string

Optional

New name for the data-link. Must be unique within the workspace or user context.

description

string

Optional

Updated description for the data-link. Maximum length: 1000 characters.

credentialsId

string

Optional

Updated credentials ID for accessing the data-link.

DeleteDataLinkItem

Delete data-link content

files

array

Optional

Array of file paths to be deleted from the data-link.

dirs

array

Optional

Array of directory paths to be deleted from the data-link.

GenerateDataLinkUploadUrl

Generate data-link file upload URL (to given path)

fileName

string

Optional

Name of the file to upload.

contentLength

integer

Optional

Size of the file to upload in bytes.

contentType

string

Optional

MIME type of the file to upload (e.g., application/octet-stream, text/plain).

FinishDataLinkUpload

Finish data-link file upload to given path

uploadId

string

Optional

Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the /upload endpoint response.

fileName

string

Optional

Name of the uploaded file.

tags

array

Optional

Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the /upload endpoint.

tags[].partNumber

integer

Optional

tags[].eTag

string

Optional

withError

boolean

Optional

Flag indicating whether the upload encountered an error. If true, the upload will be aborted. If false, the upload will be completed.

FinishDataLinkUpload_1

Finish data-link file upload to given path

uploadId

string

Optional

Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the /upload endpoint response.

fileName

string

Optional

Name of the uploaded file.

tags

array

Optional

Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the /upload endpoint.

tags[].partNumber

integer

Optional

tags[].eTag

string

Optional

withError

boolean

Optional

Flag indicating whether the upload encountered an error. If true, the upload will be aborted. If false, the upload will be completed.

GenerateDataLinkUploadUrl_1

Generate data-link file upload URL (to given path)

fileName

string

Optional

Name of the file to upload.

contentLength

integer

Optional

Size of the file to upload in bytes.

contentType

string

Optional

MIME type of the file to upload (e.g., application/octet-stream, text/plain).