Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
2308 lines (1945 sloc) 78.7 KB

The Blue Ocean REST API is a "private API" designed for the Blue Ocean user interface. It may change without notice at any time.

Table of Contents generated with DocToc

This document defines REST API interface that front end UI or any HTTP client can use.

Run Blue Ocean plugin

cd blueocean-plugin
mvn hpi:run

This will launch a development Jenkins instance with the Blue Ocean plugin and this plugin ready to go.

BlueOcean UI is available at:

http://localhost:8080/jenkins/blue

BlueOcean rest API base URL is:

http://localhost:8080/jenkins/blue/rest

Schema

Media Type

  • All responses are application/json content type
  • All POST/PUT/PATCH methods must be application/json content type

Date Format

All date formats are in ISO 8601 format

YYYY-MM-DDTHH:MM:SSZ

Error Message

{
  "message" : "Failed to create Git pipeline: demo",
  "code" : 400,
  "errors" : [ {
    "message" : "demo already exists",
    "code" : "ALREADY_EXISTS",
    "field" : "name"
  } ]
}

message - High level error message. E.g. 'Failed to create Git Pipeline'

code - error code, should be HTTP error code

errors - array of errors for request fields.

errors.message - Field validation error message.

errors.code - Field validation codes. Known codes, ALREADY_EXISTS, MISSING, NOT_FOUND, INVALID.

errors.field - Name of the field in request. Top level field name are represented as it is. Request subgraph are represented as follows:

  • If value is map its represented with . notation. For example for {"scmConfig":{"uri":"abcd"}}, the field name will be scmConfig.uri
  • If value is array its represented with [index] notation. For example for {"repos":[{"name":"abcd"}}], the field name will be repos[0].name

Field Error codes

Field Error Code Description
ALREADY_EXISTS Field value already exists
MISSING Required field
NOT_FOUND Field value not found
INVALID Invalid field value

Http Error codes

HTTP Error Code Description
400 Bad Request
401 Unauthorized, invalid credentials
403 Forbidden, not authorized
404 Not found
500 Unexpected error

Crumbs

Jenkins usually requires a "crumb" with posted requests to prevent request forgery and other shenanigans. To avoid needing a crumb to POST data, the header Content-Type: application/json must be used.

Security

NOTE: JWT is disabled by default for now. to enable JWT authentication use BLUEOCEAN_FEATURE_JWT_AUTHENTICATION=true system property.

mvn hpi:run -DBLUEOCEAN_FEATURE_JWT_AUTHENTICATION=true

With -DBLUEOCEAN_FEATURE_JWT_AUTHENTICATION=false (default)

  • No JWT tokens are send from the frontend.
  • Api does not look for a JWT token, and instead uses cookies for authentication.

With -DBLUEOCEAN_FEATURE_JWT_AUTHENTICATION=true

  • JWT tokens are fetched and sent with api requests from the frontend.
  • API requires a valid JWT token, and does not use cookies for authentication.

BlueOcean REST APIs requires JWT token for authentication. JWT APIs are provided by blueocean-jwt plugin. See JWT APIs to get JWT token and to get public key needed to verify the claims.

JWT token must be sent as bearer token as value of HTTP 'Authorization' header:

curl -H 'Authorization: Bearer eyJraWQ...' http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/

API access from browser with JWT enabled

Sometimes testing API from browser is desirable. Here are steps to to do that using Postman Chrome app:

  • Install Postman on Chrome (chrome://apps/) or install Postman app on Mac OS (https://www.getpostman.com).
  • Launch postman
  • Create a JWT token, see JWT APIs. You can customize expiry time to reuse the fetched token. You may like to save the query in Postman as collection blueocean. Anytime later you want to generate token use blueocean collection and click send on previous GET.
  • Click on + on tab and type the API URL, e.g. http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/, then add header with Authorization header with value Bearer COPIED_JWT_TOKEN. Use this tab to invoke any Blueocean REST API. You may like to either add to 'blueocean' collection if you like.

Navigability

Links

Each BlueOcean JSON response object includes *_links" as defined by HAL spec. self link references the reachable path to this resource. It may include other navigable resources as well. A resource can expose it's methods as navigable by using @Navigable annotation.

"_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/f/"
    },
    "runs" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/f/runs/"
    },
    "queue" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/f/queue/"
    }

Above, self references path to pipeline 'f', runs and queue resource are navigable from this resource and their href references path to them.

Resource discovery

Each resource provides _class field, it’s a fully qualified name and is an identifier of the producer of this resource's capability.

{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/p/"
    },
    "branches" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/"
    },
    "runs" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/p/runs/"
    },
    "queue" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/p/queue/"
    }
  },
  "displayName" : "p",
  ....
}

Above a multi-branch pipeline resource object's class is exposed using _class element: io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl.

classes API

Get class details

To get list of what other classes or capabilities io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl class supports, use classes API:

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/classes/io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl
{
  “classes”:[“io.jenkins.blueocean.rest.model.BlueMultiBranchPipeline”,"io.jenkins.blueocean.rest.model.BluePipeline","io.jenkins.blueocean.rest.model.Resource"]
}

Above MultiBranchPipelineImpl supports capabilities: BlueMultiBranchPipeline, BluePipeline and Resource.

Frontend can use _class in resource and classes API to serve UI based on class or capability this resource supports.

Get detailed map of all given classes

curl -v -X POST  http://localhost:8080/jenkins/blue/rest/classes/ -d '{"q":["io.jenkins.blueocean.service.embedded.rest.PipelineImpl","io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl"]

{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.ExtensionClassContainerImpl$1",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/classes/?q=io.jenkins.blueocean.service.embedded.rest.PipelineImpl,io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl,io.jenkins.blueocean.service.embedded.PipelineApiTest$TestPipelineImpl/"
    }
  },
  "map" : {
    "io.jenkins.blueocean.service.embedded.rest.PipelineImpl" : {
      "_class" : "io.jenkins.blueocean.service.embedded.rest.ExtensionClassImpl",
      "_links" : {
        "self" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/classes/io.jenkins.blueocean.service.embedded.rest.PipelineImpl/"
        }
      },
      "classes" : [ "io.jenkins.blueocean.rest.model.BluePipeline", "io.jenkins.blueocean.rest.model.Resource" ]
    },
    "io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl" : {
      "_class" : "io.jenkins.blueocean.service.embedded.rest.ExtensionClassImpl",
      "_links" : {
        "self" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/classes/io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl/"
        }
      },
      "classes" : [ "io.jenkins.blueocean.rest.model.BlueMultiBranchPipeline", "io.jenkins.blueocean.rest.model.BluePipelineFolder", "io.jenkins.blueocean.rest.model.BluePipeline", "io.jenkins.blueocean.rest.model.Resource" ]
    }
  }
}

User API

Get a user

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/users/alice

{
  "id" : "alice",
  "fullName" : "Alice"
  "email" : "alice@example.com"
}

Find users in an organization

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/users/

[
  {
    "id" : "alice",
    "name" : "Alice"
  }
]

Get authenticated user

