Execute Using POST

Execute Using POST

Execute a Pipeline based on the given id

Request
URI
POST
https://{api_host}/codestream/api/pipelines/{id}/executions
COPY
Path Parameters
string
id
Required

The ID of the Pipeline

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

Request Body

Execution Request for a pipeline

ExecutionRequest of type(s) application/json
Optional 
{
    "comments": "string",
    "executionId": "string",
    "executionLink": "string",
    "input": {},
    "source": "string",
    "tags": [
        "string"
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the created execution response

Returns ExecutionResponse of type(s) */* 
"ExecutionResponse Object"
string
executionId
Optional

Id of the Execution.

integer As int64 As int64
executionIndex
Optional

Index of the Execution.

string
executionLink
Optional

Link of the Execution.


202

Accepted

Returns ExecutionResponse of type(s) */* 
"ExecutionResponse Object"
string
executionId
Optional

Id of the Execution.

integer As int64 As int64
executionIndex
Optional

Index of the Execution.

string
executionLink
Optional

Link of the Execution.


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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/codestream/api/pipelines/{id}/executions
On This Page
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