Pipelines REST API

Overview

JFrog Pipelines provides a convenient and up-to-date self-descriptive API that can be used by various tools/frameworks to automate the creation and execution of pipelines.

Usage

Pipelines REST API endpoints can be invoked in any of the standard ways to invoke a RESTful API. This section describes how to use the Pipelines REST API using cURL as an example.

Using and Configuring cURL

You can download cURL here. Learn how to use and configure cURL here.

Authentication

Pipelines' REST API requires using an access token as a bearer token in the authorization header.

The example below demonstrates how to invoke the REST API to get the list of configured pipelines.

You have JFrog Pipelines running on your local system, on port 8082 (http://localhost:8082/pipelines/api)
You have created an access token

Using cURL with the REST API

$ curl -H 'Authorization : Bearer <token>' 'http://localhost:8082/pipelines/api/v1/pipelines' -X GET -H 'Content-Type: application/json'

Page Contents

SYSTEM

Get System Information

Description: Gets system version and service ID information.

Security: Requires a valid user
Usage: GET api/v1/system/info
Produces: application/json

Sample Response:

{ 
  "version": "1.1.0", 
  "serviceId": "string"
}

INTEGRATIONS

Jenkins Hook

Description: Handles a callback webhook from Jenkins to update BuildInfo.

Security: Requires a valid user
Usage: POST api//v1/projectIntegrations/{projectIntegrationId}/hook

Produces: application/json

Required Parameters:

Parameter	Data Type	Description
buildName	string	Name of of the build for BuildInfo
buildNumber	string	Number of the build for BuildInfo
buildInfoResourceName	boolean	Name of the Jenkins integration

Sample Usage:

curl -XPOST -H \"Authorization: Basic YWRtaW46N0pVd2NZWEtyVw==\" \"http://pipe-master.jfrog.info:8082/pipelines/api/v1/projectIntegrations/627/hook\" -d '{
  "buildName": "mybuild",	
  "buildNumber": 1,
  "buildInfoResourceName": "mybuildinfo",
}'

Response:

200 OK
{
  "pipelineStepIds": [
    0
  ],
  "resourceVersionIds": [
    0
  ]
}

Response Codes:

200: Success
404: No integration found for the supplied projectIntegrationId

PIPELINE SOURCES

Get Pipeline Sources

Description: Gets a collection of pipeline sources that the credential has access to. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user
Usage: GET api/v1/pipelinesources

Query Parameters:

Parameter	Data Type	Description
limit	integer	Optional. A limit on the number of pipelineSources returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of pipelineSources skipped.
pipelineSourceIds	string	Optional. A filter on the list based on the `is` that the pipelineSource belongs to. Expects a comma separated list of ids.
projectIds	string	Optional. A filter on the list based on the `projectId` that the pipelineSource belongs to. Expects a comma separated list of projectIds.
projectIntegrationIds	string	Optional. A filter on the list based on the `projectIntegrationId` that the pipelineSource belongs to. Expects a comma separated list of projectIntegrationIds.
includeNamesPattern	string	Optional. Only pipielineSources with repositoryFullName/branch matching one of the comma-separated patterns will be returned.
excludeNamesPattern	string	Optional. Only pipielineSources with repositoryFullName/branch not matching any of the comma-separated patterns will be returned.

Produces: application/json
Sample Response:

GET api/v1/pipelinesources
[
  {
    "id": 0,
    "projectId": 0,
    "projectIntegrationId": 0,
    "repositoryFullName": "string",
    "isMultiBranch": true,
    "branch": "string",
    "branchExcludePattern": "string",
    "branchIncludePattern": "string",
    "fileFilter": "string",
    "isSyncing": true,
    "lastSyncStatusCode": 0,
    "lastSyncStartedAt": "2020-06-01T20:27:09.165Z",
    "lastSyncEndedAt": "2020-06-01T20:27:09.165Z",
    "lastSyncLogs": "string",
    "resourceId": 0,
    "createdBy": "string",
    "updatedBy": "string"
  }
]

