Pipelines

Get the status of a pipeline run

Retrieves the status of a pipeline run. The operation returns a pipeline run status. Every request must be authenticated by a personal access token containing the scope mx:pipelines:read.

get/apps/{appId}/runs/{runId}/status

Request

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

Response

200 Get Status response

runIdstring uuid required

The unique run ID in UUID format.

status'CREATED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' required

An array of possible pipeline run statuses.

Example response

{
  "runId": "2868b153-2d92-4ec5-ab64-2e26a9e0f16e"
}

Changes

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