Gives authenticated user, gives HTTP 404 error if there is no authenticated user found.

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/user/

{
  "id" : "alice",
  "fullName" : "Alice"
  "email" : "alice@example.com"
}

Organization API

Get organization details

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins

{
  "name" : "jenkins"
}

Get all organizations

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/

[{
  "name" : "jenkins"
}]

Pipeline API

Get a Pipeline

curl -v -X GET  "http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1"

{
  "organization" : "jenkins",
  "name" : "pipeline1",
  "displayName": "pipeline1",
  "fullName": "pipeline1",
  "weatherScore": 100,
  "estimatedDurationInMillis": 20264,
  "latestRun": {
      "changeSet": [],
      "artifacts": [
          {
              "name": "fizz",
              "size": 8,
              "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
          }
      ],
      "durationInMillis": 20264,
      "estimatedDurationInMillis" : 567,
      "enQueueTime": "2016-04-11T17:44:28.342+1000",
      "endTime": "2016-04-11T17:44:48.608+1000",
      "id": "3",
      "organization": "jenkins",
      "pipeline": "mypipe1",
      "result": "SUCCESS",
      "runSummary": "stable",
      "startTime": "2016-04-11T17:44:28.344+1000",
      "state": "FINISHED",
      "type": "WorkflowRun",
      "commitId": null
    }
}

Get Pipelines for an organization

Pipelines are sorted by pipeline name alphabetically

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/

[
  {
  "organization" : "jenkins",
  "name" : "pipeline1",
  "displayName": "pipeline1",
  "fullName" : "pipeline1",
  "weatherScore": 100,
  "estimatedDurationInMillis": 280,
  }
]

Get Pipelines across organization

Pipelines are sorted by pipeline name alphabetically across organizations. It gives flattened list of pipelines including folders and nested pipelines inside them.

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/search/?q=type:pipeline

[
  {
  "organization" : "jenkins",
  "name" : "pipeline1",
  "displayName": "pipeline1",
  "fullName" : "pipeline1",
  "weatherScore": 100,
  "estimatedDurationInMillis": 280,
  }
]

Exclude flattening of certain job types

excludedFromFlattening query parameter takes comma separated class names of Jenkins item that should not be flattened.

To exclude flattening multi branch project:

GET http://localhost:8080/jenkins/blue/rest/search/?q=type:pipeline;organization:jenkins;excludedFromFlattening=jenkins.branch.MultiBranchProject

To exclude flattening a folder:

GET http://localhost:8080/jenkins/blue/rest/search/?q=type:pipeline;organization:jenkins;excludedFromFlattening=com.cloudbees.hudson.plugins.folder.AbstractFolder

To exclude flattening both a folder and multi-branch projects:

GET http://localhost:8080/jenkins/blue/rest/search/?q=type:pipeline;organization:jenkins;excludedFromFlattening=jenkins.branch.MultiBranchProject,com.cloudbees.hudson.plugins.folder.AbstractFolder

Get pipelines for specific organization

Use organization query parameter to get flattened pipelines in that organization. If given organization is not found a 400 BadRequest error is returned.

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/search/?q=type:pipeline;organization:jenkins

  [
     {
        "numberOfFailingBranches" : 0,
        "numberOfSuccessfulBranches" : 0,
        "_links" : {
           "queue" : {
              "href" : "/blue/rest/organizations/jenkins/pipelines/bo1/queue/",
              "_class" : "io.jenkins.blueocean.rest.hal.Link"
           },
           "actions" : {
              "href" : "/blue/rest/organizations/jenkins/pipelines/bo1/actions/",
              "_class" : "io.jenkins.blueocean.rest.hal.Link"
           },
           "runs" : {
              "_class" : "io.jenkins.blueocean.rest.hal.Link",
              "href" : "/blue/rest/organizations/jenkins/pipelines/bo1/runs/"
           },
           "self" : {
              "_class" : "io.jenkins.blueocean.rest.hal.Link",
              "href" : "/blue/rest/organizations/jenkins/pipelines/bo1/"
           },
           "branches" : {
              "href" : "/blue/rest/organizations/jenkins/pipelines/bo1/branches/",
              "_class" : "io.jenkins.blueocean.rest.hal.Link"
           }
        },
        "organization" : "jenkins",
        "estimatedDurationInMillis" : 1,
        "numberOfFailingPullRequests" : 0,
        "weatherScore" : 0,
        "fullName" : "bo1",
        "_class" : "io.jenkins.blueocean.service.embedded.rest.MultiBranchPipelineImpl",
        "totalNumberOfPullRequests" : 0,
        "runs" : [],
        "displayName" : "bo1",
        "totalNumberOfBranches" : 0,
        "numberOfPipelines" : 0,
        "name" : "bo1",
        "numberOfFolders" : 0,
        "numberOfSuccessfulPullRequests" : 0,
        "actions" : [],
        "branchNames" : []
     }
  ]

Parameterized Pipeline

A pipeline can define list of parameters pipeline job expects. For example:

  properties([parameters([string(defaultValue: 'xyz', description: 'string param', name: 'param1')]), pipelineTriggers([])])

  node(){
      stage('build'){
          echo "building"
      }
  }

Once this pipeline script is executed, subsequent REST call to get pipeline details (on a branch in multi-branch pipeline or just a pipeline job) will have 'parameters' element with all parameter definitions.

curl -X GET http://localhost:59702/jenkins/blue/rest/organizations/jenkins/pipelines/p/branches/master/

