---
title: "Describe data-link"
method: GET
path: "/data-links/{dataLinkId}"
tags: ["data-links"]
---

# Describe data-link

`GET /data-links/{dataLinkId}`

Retrieves the details of the data-link associated with the given `dataLinkId`.

## Path parameters

- `dataLinkId` string, required

## Query parameters

- `workspaceId` integer
- `credentialsId` string

## Response `200`

OK

- DataLinkResponse
  - `dataLink` DataLinkDto
    - `credentials` DataLinkCredentials[]
      - `id` string, required
      - `name` string, required
      - `provider` 'aws' | 'google' | 'azure' | 'azure_entra' | 'azure-cloud' | 'seqeracompute' | 's3', required
    - `description` string
    - `hidden` boolean
    - `id` string
    - `message` string
    - `name` string
    - `provider` 'aws' | 'google' | 'azure' | 'azure_entra' | 'azure-cloud' | 'seqeracompute' | 's3'
    - `publicAccessible` boolean
    - `region` string
    - `resourceRef` string
    - `status` 'VALID' | 'INVALID'
    - `type` 'bucket'

## Other responses

- `400` — BadRequest
- `403` — Operation not allowed
- `404` — NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found

## Changes

> 14 revisions in range; 1 not diffed, 3 could not be searched.

- **2026-03-10** `49c99a6944de` — 1 breaking
  - the `dataLink/status` response's property type/format changed from `string`/`` to ``/`` for status `200`
- **2026-01-20** `98d6b538c88e` — 1 breaking, 2 warning, 2 info
  - the `dataLink/status` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - added the new `s3` enum value to the `dataLink/credentials/items/provider` response property for the response status `200`
  - added the new `s3` enum value to the `dataLink/provider` response property for the response status `200`
  - the response optional property `dataLink/status` became read-only for the status `200`
  - …1 more

[Change history](https://skmtc.dev/seqeralabs/apis/seqera-api/changes/data-links/:dataLinkId/get.md)

---

[API](https://skmtc.dev/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.dev/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/97f7655d105a/schema)