Run the job for the active release of the specified deployment.

NOTE: Deployments pertain to Production instances of the . For more information, see Overview of Deployment Manager.

Version: v3

Required Permissions

Request

Request Type: POST

Endpoint:

/v3/deployments/<id>/run

where:

ParameterDescription
<id>Internal identifier for the deployment

Request URI - Example:

/v3/deployments/4/run

Request Body:

Empty.

Request Body - dataset with parameters:

You can apply parameter overrides when running a deployment. Add the following structure to the request body:

{ 
  "runParameters": { 
    "overrides": { 
       "data": [
          { "key": "myParamName", "value": "override value"
     }]
    } 
  }
}

where:

ItemDescription
keyName of parameter to apply to the job run.
valueThe string value to assign to the parameter for the job run.

 

Response

Response Status Code - Success: 201 - Created

Response Body Example:

{
    "data": [
        {
            "reason": "JobStarted",
            "sessionId": "dd6a90e0-c353-11e7-ad4e-7f2dd2ae4621",
            "id": 33,
            "jobs": {
                "data": [
                    {
                        "id": 68
                    },
                    {
                        "id": 69
                    },
                    {
                        "id": 70
                    }
                ]
            }
        }
    ]
}

Reference

PropertyDescription
reasonAction undertaken on the endpoint.
sessionIdInternal identifier for the session of the job run
idJobGroup identifier. For more information, see API JobGroups Get v3.
jobs.data.idInternal identifier for the individual jobs that compose the job group being executed.