{
  "_class" : "io.jenkins.blueocean.rest.impl.pipeline.BranchImpl",
  "_links" : {...},
  "actions" : [...],
  "displayName" : "feature/ux-1",
  "estimatedDurationInMillis" : 1689,
  "fullDisplayName" : "p/master",
  "fullName" : "p/master",
  "latestRun" : {...},
  "name" : "feature%2Fux-1",
  "organization" : "jenkins",
  "parameters" : [ {
    "_class" : "hudson.model.StringParameterDefinition",
    "defaultParameterValue" : {
      "_class" : "hudson.model.StringParameterValue",
      "name" : "param1",
      "value" : "xyz"
    },
    "description" : "string param",
    "name" : "param1",
    "type" : "StringParameterDefinition"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "start" : true,
    "stop" : true
  },
  "weatherScore" : 100,
  "pullRequest" : null
}

Get a Folder

curl -v -X GET  http://localhost:63934/jenkins/blue/rest/organizations/jenkins/pipelines/folder1/
{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineFolderImpl",
  "displayName" : "folder1",
  "fullName" : "folder1",
  "name" : "folder1",
  "organization" : "jenkins",
  "numberOfFolders" : 1,
  "numberOfPipelines" : 1
}

Get Nested Pipeline Inside A Folder

curl -v -X GET   http://localhost:62054/jenkins/blue/rest/organizations/jenkins/pipelines/folder1/pipelines/folder2/pipelines/test2/

{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineImpl",
  "displayName" : "test2",
  "estimatedDurationInMillis" : -1,
  "fullName" : "folder1/folder2/test2",
  "latestRun" : null,
  "name" : "test2",
  "fullName" : "test2",
  "organization" : "jenkins",
  "weatherScore" : 100
}

Get nested Folder and Pipeline

Pipelines can be nested inside folder.

curl -v -X GET   http://localhost:62054/jenkins/blue/rest/organizations/jenkins/pipelines/folder1/pipelines/

[ {
  "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineFolderImpl",
  "displayName" : "folder2",
  "fullName" : "folder1/folder2",
  "name" : "folder2",
  "organization" : "jenkins",
  "numberOfFolders" : 0,
  "numberOfPipelines" : 1
}, {
  "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineImpl",
  "displayName" : "test1",
  "estimatedDurationInMillis" : -1,
  "fullName" : "folder1/test1",
  "latestRun" : null,
  "name" : "test1",
  "organization" : "jenkins",
  "weatherScore" : 100
} ]

MultiBranch Pipeline API

Create MultiBranch build and set it up with your git repo. Your git repo must have Jenkinsfile with build script. Each branch in the repo with Jenkins file will appear as a branch in this pipeline.

Get MultiBranch pipeline

curl -v http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/p/

{
    "displayName": "p",
    "estimatedDurationInMillis": 280,
    "latestRun": null,
    "name": "p",
    "organization": "jenkins",
    "weatherScore": 100,
    "branchNames": [
        "feature2",
        "master",
        "feature1"
    ],
    "numberOfFailingBranches": 0,
    "numberOfFailingPullRequests": 0,
    "numberOfSuccessfulBranches": 0,
    "numberOfSuccessfulPullRequests": 0,
    "totalNumberOfBranches": 3,
    "totalNumberOfPullRequests": 0
}

Get MultiBranch pipeline branches

The list of branches will be ordered by favorited branches first, and then branches that have the most recent activity.

curl -v http://localhost:56720/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/branches

[
    {
        "displayName": "feature2",
        "estimatedDurationInMillis": 1391,
        "name": "master",
        "weatherScore":100,
        "latestRun": {
            "changeSet": [

            ],
            "durationInMillis": 1391,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-04-15T19:59:28.717-0700",
            "endTime": "2016-04-15T19:59:30.114-0700",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "feature2",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-04-15T19:59:28.723-0700",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "662766a80af35404c430240e6996598d5397471e"
        },
        "name": "feature2",
        "organization": "jenkins",
        "weatherScore": 100,
        "pullRequest": {
            "_links": {
                "self":null
            },
            "author":"<githubuser>",
            "id":"543",
            "title":"Fixes for stuff",
            "url":"https://github.com/jenkinsci/some-plugin/pull/543"
        },
        "totalNumberOfPullRequests": 0
    },
    {
        "displayName": "master",
        "estimatedDurationInMillis": 1468,
        "name": "feature1",
        "weatherScore":100,
        "latestRun": {
            "changeSet": [

            ],
            "artifacts": [
              {
                  "name": "fizz",
                  "size": 8,
                  "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
              }
            ],
            "durationInMillis": 1468,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-04-15T19:59:28.730-0700",
            "endTime": "2016-04-15T19:59:30.199-0700",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "master",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-04-15T19:59:28.731-0700",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "96e0a0f29d9e5b1381ebb1b7503b0be04ed19a5b"
        },
        "name": "master",
        "organization": "jenkins",
        "weatherScore": 100,
        "pullRequest": null,
        "totalNumberOfPullRequests": 0
    },
    {
        "displayName": "feature1",
        "estimatedDurationInMillis": 1443,
        "name": "feature2",
        "weatherScore":100,
        "latestRun": {
            "changeSet": [

            ],
            "durationInMillis": 1443,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-04-15T19:59:28.723-0700",
            "endTime": "2016-04-15T19:59:30.167-0700",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "feature1",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-04-15T19:59:28.724-0700",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "f436952a7de493603f4937ecb9dac3f79fd13c79"
        },
        "name": "feature1",
        "organization": "jenkins",
        "weatherScore": 100,
        "pullRequest": null,
        "totalNumberOfPullRequests": 0
    }
]

Pipeline Permissions

Pipeline API response gives permission object in response:

Following permissions are returned as key to the permission map: create, start, stop, read for a pipeline job:

  • create: User can create a pipeline
  • start: User can start a run of this pipeline. If not applicable to certain pipeline then can be false or null.
  • stop: User can stop a run of this pipeline. If not applicable to certain pipeline then can be false or null.
  • read: User has permission to view this pipeline

For example for anonymous user with security enabled and only read permission, the permission map for a pipeline job is:

"permissions" : {
    "create" : false,
    "read" : true,
    "start" : false,
    "stop" : false
}

Implementation of BluePipeline can provide their own set of permissions in addition to the ones defined here.

Queue API

Fetch queue for an pipeline

 curl http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/queue
 [ {
   "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
   "expectedBuildNumber" : 4,
   "id" : "4",
   "pipeline" : "pipeline1",
   "queuedTime" : 1465433910205
 }, {
   "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
   "expectedBuildNumber" : 3,
   "id" : "3",
   "pipeline" : "pipeline1",
   "queuedTime" : 1465433910203
 } ]

GET queue for a MultiBranch pipeline

curl http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/bo2/queue/

[
   {
      "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
      "id" : "64",
      "expectedBuildNumber" : 10,
      "pipeline" : "bug%2FUX-334",
      "_links" : {
         "self" : {
            "_class" : "io.jenkins.blueocean.rest.hal.Link",
            "href" : "/blue/rest/organizations/jenkins/pipelines/bo2/queue/64/"
         }
      },
      "queuedTime" : "2016-06-29T14:11:52.191-0700"
   },
   {
      "id" : "63",
      "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
      "queuedTime" : "2016-06-29T14:11:51.290-0700",
      "pipeline" : "bug%2FUX-334",
      "_links" : {
         "self" : {
            "_class" : "io.jenkins.blueocean.rest.hal.Link",
            "href" : "/blue/rest/organizations/jenkins/pipelines/bo2/queue/63/"
         }
      },
      "expectedBuildNumber" : 11
   }
]

Remove a queued item

curl -X DELETE http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/bo2/queue/64/

Run API

Get all runs in a pipeline

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs

[
    {
        "changeSet": [],
        "artifacts": [
          {
              "name": "fizz",
              "size": 8,
              "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
          }
        ],
        "durationInMillis": 841,
        "estimatedDurationInMillis" : 567,
        "enQueueTime": "2016-03-16T09:02:26.492-0700",
        "endTime": "2016-03-16T09:02:27.339-0700",
        "id": "1",
        "organization": "jenkins",
        "pipeline": "pipeline1",
        "result": "SUCCESS",
        "runSummary": "stable",
        "startTime": "2016-03-16T09:02:26.498-0700",
        "state": "FINISHED",
        "type": "WorkflowRun",
        "commitId": null
    }
]

Get a run details

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1

{
    "changeSet": [],
    "artifacts": [
      {
          "name": "fizz",
          "size": 8,
          "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
      }
    ],
    "durationInMillis": 841,
    "estimatedDurationInMillis" : 567,
    "enQueueTime": "2016-03-16T09:02:26.492-0700",
    "endTime": "2016-03-16T09:02:27.339-0700",
    "id": "1",
    "organization": "jenkins",
    "pipeline": "pipeline1",
    "result": "SUCCESS",
    "runSummary": "stable",
    "startTime": "2016-03-16T09:02:26.498-0700",
    "state": "FINISHED",
    "type": "WorkflowRun",
    "commitId": null
}

Find latest run of a pipeline

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/?q=type:run;organization:jenkins;pipeline:pipeline1;latestOnly:true

[
  {
      "changeSet": [],
      "artifacts": [
        {
            "name": "fizz",
            "size": 8,
            "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
        }
      ],
      "durationInMillis": 841,
      "estimatedDurationInMillis" : 567,
      "enQueueTime": "2016-03-16T09:02:26.492-0700",
      "endTime": "2016-03-16T09:02:27.339-0700",
      "id": "1",
      "organization": "jenkins",
      "pipeline": "pipeline1",
      "result": "SUCCESS",
      "runSummary": "stable",
      "startTime": "2016-03-16T09:02:26.498-0700",
      "state": "FINISHED",
      "type": "WorkflowRun",
      "commitId": null
  }
]

Find latest run on all pipelines

curl -v -X GET  http://localhost:8080/jenkins/blue/rest/?q=type:run;organization:jenkins;latestOnly:true

[
  {
      "changeSet": [],
      "artifacts": [
        {
            "name": "fizz",
            "size": 8,
            "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
        }
      ],
      "durationInMillis": 841,
      "estimatedDurationInMillis" : 567,
      "enQueueTime": "2016-03-16T09:02:26.492-0700",
      "endTime": "2016-03-16T09:02:27.339-0700",
      "id": "1",
      "organization": "jenkins",
      "pipeline": "pipeline1",
      "result": "SUCCESS",
      "runSummary": "stable",
      "startTime": "2016-03-16T09:02:26.498-0700",
      "state": "FINISHED",
      "type": "WorkflowRun",
      "commitId": null
  }
]

Start a build

curl -XPOST http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline3/runs/
{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline3/queue/3/"
    }
  },
  "expectedBuildNumber" : 1,
  "id" : "3",
  "pipeline" : "pipeline3",
  "qeueudTime" : "2016-06-22T11:05:41.309+1200"
}