Response Codes:
200: Success

Add a Pipeline Source

Description: Adds a pipeline source.

Security: Requires admin credentials
Usage: POST api/v1/pipelinesources

Produces: application/json

Required Parameters:

Parameter	Data Type	Description
projectId	integer	Required. For future use. Set to 1 always
projectIntegrationId	integer	Required. Id of the Git integration to use to create the pipeline source
repositoryFullName	string	Required. Full name of the Git repository that has the pipeline definition
branch	string	Required for a single branch pipeline. Name of branch that has the pipeline definition
fileFilter	string	Required. Pattern for the pipeline source definition file
isMultiBranch	boolean	Optional. Set to true if creating a multibranch pipeline
branchExcludePattern	string	Optional. For multibranch pipeline source, specifies the pattern to exclude branches
branchIncludePattern	string	Required for multibranch pipeline source, specifies the pattern to include branches

Sample Usage:

Example: Adds a pipeline source

curl -X POST -H "Authorization: Bearer <your-token> <Pipelines-Url>/api/v1/pipelinesources -d '{
  "projectId": 1,	
  "projectIntegrationId": 66,
  "repositoryFullName": "myrepo/docker-sample",
  "branch": "master",
  "fileFilter": "pipelines.yml"
}'

Response

200 OK
{
    "id": 1181,
    "projectId": 1,
    "projectIntegrationId": 66,
    "repositoryFullName": "myrepo/docker-sample",
    "isMultiBranch": false,
    "branch": "master",
    "branchIncludePattern": null,
    "branchExcludePattern": null,
    "fileFilter": "pipelines.yml",
    "isSyncing": false,
    "lastSyncStatusCode": 0,
    "lastSyncStartedAt": "2020-06-01T20:41:04.650Z",
    "lastSyncEndedAt": "2020-06-01T20:41:04.650Z",
    "lastSyncLogs": null,
    "resourceId": 2017,
    "createdBy": "janeroe",
    "updatedBy": "janeroe"
}

Response Codes:

200: Success
404: No pipeline found for the supplied ID

PIPELINES

Get Pipelines

Description: Gets a collection of pipelines that the credential has access to. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user
Usage: GET api/v1/pipelines

Query Parameters:

Parameter	Data Type	Description
projectIds	string	Optional. A filter on the list based on the `projectId` property of the pipeline. Expects a comma separated string of projectIds.
pipelineSourceBranches	string	Optional. A filter on the list based on the `pipelineSourceBranch` property of the pipeline. Expects a comma separated string of pipelineSourceBranches.
pipelineIds	string	Optional. A filter on the list based on the `id` property of the pipeline. Expects a comma separated string of ids.
names	string	Optional. A filter on the list based on the `name` property of the pipeline. Expects a comma separated string of names.
pipelineSourceIds	string	Optional. A filter on the list based on the `pipelineSourceId` property of the pipeline. Expects a comma separated string of pipelineSourceIds.
includeDeleted	boolean	Optional. A filter on the list based on the `isDeleted` property of the pipeline. Default false.
isDeleted	boolean	Optional. A filter on the list based on the `isDeleted` property of the pipeline. If includeDeleted is true, this will be ignored.
deletedBefore	string($date-time)	Optional. A filter on the list that returns if `deletedAt` property of the pipeline is less than `deletedBefore`.
light	boolean	Optional. Default is false. If set to true only part of the data is returned
sortBy	string	Optional. Comma separated list of sort attributes
sortOrder	integer	Optional. 1 for ascending and -1 for descending based on `sortBy`
limit	integer	Optional. A limit on the number of pipelines returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of pipelines skipped.

Produces: application/json
Sample Usage:

GET api/v1/pipelines?light=true
[
  {
    "id": 375,
    "name": "gradle_pipeline",
    "pipelineSourceBranch": null,
    "pipelineSourceId": 544,
    "latestRunId": 717
  },
  {
    "id": 98,
    "name": "basic",
    "pipelineSourceBranch": null,
    "pipelineSourceId": 130,
    "latestRunId": null,
  }
]

