| D toc |
|---|
Run the job for the active release of the specified deployment.
- At least one manual output must be specified for the main flow within the package. See Flow View Page.
- An active release must be specified for the deployment. See API Releases Patch v3.
| Info | ||||
|---|---|---|---|---|
NOTE: Deployments pertain to Production instances of the
|
Version: v3
Required Permissions
| D s api auth |
|---|
Request
Request Type: POST
Endpoint:
| Code Block |
|---|
/v3/deployments/<id>/run |
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the deployment |
Request URI - Example:
| Code Block |
|---|
/v3/deployments/4/run |
Request Body:
Empty.
Response
Response Status Code - Success: 201 - Created
Response Body Example:
| Code Block |
|---|
{
"data": [
{
"reason": "JobStarted",
"sessionId": "dd6a90e0-c353-11e7-ad4e-7f2dd2ae4621",
"id": 33,
"jobs": {
"data": [
{
"id": 68
},
{
"id": 69
},
{
"id": 70
}
]
}
}
]
} |
Reference
| Property | Description |
|---|---|
| reason | Action undertaken on the endpoint. |
| sessionId | Internal identifier for the session of the job run |
| id | JobGroup identifier. For more information, see API JobGroups Get v3. |
| jobs.data.id | Internal identifier for the individual jobs that compose the job group being executed. |