Start a parameterized build

Parameterized build can be triggered on a free-style, pipeline and a branch of multi-branch pipeline jobs.

curl -XPOST -H 'Content-Type: application/json' http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/
{
  "parameters" : [{
    "name" : "param1",
    "value" : "def"
  }]
}

Response:

{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
  "_links" : {
    "parent" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/queue/3/"
    }
  },
  "expectedBuildNumber" : 2,
  "id" : "3",
  "organization" : "jenkins",
  "pipeline" : "pipeline1",
  "queuedTime" : "2016-12-22T15:43:52.866+0530"
}

Stop a build

Note: it takes a while to stop, so you may get a state of RUNNING or QUEUED.

curl -X PUT http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/stop
{
       "changeSet": [],
       "artifacts": [
         {
             "name": "fizz",
             "size": 8,
             "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
         }
       ],
       "durationInMillis": 841,
       "estimatedDurationInMillis" : 567,
       "enQueueTime": "2016-03-16T09:02:26.492-0700",
       "endTime": "2016-03-16T09:02:27.339-0700",
       "id": "1",
       "organization": "jenkins",
       "pipeline": "pipeline1",
       "result": "ABORTED",
       "runSummary": "stable",
       "startTime": "2016-03-16T09:02:26.498-0700",
       "state": "FINISHED",
       "type": "WorkflowRun",
       "commitId": null
   }

Stop a build as blocking call

You can pass blocking=true (default false) with optional timeOutInSecs parameter (Default 10 sec). This API tries to stop running job and between each retries does a sleep for 10% of timeOutInSecs value.

Client should check the state and if its not FINISHED they may issue another stop API call to ensure the build is stopped.

Note: There is no guarantee, after timeout build build might still be running.

curl -X PUT http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/stop/?blocking=true&timeOutInSecs=5

{
       "changeSet": [],
       "artifacts": [
         {
             "name": "fizz",
             "size": 8,
             "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
         }
       ],
       "durationInMillis": 841,
       "estimatedDurationInMillis" : 567,
       "enQueueTime": "2016-03-16T09:02:26.492-0700",
       "endTime": "2016-03-16T09:02:27.339-0700",
       "id": "1",
       "organization": "jenkins",
       "pipeline": "pipeline1",
       "result": "ABORTED",
       "runSummary": "stable",
       "startTime": "2016-03-16T09:02:26.498-0700",
       "state": "FINISHED",
       "type": "WorkflowRun",
       "commitId": null
   }

Get MultiBranch job's branch run detail

curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/branches/feature1/runs/1

{
    "durationInMillis": 1330,
    "estimatedDurationInMillis" : 567,
    "enQueueTime": "2016-03-16T09:08:15.607-0700",
    "endTime": "2016-03-16T09:08:16.942-0700",
    "id": "1",
    "organization": "jenkins",
    "pipeline": "feature1",
    "result": "SUCCESS",
    "runSummary": "stable",
    "startTime": "2016-03-16T09:08:15.612-0700",
    "state": "FINISHED",
    "type": "WorkflowRun",
    "commitId": "aad1c51fb29e053d1ccb20dbcdb1fe28fddcfba5",
    "changeSet": []
}

Get all runs for all branches on a multibranch pipeline (ordered by date)

 curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs

[
    {
        "changeSet": [

        ],
        "artifacts": [
          {
              "name": "fizz",
              "size": 8,
              "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
          }
        ],
        "durationInMillis": 1875,
        "estimatedDurationInMillis" : 567,
        "enQueueTime": "2016-03-10T15:27:13.687+1300",
        "endTime": "2016-03-10T15:27:15.567+1300",
        "id": "1",
        "organization": "jenkins",
        "pipeline": "feature1",
        "result": "SUCCESS",
        "runSummary": "stable",
        "startTime": "2016-03-10T15:27:13.692+1300",
        "state": "FINISHED",
        "type": "WorkflowRun",
        "commitId": "52615df5828f1dddf672b86d64196294e3fbee88"
    },
    {
        "changeSet": [

        ],
        "durationInMillis": 1716,
        "estimatedDurationInMillis" : 567,
        "enQueueTime": "2016-03-10T15:27:13.692+1300",
        "endTime": "2016-03-10T15:27:15.409+1300",
        "id": "1",
        "organization": "jenkins",
        "pipeline": "master",
        "result": "SUCCESS",
        "runSummary": "stable",
        "startTime": "2016-03-10T15:27:13.693+1300",
        "state": "FINISHED",
        "type": "WorkflowRun",
        "commitId": "bfd1f72dc63ca63a8c1b152dc9263c7c81862afa"
    },
    {
        "changeSet": [

        ],
        "durationInMillis": 1714,
        "estimatedDurationInMillis" : 567,
        "enQueueTime": "2016-03-10T15:27:13.700+1300",
        "endTime": "2016-03-10T15:27:15.415+1300",
        "id": "1",
        "organization": "jenkins",
        "pipeline": "feature2",
        "result": "SUCCESS",
        "runSummary": "stable",
        "startTime": "2016-03-10T15:27:13.701+1300",
        "state": "FINISHED",
        "type": "WorkflowRun",
        "commitId": "84cb56b50589e720385ef2491a1ebab9d227da6e"
    }
]