Response Codes:
200: Success

Get Pipeline by ID

Description: Gets a single pipeline for the supplied numeric id.

Security: Requires a valid user
Usage: GET api/v1/pipelines/:pipelineId

Produces: application/json

Sample Usage:

GET /api/v1/pipelines/375

{
  "ymlConfigPropertyBag": null,
  "ymlPropertyBag": {
    "name": "gradle_pipeline",
    "steps": [
      {
        "name": "gradle_build_step",
        "type": "GradleBuild",
        "configuration": {
          "gradleCommand": "clean artifactoryPublish -b build.gradle",
          "sourceLocation": "gradle-examples/gradle-example-minimal",
          "configFileLocation": ".",
          "configFileName": "gradle-art-config",
          "inputResources": [
            {
              "name": "gradle_repo"
            }
          ],
          "integrations": [
            {
              "name": "art"
            }
          ]
        }
      },
      {
        "name": "publish_build_info_gradle",
        "type": "PublishBuildInfo",
        "configuration": {
          "inputSteps": [
            {
              "name": "gradle_build_step"
            }
          ],
          "outputResources": [
            {
              "name": "build_info_gradle"
            }
          ]
        }
      }
    ]
  },
  "id": 375,
  "name": "gradle_pipeline",
  "pipelineSourceBranch": null,
  "projectId": 1,
  "pipelineSourceId": 544,
  "latestRunNumber": 3,
  "latestRunId": 717,
  "syntaxVersion": "v1.0",
  "isDeleted": false,
  "deletedAt": null,
  "createdAt": "2020-02-04T13:36:57.172Z",
  "updatedAt": "2020-02-13T17:57:05.839Z"
}

Response Codes:
200: Success
404: No pipeline found for the supplied ID

Get Pipeline Artifacts

Description: Download artifacts of a pipeline. A artifactName querystring should be included to specify the names of the artifacts to download.

Security: Requires a valid user
Usage: GET /v1/pipelines/:pipelineId/artifacts

Query Parameters:

Parameter	Data Type	Description
artifactName	string	Required. Name of the artifact that has to be downloaded.

Produces: application/gzip
Response: Returns a .tar.gz file.

Response Codes:
200: Success
404: Artifact URLs cannot be found and an empty file is returned if the artifact is otherwise unavailable.

Get Pipeline State

Description: Gets a download URL for the latest version of the pipeline state.

Security: Requires a valid user
Usage: GET /v1/pipelines/:pipelineId/latestState
Produces: application/json

Sample Response:

{
  "getOpts": "string",
  "get": "string"
}

Response Codes:
200: Success
400: Checking for archives fails
404: There is no global root bucket

RUNS

Get Runs

Description: Gets a collection of runs. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user
Usage: GET /v1/runs

Query Parameters:

Parameter	Data Type	Description
limit	integer	Optional. A limit on the number of runs returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of runs skipped.
light	boolean	Optional. Default is false. If set to true only part of the data is returned
runIds	string	Optional. A filter on the list based on the `id` property of the run. Expects a comma separated string of runIds.
projectIds	string	Optional. A filter on the list based on the `projectId` property of the run. Expects a comma separated string of projectIds.
pipelineIds	string	Optional. Comma separated list of pipeline ids for which runs are being retrieved
pipelineSourceIds	string	Optional. Comma separated list of pipeline source ids for which runs are being retrieved
runIds	string	Optional. Comma separated list of run ids
projectIds	string	Optional. A filter on the list based on the `projectId` property of the run. Expects a comma separated string of projectIds.
runNumbers	string	Optional. Comma separated list of run numbers
createdAfter	string	Optional. Runs created before the date
createdBefore	string	Optional. Runs created after the date
statusCodes	string	Optional. Comma separated string of status codes
sortBy	string	Optional. Comma separated list of sort attributes
sortOrder	integer	Optional. 1 for ascending and -1 for descending based on `sortBy`

Produces: application/json
Sample Usage:

