Get All Using GET 3
Get all Pipelines with specified paging and filter parameters.
Request
URI
GET
https://{api_host}/codestream/api/pipelines
COPY
Query Parameters
string
$filter
Optional
To list with OData like filter
string
$orderby
Optional
Constraints:
default: name desc
Order by attribute
string
$skip
Optional
Constraints:
default: 0
To skip 'n' Pipelines for listing
string
$top
Optional
Constraints:
default: 25
To list top 'n' Pipelines for listing
string
page
Optional
Constraints:
default: 0
To select 'n'th page for listing
string
apiVersion
Optional
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about
Responses
200
'Success' with the requested Pipelines
Returns
Pipelines
of type(s)
*/*
{
"count": 0,
"documents": {
"documents": {
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_inputMeta": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"_warnings": [
{
"classType": "Pipeline",
"message": {
"containerName": "vrcsPipeline.DEV for a stage",
"fieldName": "inputProperties.jobName.value",
"level": "SEVERE/WARNING/INFO",
"message": "Validation successful"
},
"success": false
}
],
"concurrency": 10,
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"enabled": true,
"icon": "tools,,is-success is-solid",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"name": "My-Name",
"notifications": {
"email": [
{
"to": [
"[email protected]"
],
"subject": "Pipeline execution notification",
"body": "pipeline-execution-1234",
"event": "SUCCESS",
"endpoint": "Codestream-Default-Email"
}
],
"jira": [
{
"assignee": "[email protected]",
"description": "Details about the issue being reported",
"endpoint": "string",
"event": "string",
"issuetype": "Bug/Story",
"project": "VRCS",
"stage": "string",
"summary": "Pipeline-1 execution failed",
"task": "string"
}
],
"webhook": [
{
"action": "POST/PUT/PATCH",
"endpoint": "string",
"event": "string",
"headers": {
"headers": "string"
},
"payload": {
"text": "executionId",
"username": "[email protected]"
},
"stage": "string",
"task": "string",
"url": "string"
}
]
},
"options": [
"DOCKER_TRIGGER"
],
"output": [
{
"deployedMachineIP": "10.108.35.54",
"result": "true"
}
],
"project": "My-Project",
"rollbacks": [
{
"stage": "Deploy to Prod",
"task": "Deploy",
"name": "Undo Deployment",
"inputs": {}
}
],
"stageOrder": [
"AcquireToken",
"Upgrade",
"E2E"
],
"stages": {
"stages": {
"description": "Image Publish Stage",
"tags": [
"Tag1",
"Tag2"
],
"taskOrder": [
"Task1",
"Task0"
],
"tasks": {
"Task1": {
"type": "REST",
"ignoreFailure": false,
"preCondition": "",
"input": {
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
},
"action": "get",
"url": "https://www.vmware.com"
}
}
}
}
},
"starred": {
"input": {
"input": "commitId"
},
"output": {
"output": "owner"
}
},
"tags": [
{
"key": "env",
"value": "dev"
}
],
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1",
"workspace": {
"autoCloneForTrigger": true,
"cache": [
"/root/.m2",
"/temp/"
],
"endpoint": "string",
"image": "fedora:latest",
"path": "/usr/administrator/",
"registry": "Docker Trusted Registry"
}
}
},
"links": [
"string"
],
"totalCount": 0
}
integer As int64
As int64
count
Optional
Number of resources within the current page.
object
documents
Optional
Details of the queried resources.
array of
string
links
Optional
Partial URLs representing the links to the queried resources.
integer As int64
As int64
totalCount
Optional
Number of resources across all pages.
401
Unauthorized Request
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
500
Server Error
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/codestream/api/pipelines
Pipelines Operations
GET
Export Using GET
POST
Import Yaml Using POST
GET
Get Pipeline Tiles Using GET
GET
Get All Using GET 3
POST
Create Using POST 3
GET
Get Using GET 2
POST
Act On Pipeline Using POST
PUT
Update Using PUT 2
DELETE
Delete Using DELETE 8
PATCH
Patch Using PATCH
GET
Get Executions By Id Using GET
POST
Execute Using POST
GET
Get Execution By Index And Pipeline Id Using GET
GET
Get Using GET 3
PUT
Update Using PUT 3
DELETE
Delete Using DELETE 9
PATCH
Patch Using PATCH 1
GET
Get Executions By Name Using GET
POST
Execute By Name Using POST
GET
Get Execution By Name And Index Using GET
GET
Get All Using GET 5
POST
Create Using POST 4
GET
Get Using GET 5
PUT
Update Using PUT 4
DELETE
Delete Using DELETE 11
GET
Get Using GET 6
PUT
Update Using PUT 5
DELETE
Delete Using DELETE 12