Get latest activity of Multi-branch pipeline for all branches

 curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/activities/

    [
        {
            "changeSet": [

            ],
            "artifacts": [
              {
                  "name": "fizz",
                  "size": 8,
                  "url": "/jenkins/job/pipeline1/1/artifact/dir/fizz"
              }
            ],
            "durationInMillis": 1875,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-03-10T15:27:13.687+1300",
            "endTime": "2016-03-10T15:27:15.567+1300",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "feature1",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-03-10T15:27:13.692+1300",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "52615df5828f1dddf672b86d64196294e3fbee88"
        },
        {
            "changeSet": [

            ],
            "durationInMillis": 1716,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-03-10T15:27:13.692+1300",
            "endTime": "2016-03-10T15:27:15.409+1300",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "master",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-03-10T15:27:13.693+1300",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "bfd1f72dc63ca63a8c1b152dc9263c7c81862afa"
        },
        {
            "changeSet": [

            ],
            "durationInMillis": 1714,
            "estimatedDurationInMillis" : 567,
            "enQueueTime": "2016-03-10T15:27:13.700+1300",
            "endTime": "2016-03-10T15:27:15.415+1300",
            "id": "1",
            "organization": "jenkins",
            "pipeline": "feature2",
            "result": "SUCCESS",
            "runSummary": "stable",
            "startTime": "2016-03-10T15:27:13.701+1300",
            "state": "FINISHED",
            "type": "WorkflowRun",
            "commitId": "84cb56b50589e720385ef2491a1ebab9d227da6e"
        }
    ]

This API collects runs (in descending order) for each branch in a multi-branch project( branches sorted in descending order of branch with latest activity). It fetches max up to 250 runs for each branch by default, it can be changed using JVM property MAX_MBP_RUNS_ROWS.

Get change set for a run

curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/branches/master/runs/2/

{
    "changeSet": [
        {
            "author": {
                "email": "vivek.pandey@gmail.com",
                "fullName": "vivek.pandey",
                "id": "vivek.pandey"
            },
            "affectedPaths": [
                "file"
            ],
            "commitId": "e2d1d695a2009ac44d97e6e7a542ba3786153c41",
            "comment": "tweaked11\n",
            "date": "2016-03-02 16:49:26 -0800",
            "id": "e2d1d695a2009ac44d97e6e7a542ba3786153c41",
            "msg": "tweaked11",
            "paths": [
                {
                    "editType": "edit",
                    "file": "file"
                }
            ],
            "timestamp": "2016-03-02T16:49:26.000-0800"
        }
    ],
    "durationInMillis": 348,
    "estimatedDurationInMillis" : 567,
    "enQueueTime": "2016-03-02T16:49:26.548-0800",
    "endTime": "2016-03-02T16:49:26.898-0800",
    "id": "2",
    "organization": "jenkins",
    "pipeline": "master",
    "runSummary": "stable",
    "startTime": "2016-03-02T16:49:26.550-0800",
    "status": "SUCCESS",
    "type": "WorkflowRun"
}

Pipeline Node API

Get Pipeline run nodes

curl -v  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/

[ {
  "displayName" : "build",
  "durationInMillis" : 219,
  "edges" : [ {
    "id" : "9"
  } ],
  "id" : "3",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:08.719-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "test",
  "durationInMillis" : 158,
  "edges" : [ {
    "id" : "13"
  }, {
    "id" : "14"
  }, {
    "id" : "15"
  } ],
  "id" : "9",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:08.938-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "unit",
  "durationInMillis" : 127,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "13",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:08.942-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "integration",
  "durationInMillis" : 126,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "14",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:08.944-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "ui",
  "durationInMillis" : 137,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "15",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:08.945-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "deploy",
  "durationInMillis" : 47,
  "edges" : [ ],
  "id" : "35",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:15:09.096-0700",
  "state" : "FINISHED"
} ]

In case pipeline run fails in one of the parallel branch, enclosing stage node will appear failed as well.

In case if the pipeline is in progress or failed in the middle, the response may include future nodes if there was last successful pipeline build. The returned future nodes will have startTime, result and state as null. Also the last node's edges will be patched to point to the future node.

From the above example, if build failed at parallel node unit then the response will be:

[ {
  "displayName" : "build",
  "durationInMillis" : 51,
  "edges" : [ {
    "id" : "9"
  } ],
  "id" : "3",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:39:18.569-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "test",
  "durationInMillis" : 344,
  "edges" : [ {
    "id" : "13"
  }, {
    "id" : "14"
  }, {
    "id" : "15"
  } ],
  "id" : "9",
  "result" : "FAILURE",
  "startTime" : "2016-05-06T15:39:18.620-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "unit",
  "durationInMillis" : 329,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "13",
  "result" : "FAILURE",
  "startTime" : "2016-05-06T15:39:18.622-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "integration",
  "durationInMillis" : 97,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "14",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:39:18.623-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "ui",
  "durationInMillis" : 107,
  "edges" : [ {
    "id" : "35"
  } ],
  "id" : "15",
  "result" : "SUCCESS",
  "startTime" : "2016-05-06T15:39:18.623-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "deploy",
  "durationInMillis" : null,
  "edges" : [ {
    "id" : "41"
  } ],
  "id" : "35",
  "result" : null,
  "startTime" : null,
  "state" : null
}, {
  "displayName" : "deployToProd",
  "durationInMillis" : null,
  "edges" : [ ],
  "id" : "41",
  "result" : null,
  "startTime" : null,
  "state" : null
} ]

Get a Pipeline run node's detail

curl -v  http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/3

{
    "displayName": "build",
    "edges": [
        {
            "id": "9"
        }
    ],
    "id": "3",
    "startTime": "2016-03-11T00:32:52.273-0800",
    "status": "SUCCESS",
    "state": "FINISHED"
}

Pipeline Steps API

This API gives steps inside a pipeline node. For a Stage, the steps will include all the steps defined inside Parallels as well as the stage.

Get steps for a Pipeline node

Given this pipeline script:

stage 'build'
node{
  echo "Building..."
}

stage 'test'
parallel 'unit':{
  node{
    echo "Unit testing..."
  }
},'integration':{
  node{
    echo "Integration testing..."
  }
}, 'ui':{
  node{
    echo "UI testing..."
  }
}

stage 'deploy'
node{
  echo "Deploying"
}

stage 'deployToProd'
node{
  echo "Deploying to production"
}

Get steps of 'test' stage node:

GET http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/9/steps/