Example: Get the successful (statusCode: 4002) runs created after a certain date for a specific pipeline (id: 375)

GET api/v1/runs?pipelineIds=375&statusCode=4002&createdAfter=2020-02-02T13:37:19.290Z
[
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 717,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 3,
        "statusCode": 4002,
        "endedAt": "2020-02-13T17:58:07.042Z",
        "startedAt": "2020-02-13T17:57:16.575Z",
        "createdAt": "2020-02-13T17:57:05.834Z",
        "updatedAt": "2020-02-13T17:58:16.438Z"
    },
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 528,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 1,
        "statusCode": 4002,
        "endedAt": "2020-02-04T13:38:20.958Z",
        "startedAt": "2020-02-04T13:37:26.666Z",
        "createdAt": "2020-02-04T13:37:19.290Z",
        "updatedAt": "2020-02-04T13:38:25.536Z"
    },
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 654,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 2,
        "statusCode": 4002,
        "endedAt": "2020-02-10T12:25:57.600Z",
        "startedAt": "2020-02-10T12:25:00.630Z",
        "createdAt": "2020-02-10T12:22:22.134Z",
        "updatedAt": "2020-02-10T12:26:06.832Z"
    }
]

Response Codes:

200: Success

Get Runs by ID

Description: Gets a single run for the supplied numeric ID.
Security: Requires a valid user
Usage: GET /v1/runs/:runId
Produces: application/json

Sample Usage:

{
  "id": 0,
  "pipelineId": 0,
  "pipelineSourceId": 0,
  "projectId": 0,
  "runNumber": 0,
  "statusCode": 0,
  "staticPropertyBag": {},
  "endedAt": "2019-12-03T22:37:38.982Z",
  "startedAt": "2019-12-03T22:37:38.982Z"
}

Response Codes:

200: Success
400: Run not found for the supplied ID

Get Run Resource Versions

Description: Gets a collection of resource versions that were produced in runs. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user
Usage: GET /v1/runResourceVersions

Query Parameters:

Parameter	Data Type	Description
limit	integer	Optional. A limit on the number of runResourceVersions returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of runResourceVersions skipped.
runResourceVersionIds	string	Optional. A filter on the list based on the `id` property of the runResourceVersion. Expects a comma separated string of runResourceVersionIds.
pipelineIds	string	Optional. Comma separated list of pipeline ids for which runs are being retrieved
projectIds	string	Optional. Comma separated list of project ids for which runs are being retrieved
pipelineSourceIds	string	Optional. Comma separated list of pipeline source ids for which runs are being retrieved
runIds	string	Optional. Comma separated list of run ids
stepIds	string	Optional. Comma separated list of step ids
resourceNames	string	Optional. Comma separated list of resource names
resourceVersionIds	string	Optional. Comma separated list of resource version IDs
sortBy	string	Optional. Comma separated list of sort attributes
sortOrder	integer	Optional. 1 for ascending and -1 for descending based on `sortBy`

Produces: application/json
Sample Response:

GET api/v1/runresourceversions?pipelineIds=375&runIds=717
[
    {
        "resourceStaticPropertyBag": {},
        "resourceConfigPropertyBag": {
            "integrationName": "art",
            "integrationAlias": "sourceArtifactory"
        },
        "resourceVersionContentPropertyBag": {
            "buildName": "test_gradle_pipeline",
            "buildNumber": "3",
            "targetRepo": "test-generic-local"
        },
        "id": 940,
        "projectId": 1,
        "pipelineSourceId": 544,
        "pipelineId": 375,
        "runId": 717,
        "stepId": 1278,
        "resourceName": "promoted_build_info_gradle",
        "resourceTypeCode": 2018,
        "resourceVersionId": 2017,
        "resourceVersionCreatedByStepId": 1278,
        "createdAt": "2020-02-13T17:57:06.667Z",
        "updatedAt": "2020-02-13T17:58:06.936Z"
    },
    {
        "resourceStaticPropertyBag": {},
        "resourceConfigPropertyBag": {
            "integrationName": "art",
            "integrationAlias": "sourceArtifactory"
        },
        "resourceVersionContentPropertyBag": {
            "buildName": "test_gradle_pipeline",
            "buildNumber": "3"
        },
        "id": 941,
        "projectId": 1,
        "pipelineSourceId": 544,
        "pipelineId": 375,
        "runId": 717,
        "stepId": 1278,
        "resourceName": "build_info_gradle",
        "resourceTypeCode": 2018,
        "resourceVersionId": 2016,
        "resourceVersionCreatedByStepId": 1277,
        "createdAt": "2020-02-13T17:57:06.670Z",
        "updatedAt": "2020-02-13T17:58:02.906Z"
    }
]

