Jump to

• Request
• Response
• Examples

Get the status of a pipeline instance

get

/v1/pipelines/{pipelineName}/instances/{instanceId}/status

Returns RUNNING, or NOT_RUNNING

Request

Path Parameters

• instanceId: string
  Identifier of the pipeline instance
• pipelineName: string
  pipeline name

Back to Top

Response

Supported Media Types

• text/plain

200 Response

{log}

400 Response

ERROR: instance id {id} must be > 0 or integer

404 Response

ERROR: No such pipeline {pipelineName}

Back to Top

Examples

The following example shows how to get the status (NOT_RUNNING) of a pipeline instance (124) for the pipeline (ParamPipeline) by submitting a GET request on the REST resource using curl.

curl -X GET -u alex.admin https://myinstance.oracle.com/myorg/rest/myorg_bobtest_1/cibuild/v1/pipelines/ParamPipeline/instances/124/status
Enter host password for user 'alex.admin':
NOT_RUNNING

One of the following statuses could be returned: RUNNING or NOT_RUNNING.

Errors

If the pipeline can't be found, you'll see this error:

ERROR: Pipeline with name "{pipelineName}" does not exist

If the pipeline can be found but the instance can't, you'll see this error:

ERROR: Pipeline "{pipelineName}" instance "{instanceId}" does not exist

Back to Top