MEmendix
Pipelines

Start a new pipeline run for a saved and activated pipeline design

Schedules a job on the server to start a new pipeline run. The job will be handled asynchronously; the operation returns a pipelineID that can be used to monitor the status of the process. Every request must be authenticated by a personal access token containing the scope mx:pipelines:write.

post/apps/{appId}/runs

Request

  • Base URL
    https://pipeline-portal.home.mendix.com/api/v1
  • Auth
    API key in header Authorization

Request body

pipelineIdstring uuid required

UUID of the pipeline.

Example request

{
  "pipelineId": "db6ed4d3-8b6d-4c2b-ad2b-2a69d0f7afe0"
}

Response

Pipeline run is created. The Content-Location header can be used for the follow-up request to retrieve the run's status.

idstring uuid required

The unique run ID in UUID format.

pipelineIdstring uuid required

The unique pipeline ID in UUID format.

pipelineNamestring required

Example response

{
  "id": "2868b153-2d92-4ec5-ab64-2e26a9e0f16e",
  "pipelineId": "db6ed4d3-8b6d-4c2b-ad2b-2a69d0f7afe0",
  "pipelineName": "Test pipeline",
  "triggeredBy": {
    "email": "jane.doe@example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.