Describe pipeline
GET/pipelines/:pipelineId
Retrieves the details of the pipeline identified by the given pipelineId
, enriched by attributes
.
Request
Path Parameters
pipelineId int64required
Pipeline numeric identifier
Query Parameters
attributes PipelineQueryAttribute[]
Possible values: [optimized
, labels
, computeEnv
]
Additional attribute values to include in the response (labels
, optimized
status, computeEnv
). Returns an empty value (labels: null
, etc.) if omitted.
workspaceId int64
Workspace numeric identifier
sourceWorkspaceId int64
Source Optional workspace numeric identifier
Responses
- 200
- 400
- 403
OK
- application/json
- Schema
- Example (auto)
Schema
pipeline object
{
"pipeline": {
"pipelineId": 0,
"name": "string",
"description": "string",
"icon": "string",
"repository": "string",
"userId": 0,
"userName": "string",
"userFirstName": "string",
"userLastName": "string",
"orgId": 0,
"orgName": "string",
"workspaceId": 0,
"workspaceName": "string",
"visibility": "string",
"deleted": true,
"lastUpdated": "2024-07-29T15:51:28.071Z",
"optimizationId": "string",
"optimizationTargets": "string",
"optimizationStatus": "OPTIMIZED",
"labels": [
{
"id": 0,
"name": "string",
"value": "string",
"resource": true,
"isDefault": true,
"dateCreated": "2024-07-29T15:51:28.071Z"
}
],
"computeEnv": {
"id": "string",
"name": "string",
"platform": "string",
"region": "string"
}
}
}
Bad request
- application/json
- Schema
- Example (auto)
Schema
messagestringrequired
{
"message": "string"
}
Operation not allowed
Authorization: http
name: BearerAuthtype: httpscheme: bearerbearerFormat: jwt
- python
- curl
- java
- r
- javascript
- go
- powershell
- HTTP.CLIENT
- REQUESTS
import http.client
conn = http.client.HTTPSConnection("docs.seqera.io")
payload = ''
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer <token>'
}
conn.request("GET", "/pipelines/:pipelineId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))