Update data-link

PUT 
/data-links/:dataLinkId

Update the data-link associated with the given dataLinkId.

Request

Path Parameters

dataLinkId stringrequired

Data-link string identifier

Query Parameters

workspaceId int64

Workspace numeric identifier

application/json

Bodyrequired

Data-link update request

namestring
descriptionstring
credentialsIdstring

Responses

200

Success — Data-link updated

application/json

Schema

Schema

idstring
namestring
descriptionstring
resourceRefstring
typeDataLinkType (string)
Possible values: [bucket]
providerDataLinkProvider (string)
Possible values: [aws, google, azure, azure_entra, seqeracompute]
regionstring
credentials object[]
Array [
idstringrequired
namestringrequired
providerDataLinkProvider (string)required
Possible values: [aws, google, azure, azure_entra, seqeracompute]
]
publicAccessibleboolean
hiddenboolean
statusDataLink.Status (string)
Possible values: [VALID, INVALID]
messagestring

Example (auto)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "resourceRef": "string",
  "type": "bucket",
  "provider": "aws",
  "region": "string",
  "credentials": [
    {
      "id": "string",
      "name": "string",
      "provider": "aws"
    }
  ],
  "publicAccessible": true,
  "hidden": true,
  "status": "VALID",
  "message": "string"
}

400

BadRequest

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

403

Operation not allowed

404

NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

Authorization: http

name: BearerAuthtype: httpscheme: bearerbearerFormat: jwt

• python
• curl
• java
• r
• javascript
• go
• powershell

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("docs.seqera.io")
payload = json.dumps({
  "name": "string",
  "description": "string",
  "credentialsId": "string"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("PUT", "/data-links/:dataLinkId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Bearer Token

Parameters

dataLinkId — pathrequired

workspaceId — query

Body required

{
  "name": "string",
  "description": "string",
  "credentialsId": "string"
}