[ {
  "displayName" : "Print Message",
  "durationInMillis" : 1,
  "id" : "21",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.230-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "Shell Script",
  "durationInMillis" : 2,
  "id" : "22",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.231-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "Print Message",
  "durationInMillis" : 1,
  "id" : "23",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.233-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "Print Message",
  "durationInMillis" : 1,
  "id" : "28",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.266-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "Shell Script",
  "durationInMillis" : 272,
  "id" : "32",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.474-0700",
  "state" : "FINISHED"
}, {
  "displayName" : "Print Message",
  "durationInMillis" : 2,
  "id" : "39",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.784-0700",
  "state" : "FINISHED"
} ]

Get a Pipeline step details

GET http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/13/steps/21/
{
  "displayName" : "Print Message",
  "durationInMillis" : 1,
  "id" : "21",
  "result" : "SUCCESS",
  "startTime" : "2016-05-13T09:37:01.230-0700",
  "state" : "FINISHED"
}

Get Pipeline Steps

Gives all steps in a pipeline. Excludes stages and parallels/blocks.

curl http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/

[ {
  "_class" : "io.jenkins.blueocean.rest.model.GenericResource",
  "displayName" : "Shell Script",
  "durationInMillis" : 70,
  "id" : "5",
  "result" : "SUCCESS",
  "startTime" : "2016-06-18T13:28:29.443+0900"
}, {
  "_class" : "io.jenkins.blueocean.rest.model.GenericResource",
  "displayName" : "Print Message",
  "durationInMillis" : 1,
  "id" : "10",
  "result" : "SUCCESS",
  "startTime" : "2016-06-18T13:28:29.545+0900"
}, {
  "_class" : "io.jenkins.blueocean.rest.model.GenericResource",
  "displayName" : "Shell Script",
  "durationInMillis" : 265,
  "id" : "11",
  "result" : "SUCCESS",
  "startTime" : "2016-06-18T13:28:29.546+0900"
}, {
  "_class" : "io.jenkins.blueocean.rest.model.GenericResource",
  "displayName" : "Shell Script",
  "durationInMillis" : 279,
  "id" : "12",
  "result" : "SUCCESS",
  "startTime" : "2016-06-18T13:28:29.811+0900"
} ]

Get Pipeline Steps with Input

curl -v -X GET http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/p31/runs/22/nodes/9/steps/

[ {
  "_class" : "io.jenkins.blueocean.rest.impl.pipeline.PipelineStepImpl",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/"
    },
    "actions" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/actions/"
    }
  },
  "actions" : [...],
  "displayName" : "Wait for interactive input",
  "durationInMillis" : 81,
  "id" : "12",
  "input" : {
    "_class" : "io.jenkins.blueocean.rest.impl.pipeline.InputStepImpl",
    "_links" : {
      "self" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/input/"
      }
    },
    "id" : "C51b52435b43a326d5d4f92c290a64d5",
    "message" : "Please input branch to test against",
    "ok" : "Proceed",
    "parameters" : [ {
      "_class" : "hudson.model.StringParameterDefinition",
      "defaultParameterValue" : {
        "_class" : "hudson.model.StringParameterValue",
        "name" : "branch",
        "value" : "master"
      },
      "description" : "",
      "name" : "branch",
      "type" : "StringParameterDefinition"
    } ],
    "submitter" : null
  },
  "result" : "UNKNOWN",
  "startTime" : "2016-12-21T17:41:58.488+0530",
  "state" : "PAUSED"
} ]

Submit step input to proceed

curl -v -u 'xxx:yyy'  -H 'Content-Type: application/json' -X POST http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/p31/runs/22/nodes/9/steps/12/ -d
'{
   "id" : "C51b52435b43a326d5d4f92c290a64d5",
   "parameters" : [{
     "name" : "branch",
     "value" : "master"
   }]
 }'

Above, "id" is the input.id received in GET /steps/ call:

 curl -v -X GET http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/p31/runs/22/nodes/9/steps/
 [ {
       "_class" : "io.jenkins.blueocean.rest.impl.pipeline.PipelineStepImpl",
       "_links" : {
         "self" : {
           "_class" : "io.jenkins.blueocean.rest.hal.Link",
           "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/"
         },
         "actions" : {
           "_class" : "io.jenkins.blueocean.rest.hal.Link",
           "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/actions/"
         }
       },
       "actions" : [...],
       "displayName" : "Wait for interactive input",
       "durationInMillis" : 81,
       "id" : "12",
       "input" : {
         "_class" : "io.jenkins.blueocean.rest.impl.pipeline.InputStepImpl",
         "_links" : {
           "self" : {
             "_class" : "io.jenkins.blueocean.rest.hal.Link",
             "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/12/input/"
           }
         },
         "id" : "C51b52435b43a326d5d4f92c290a64d5",
         "message" : "Please input branch to test against",
         "ok" : "Proceed",
         "parameters" : [ {
           "_class" : "hudson.model.StringParameterDefinition",
           "defaultParameterValue" : {
             "_class" : "hudson.model.StringParameterValue",
             "name" : "branch",
             "value" : "master"
           },
           "description" : "",
           "name" : "branch",
           "type" : "StringParameterDefinition"
         } ],
         "submitter" : null
       },
       "result" : "UNKNOWN",
       "startTime" : "2016-12-21T17:41:58.488+0530",
       "state" : "PAUSED"
     } ]

Here input.id is 'C51b52435b43a326d5d4f92c290a64d5' and this must be sent as 'id' element in POST call to submit input action.

Submit step input to abort

curl -v -u 'xxx:yyy'  -H 'Content-Type: application/json' -X POST http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/p31/runs/22/nodes/9/steps/12/ -d
'{
   "id" : "C51b52435b43a326d5d4f92c290a64d5",
   "abort" : true
 }'

Replay a pipeline build

This will queue up a replay of the pipeline run with the same commit id as the run used

curl -XPOST http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline3/runs/1/replay
{
  "_class" : "io.jenkins.blueocean.service.embedded.rest.QueueItemImpl",
  "id" : "64",
  "expectedBuildNumber" : 10,
  "pipeline" : "bug%2FUX-334",
  "_links" : {
     "self" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/bo2/queue/64/"
     }
  },
  "queuedTime" : "2016-06-29T14:11:52.191-0700"

}

Favorite API

Favorite API can be used to favorite a pipeline (Multi-branch, branch, pipeline or even folder) for a logged in user. If favorite request is successful then the response is favorited item.

curl -u alice:xxx -H"Content-Type:application/json" -XPUT -d '{"favorite":true} ttp://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/favorite