Response Codes:

200: Success

RESOURCES

Get Resources

Description: Gets a collection of resources. Filter criteria can be supplied via query string parameters. Gets all resources if no query parameters are supplied.

Security: Requires a valid user
Usage: GET /v1/resources

Query Parameters:

Parameter	Data Type	Description
pipelineIds	string	Optional. Comma separated list of pipeline ids for which runs are being retrieved
resourceIds	string	Optional. Comma separated list of resource ids
projectIds	string	Optional. Comma separated list of project ids
names	string	Optional. Comma separated list of resource names
typeCodes	string	Optional. Comma separated list of resource type codes
pipelineSourceBranches	string	Optional. Comma separated list of pipeline source branches
isDeleted	boolean	Optional. Default is false. Filters based on the `isDeleted` property of the resource
deletedBefore	string($date-time)	Optional. Filters for resources where `deletedAt` property is less than `deletedBefore`
isConsistent	boolean	Optional. Default is false. Filter based on the `isConsistent` property of the resource
isInternal	boolean	Optional. Default is false. Filter based on the `isInternal` property of the resource
projectIntegrationIds	string	Optional. Comma separated list of project integration IDs
createdBefore	string($date-time)	Optional. Runs created before the date
createdAfter	string($date-time)	Optional. Runs created after the date
nextTriggerTimeBefore	string($date-time)	Optional. Runs triggered before the date
sortBy	string	Optional. Comma separated list of sort attributes
sortOrder	integer	Optional. 1 for ascending and -1 for descending based on `sortBy`
limit	integer	Optional. A limit on the number of resources returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of resources skipped.

Produces: application/json

Sample Usage:

Example: Get all the build info resources defined across all the pipelines

GET api/v1/resources?typeCodes=2018
[
  {
    "id": 2019,
    "projectId": 1,
    "pipelineSourceId": 1181,
    "createdAt": "2020-02-23T00:42:48.028Z",
    "updatedAt": "2020-02-23T00:42:52.946Z",
    "ymlConfigPropertyBag": {
      "integrationName": "art",
      "integrationAlias": "sourceArtifactory"
    },
    "systemPropertyBag": {},
    "staticPropertyBag": {},
    "yml": {
      "name": "svc_build_info_sample",
      "type": "BuildInfo",
      "configuration": {
        "sourceArtifactory": "art",
        "buildName": "svc_build",
        "buildNumber": 1
      }
    },
    "name": "svc_build_info_sample",
    "pipelineSourceBranch": null,
    "projectIntegrationId": 65,
    "typeCode": 2018,
    "latestResourceVersionId": 2634,
    "isDeleted": false,
    "deletedAt": null,
    "isConsistent": true,
    "isInternal": false,
    "syntaxVersion": "v1.0",
    "nextTriggerTime": null
  },
  {
    "id": 2018,
    "projectId": 1,
    "pipelineSourceId": 1181,
    "createdAt": "2020-02-23T00:42:48.024Z",
    "updatedAt": "2020-02-23T00:42:52.948Z",
    "ymlConfigPropertyBag": {
      "integrationName": "art",
      "integrationAlias": "sourceArtifactory"
    },
    "systemPropertyBag": {},
    "staticPropertyBag": {},
    "yml": {
      "name": "svc_promoted_build_info_sample",
      "type": "BuildInfo",
      "configuration": {
        "sourceArtifactory": "art",
        "buildName": "svc_build",
        "buildNumber": 1
      }
    },
    "name": "svc_promoted_build_info_sample",
    "pipelineSourceBranch": null,
    "projectIntegrationId": 65,
    "typeCode": 2018,
    "latestResourceVersionId": 2633,
    "isDeleted": false,
    "deletedAt": null,
    "isConsistent": true,
    "isInternal": false,
    "syntaxVersion": "v1.0",
    "nextTriggerTime": null
  }
]

