Update Using PUT 3
Update a Pipeline with the given project and name
The name of the Pipeline
The project the Pipeline belongs to
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about
{
"_inputMeta": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"concurrency": 10,
"description": "string",
"enabled": true,
"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",
"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"
],
"starred": {
"input": {
"input": "commitId"
},
"output": {
"output": "owner"
}
},
"tags": [
{
"key": "env",
"value": "dev"
}
],
"workspace": {
"autoCloneForTrigger": true,
"cache": [
"/root/.m2",
"/temp/"
],
"endpoint": "string",
"image": "fedora:latest",
"path": "/usr/administrator/",
"registry": "Docker Trusted Registry"
}
}Additional information about Input Properties
Number of Executions of the Pipeline that can run concurrently.
A human-friendly description.
Indicates if the Pipeline is in enabled state.
Map representing the Input properties for the Pipeline.
A human-friendly name used as an identifier in APIs that support this option
Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.
Map representing the Output properties for the Pipeline.
The project this entity belongs to.
Represents the various Rollback Configurations for the Pipeline
Represents the order in which Stages will be executed.
Map representing the details of the various Stages of the Pipeline.
A set of tag keys and optional values that were set on on the resource.
'Success' with the updated Pipeline
{
"_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",
"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"
],
"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"
}
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Additional information about Input Properties
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Contains any warnings that result from failed validations of any Pipeline fields
Number of Executions of the Pipeline that can run concurrently.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Indicates if the Pipeline is in enabled state.
String description of the icon used for this Pipeline.
The id of this resource.
Map representing the Input properties for the Pipeline.
A human-friendly name used as an identifier in APIs that support this option
Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.
Map representing the Output properties for the Pipeline.
The project this entity belongs to.
Represents the various Rollback Configurations for the Pipeline
Represents the order in which Stages will be executed.
Map representing the details of the various Stages of the Pipeline.
A set of tag keys and optional values that were set on on the resource.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Unauthorized Request
Forbidden
Not Found
Server Error