{
    "_class" : "io.jenkins.blueocean.service.embedded.rest.FavoriteImpl",
    "_links" : {
              "self" : {
                 "_class" : "io.jenkins.blueocean.rest.hal.Link",
                 "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/favorite/"
              }
           },
   "item" : {
      "displayName" : "pipeline1",
      "_links" : {
         "runs" : {
            "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/",
            "_class" : "io.jenkins.blueocean.rest.hal.Link"
         },
         "self" : {
            "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/",
            "_class" : "io.jenkins.blueocean.rest.hal.Link"
         },
         "queue" : {
            "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/queue/",
            "_class" : "io.jenkins.blueocean.rest.hal.Link"
         },
         "actions" : {
            "_class" : "io.jenkins.blueocean.rest.hal.Link",
            "href" : "/blue/rest/organizations/jenkins/pipelines/pipeline1/actions/"
         }
      },
      "organization" : "jenkins",
      "latestRun" : null,
      "name" : "pipeline1",
      "actions" : [],
      "weatherScore" : 100,
      "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineImpl",
      "fullName" : "pipeline1",
      "estimatedDurationInMillis" : -1
   }
}

Favorite a pipeline

Returns 200 on success. Must be authenticated.

curl -u bob:bob -H"Content-Type:application/json" -XPUT -d '{"favorite":true} ttp://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/favorite/

Favorite a multi branch pipeline

Must be authenticated.

Favorited multi-branch pipeline returns master branch as favorited item. Returns 200 on success. 400 if master does not exist

curl -u bob:bob  -H"Content-Type:application/json" -XPUT -d '{"favorite":true} http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/favorite/

Un-favorite a multi branch pipeline

Must be authenticated.

This un-favorites the master branch. Returns 200 on success. 400 if master does not exist

curl -u bob:bob  -H"Content-Type:application/json" -XPUT -d '{"favorite":false} http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/favorite/

Favorite a multi branch pipeline branch

Returns 200 on success. Must be authenticated.

curl -H"Content-Type:application/json" -XPUT -d '{"favorite":true} http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/branches/master/favorite/

Un-favorite a multi branch pipeline branch

Returns 200 on success. Must be authenticated.

curl -H"Content-Type:application/json" -XPUT -d '{"favorite":false} http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/branches/master/favorite/

Fetch user favorites

Must be authenticated.

curl -u bob:bob  http://localhost:8080/jenkins/blue/rest/users/bob/favorites/

[ {
  "_class" : "io.jenkins.blueocean.service.embedded.rest.FavoriteImpl",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/blue/rest/users/alice/favorites/p%2Fmaster/"
    }
  },
  "item" : {
    "_class" : "io.jenkins.blueocean.service.embedded.rest.BranchImpl",
    "_links" : {
      "self" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/"
      },
      "actions" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/actions/"
      },
      "runs" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/"
      },
      "queue" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/queue/"
      }
    },
    "actions" : [ ],
    "displayName" : "master",
    "estimatedDurationInMillis" : 953,
    "fullName" : "p/master",
    "latestRun" : {
      "_class" : "io.jenkins.blueocean.service.embedded.rest.PipelineRunImpl",
      "_links" : {
        "nodes" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/1/nodes/"
        },
        "log" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/1/log/"
        },
        "self" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/1/"
        },
        "actions" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/1/actions/"
        },
        "steps" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/blue/rest/organizations/jenkins/pipelines/p/branches/master/runs/1/steps/"
        }
      },
      "actions" : [ ],
      "artifacts" : [ ],
      "changeSet" : [ ],
      "durationInMillis" : 953,
      "enQueueTime" : "2016-07-08T13:27:15.250-0700",
      "endTime" : "2016-07-08T13:27:16.204-0700",
      "estimatedDurationInMillis" : 953,
      "id" : "1",
      "organization" : "jenkins",
      "pipeline" : "master",
      "result" : "SUCCESS",
      "runSummary" : "stable",
      "startTime" : "2016-07-08T13:27:15.251-0700",
      "state" : "FINISHED",
      "type" : "WorkflowRun",
      "commitId" : "0cd84cc9a1a62fbe636e5d1197ef7a5cc4c56b63"
    },
    "name" : "master",
    "organization" : "jenkins",
    "weatherScore" : 100,
    "pullRequest" : null
  }
} ]

Log API

Fetching logs

Clients should look for HTTP header X-TEXT-SIZE and X-More-Data in the response.

By default only last 150 KB log data is returned in the response. You can fetch full log by sending start=0 query parameter. You can override default log size from 150KB to other values using thresholdInKB query parameter.

  • X-More-Data Header

If X-More-Data is true, then client should repeat the request after some delay. In the repeated request it should use X-TEXT-SIZE header value with start query parameter.

  • X-TEXT-SIZE Header

X-TEXT-SIZE is the byte offset of the raw log file client should use in the next request as value of start query parameter.

  • start Query Parameter

start query parameter tells API to send log starting from this offset in the log file.

  • thresholdInKB Query Parameter

Size of log to return in the response. Default value is 150 KB of log data.

Download a log for a Pipeline run

This will show up as a download in the browser.

curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/log?start=0&download=true

Get log for a Pipeline run

curl -v http://localhost:56748/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/log?start=0

Content-Type: text/plain; charset=utf-8
X-Text-Size: 1835
X-More-Data: false

Started
[Pipeline] Allocate node : Start
Running on master in /var/folders/5q/51y3qf0x5t39d4c4c_c2l1s40000gn/T/hudson6188345779815397724test/workspace/pipeline1
[Pipeline] node {
[Pipeline] stage (Build1)
Entering stage Build1
Proceeding
[Pipeline] echo
Building
[Pipeline] stage (Test1)
Entering stage Test1
Proceeding
[Pipeline] echo
Testing
[Pipeline] } //node
[Pipeline] Allocate node : End
[Pipeline] End of Pipeline
Finished: SUCCESS

Note: Fetching log on a Multi-Branch project will give 404 as a Multi-Branch project doesn't have run of it's own, it's essentially a folder hence no logs.

Get log for a Pipeline step

GET http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/13/steps/21/log/

Unit testing...

SCM API

Validate Github personal access token

This API does the following:

  • Calls SCM provider API, for example GitHub API, to validate the token as well as look for appropriate scopes (in case of GitHub its repo and user:email). It picks up SCM provider from URL path (../scm/:id/validate)
  • If the token is valid
    • Look for domain 'github-domain' with github api url specifications in authenticated user's credential store. If its not found then a new one is created.
    • If the token is valid and there is no Jenkins credentials found with id 'github' in authenticated user scoped domain 'github-domain' then this new credential is created.
    • If there exists a Jenkins credentials with authenticated user scope, in user scope domain named 'github-domain' and credentialId == scm id 'github', then this credential is updated with the given token. SCM id is picked from URL path (../scm/:id/validate).
    • HTTP response with credentialId and status 200 is returned
  • If the token is not valid for any reason then 403 error is returned with cause of validation failure.

eg:

curl -v -u admin:admin -d '{"accessToken": boo"}' -H "Content-Type:application/json" -XPUT http://localhost:8080/jenkins/blue/rest/organizations/jenkins/scm/github/validate

Response:

{
  "credentialId" : "github"
}

If invalid/forbidden/unauthorized 403 error is returned. For bad request 400.

Check SCM for available credentialId to use:

curl -v -u xxx:yyy http://localhost:8080/jenkins/blue/rest/organizations/jenkins/scm/github/