Response Codes:
200: Success

Get Resources by ID

Description: Gets a single resource for the supplied numeric id.

Security: Requires a valid user
Usage: GET /v1/resources/:resourceId
Produces: application/json

Sample Response:

GET api/v1/resources/2019
{
    "ymlConfigPropertyBag": {
        "integrationName": "art",
        "integrationAlias": "sourceArtifactory"
    },
    "systemPropertyBag": {},
    "staticPropertyBag": {},
    "yml": {
        "name": "svc_build_info_sample",
        "type": "BuildInfo",
        "configuration": {
            "sourceArtifactory": "art",
            "buildName": "svc_build",
            "buildNumber": 1
        }
    },
    "id": 2019,
    "name": "svc_build_info_sample",
    "pipelineSourceBranch": null,
    "projectIntegrationId": 65,
    "typeCode": 2018,
    "latestResourceVersionId": 2634,
    "projectId": 1,
    "pipelineSourceId": 1181,
    "isDeleted": false,
    "deletedAt": null,
    "isConsistent": true,
    "isInternal": false,
    "syntaxVersion": "v1.0",
    "nextTriggerTime": null,
    "createdAt": "2020-02-23T00:42:48.028Z",
    "updatedAt": "2020-02-23T00:42:52.946Z"
}

Response Codes:
200: Success
404: No resource is found for the supplied id.

STEPS

Get Steps

Description: Gets a collection of step. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user
Usage: GET /v1/steps
Consumes: application/json

Query Parameters:

Parameter	Data Type	Description
limit	integer	Optional. A limit on the number of steps returned.
skip	integer	Optional. A cursor for use in pagination. `skip` defines the number of steps skipped
pipelineIds	string	Optional. Comma separated list of pipeline ids for which runs are being retrieved
stepIds	string	Optional. Comma separated list of step ids for filtering
projectIds	string	Optional. Comma separated list of project ids for filtering
runIds	string	Optional. Comma separated list of run ids for filtering
pipelineSourceIds	string	Optional. Comma separated list of pipeline source ids for filtering
pipelineStepIds	string	Optional. Comma separated list of pipeline step ids for filtering
names	string	Optional. Comma separated list of name properties for filtering
statusCodes	string	Optional. Comma separated list of step status codes for filtering
affinityGroups	string	Optional. Comma separated list of step affinity groups for filtering
groupInProgress	boolean	Optional. Default is false. Filter based on the `groupInProgress` property of the resource
timeoutBefore	string	Optional. Selects steps with `timeoutAt` before the given date-time.
startedBefore	string	Optional. Selects steps with `startedAt` before the given date-time.
startedAfter	string	Optional. Selects steps with `startedAt` after the given date-time.
endedBefore	string	Optional. Selects steps with `endedAt` before the given date-time.
endedAfter	string	Optional. Selects steps with `endedAt` after the given date-time.

Produces: application/json
Sample Usage:

GET api/v1/steps?typeCode=2007&limit=1
[
    {
        "configPropertyBag": {
            "inputSteps": [
                {
                    "name": "step_3"
                },
                {
                    "name": "step_4"
                }
            ],
            "environmentVariables": [
                {
                    "key": "myReadEnvVariable",
                    "value": "hello",
                    "isReadOnly": true
                }
            ],
            "nodePool": "u16",
            "timeoutSeconds": 3600,
            "runtime": {
                "type": "image",
                "image": {
                    "imageName": "docker.bintray.io/jfrog/pipelines-u16node",
                    "imageTag": "10.18.0"
                }
            }
        },
        "execPropertyBag": {
            "onExecute": [
                "echo \"step 5\""
            ]
        },
        "id": 508,
        "pipelineId": 97,
        "pipelineSourceId": 129,
        "pipelineStepId": 192,
        "projectId": 1,
        "name": "step_5",
        "runId": 232,
        "statusCode": 4008,
        "typeCode": 2007,
        "affinityGroup": "step_5",
        "groupInProgress": false,
        "pendingLogsComplete": true,
        "isConsoleArchived": true,
        "fileStoreProvider": null,
        "pipelineStateArtifactName": null,
        "triggeredByResourceVersionId": null,
        "triggeredByStepId": null,
        "triggeredByIdentityId": 3,
        "triggeredAt": "2020-01-17T19:12:22.387Z",
        "timeoutAt": null,
        "readyAt": null,
        "queuedAt": null,
        "endedAt": "2020-01-17T19:12:49.800Z",
        "startedAt": null,
        "externalBuildId": null,
        "externalBuildUrl": null,
        "staticPropertyBag": null,
        "createdAt": "2020-01-17T19:12:22.419Z",
        "updatedAt": "2020-01-17T19:13:04.535Z"
    }
]

Response Codes:

200: Success

Get Step by ID

Description: Gets a single step for the supplied ID.

Security: Requires a valid user
Usage: GET /v1/steps/:stepId
Consumes: application/json
Sample Response:

GET api/v1/steps/55
{
    "configPropertyBag": {
        "runtime": {
            "type": "host"
        },
        "affinityGroup": "together",
        "inputSteps": [
            {
                "name": "ag_step_1"
            }
        ],
        "environmentVariables": [
            {
                "key": "MY_MESSAGE",
                "value": "\"Hello World!\"",
                "isReadOnly": true
            }
        ],
        "nodePool": "u16",
        "timeoutSeconds": 3600,
        "isOnDemand": false,
        "instanceSize": null,
        "nodeName": "1"
    },
    "execPropertyBag": {
        "onExecute": [
            "pwd",
            "cat myoutput.txt"
        ]
    },
    "id": 55,
    "pipelineId": 62,
    "pipelineSourceId": 109,
    "pipelineStepId": 73,
    "projectId": 1,
    "name": "ag_step_2",
    "runId": 41,
    "statusCode": 4003,
    "typeCode": 2007,
    "affinityGroup": "together",
    "groupInProgress": false,
    "pendingLogsComplete": true,
    "isConsoleArchived": true,
    "fileStoreProvider": null,
    "pipelineStateArtifactName": null,
    "triggeredByResourceVersionId": null,
    "triggeredByStepId": null,
    "triggeredByIdentityId": 3,
    "triggeredAt": "2020-01-06T21:45:37.911Z",
    "timeoutAt": "2020-01-06T22:45:50.636Z",
    "readyAt": null,
    "queuedAt": "2020-01-06T21:45:49.641Z",
    "endedAt": "2020-01-06T21:45:51.613Z",
    "startedAt": "2020-01-06T21:45:50.636Z",
    "externalBuildId": null,
    "externalBuildUrl": null,
    "staticPropertyBag": null,
    "createdAt": "2020-01-06T21:45:37.951Z",
    "updatedAt": "2020-01-06T21:46:06.296Z"
}

Response Codes:

200: Success
404: No step was found for the supplied ID

Content

Space Tools

Pipelines REST API

Overview

Usage

Authentication

SYSTEM

Get System Information

INTEGRATIONS

Jenkins Hook

PIPELINE SOURCES

Get Pipeline Sources

Add a Pipeline Source

PIPELINES

Get Pipelines

Get Pipeline by ID

Get Pipeline Artifacts

Get Pipeline State

RUNS

Get Runs

Get Runs by ID

RESOURCES

Get Resources

Get Resources by ID

STEPS

Get Steps

Get Step by ID