{
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubScm",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/"
    }
  },
  "credentialId" : ".....",
  "id" : "github",
  "uri" : "https://api.github.com"
}

List organizations of SCM (e.g. github)

As prerequisite GitHub personal access token must be set as Credential with id 'github' in 'github-domain' domain of authenticated user's credential store. Calling validate access token API above automatically sets it up for you. You can also do it manually.

Credential id corresponding to github personal access token must be sent either as query parameter 'credentialId' or as HTTP header X-CREDENTIAL-ID. If both are provided query parameter takes precedence.

curl -XGET -u xxx:yyy http://localhost:8080/jenkins/blue/rest/organizations/jenkins/scm/github/organizations/?credentialId=github

[ {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/jenkinsci/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/jenkinsci/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "jenkinsci"
}, {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "CloudBees-community"
}, {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/cloudbees/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/cloudbees/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "cloudbees"
}, {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubUserOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/vivek/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/vivek/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "vivek"
}, {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/stapler/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/stapler/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "stapler"
}, {
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganization",
  "_links" : {
    "repositories" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/jruby/repositories/"
    },
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/jruby/"
    }
  },
  "jenkinsOrganizationPipeline" : false,
  "name" : "jruby"
} ]

Repositories API

Credential id corresponding to github personal access token must be sent either as query parameter 'credentialId' or as HTTP header X-CREDENTIAL-ID. If both are provided query parameter takes precedence.

Get SCM repositories in an organization

curl -v -u xxx:yyy http://localhost:8080/jenkins/blue/rest/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/?credentialId=github&pageSize=10&pageNumber=3

{
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubRepositoryContainer",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/"
    }
  },
  "repositories" : {
    "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubRepositories",
    "_links" : {
      "self" : {
        "_class" : "io.jenkins.blueocean.rest.hal.Link",
        "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/"
      }
    },
    "items" : [ {
      "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubRepository",
      "_links" : {
        "self" : {
          "_class" : "io.jenkins.blueocean.rest.hal.Link",
          "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/bees-cli-router-plugin/"
        }
      },
      "defaultBranch" : "master",
      "description" : "CloudBees SDK \"router:*\" plugin",
      "name" : "bees-cli-router-plugin",
      "permissions" : {
        "admin" : false,
        "push" : false,
        "pull" : true
      },
      "private": true,
      "fullName": "CloudBees-community/bees-cli-router-plugin"
    },
    ...],
    "lastPage" : 5,
    "nextPage" : 4,
    "pageSize" : 10
  }
}

Pagination for GitHub repositories

Repositories response includes nextPage, lastPage and pageSize. nextPage or lastPage might be null if there is no more pages available.

use pageSize and pageNumber query parameter to get number of items in a page and which page number is needed. Default value of pageNumber is 1 and default and max size is 100.

Get SCM repository in an organization

curl -v -u xxx:yyy http://localhost:8080/jenkins/blue/rest/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/game-of-life/?credentialId=github

{
  "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubRepository",
  "_links" : {
    "self" : {
      "_class" : "io.jenkins.blueocean.rest.hal.Link",
      "href" : "/organizations/jenkins/scm/github/organizations/CloudBees-community/repositories/game-of-life/?credentialId=github"
    }
  },
  "defaultBranch" : "master",
  "description" : "Demo application for the 'Jenkins: The Definitive Guide' book",
  "name" : "game-of-life",
  "permissions" : {
    "admin" : false,
    "push" : false,
    "pull" : true
  },
  "private" : false,
  "fullName" : "CloudBees-community/game-of-life"
}

Get Github file content of a pipeline (Multibranch or OrganizationFolder)

Parameters:

  • path

Required. path to file from repo root. e.g. Jenkinsfile

  • repo

Optional if request is in context of MBP pipeline, required if made in context of organization folder

  • branch

Optional in case request is made in context of MBP pipeline branch. If missing default branch is assumed if scm supports default branch. Required in all other cases.

  • type

Optional. Defaults to file.

Get github file content from MBP branch

curl -v -u xxx:yyy "http://127.0.0.1:8080/jenkins/blue/rest/organizations/jenkins/pipelines/vivek1/pipelines/test-no-jenkins-file/branches/master/scm/content/?path=Jenkinsfile"

Get github file content from MBP folder

curl -v -u xxx:yyy "http://127.0.0.1:8080/jenkins/blue/rest/organizations/jenkins/pipelines/vivek1/pipelines/test-no-jenkins-file/scm/content/?path=Jenkinsfile&branch=test1"

Get github file content from org folder

curl -v -u xxx:yyy "http://127.0.0.1:8080/jenkins/blue/rest/organizations/jenkins/pipelines/vivek1/scm/content/?path=Jenkinsfile&repo=test-no-jenkins-file&branch=test1"

Response:

{
   "content" : {
      "name" : "Jenkinsfile",
      "sha" : "f13b26341cf403aa7d697bc252908de092ee279d",
      "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubContent",
      "repo" : "test-no-jenkins-file",
      "size" : 7,
      "owner" : "vivek",
      "path" : "Jenkinsfile",
      "base64Data": "VGVzdDEyMw=="
   },
   "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubFile"
}

Save file content to SCM repo

Save file to an OrganizationFolder

SCM owner and credentials are computed from the OrganizationFolder. Request must include repo element.

curl -H 'Content-Type: application/json' -u user:password -XPUT http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/vivek/scm/content/ -d

'{
  "content" : {
    "message" : "first commit",
    "path" : "Jenkinsfile",
    "branch" : "test1",
    "repo" : "test-no-jenkins-file",
    "sha" : "9e82c4011cd70446a2f44881a6c288c59b4abac0",
    "base64Data" : "VGVzdDEyMw=="
  }
}'

Save file to a MultiBranchProject

SCM owner, repo and credentials are computed from the MultiBranchProject.

curl -H 'Content-Type: application/json' -u user:password -XPUT http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/vivek/pipelines/test-no-jenkins-file/scm/content/ -d

'{
  "content" : {
    "message" : "first commit",
    "path" : "Jenkinsfile",
    "branch" : "test1",
    "sha" : "9e82c4011cd70446a2f44881a6c288c59b4abac0",
    "base64Data" : "VGVzdDEyMw=="
  }
}'
  • If file path doesn't exist in SCM then a new file will be created
  • If sha is provided and file path exists then it must match with the sha of existing file, else 400 (Bad Request) error will be returned.
  • If sha matches then the file will be updated with the content provided in the request
  • If branch element is not provided file will be saved on default branch (typically maser)
  • If branch element is present and this branch doesn't exist then a new branch will be created off default branch HEAD

Response

{
   "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubFile",
   "content" : {
      "_class" : "io.jenkins.blueocean.blueocean_github_pipeline.GithubContent",
      "sha" : "f13b26341cf403aa7d697bc252908de092ee279d",
      "path" : "Jenkinsfile4",
      "owner" : "vivek",
      "repo" : "test-no-jenkins-file",
      "name" : "Jenkinsfile4"
   }
}
You can’t perform that action at this time.