Where can I find jenkins restful api reference?

117,956

Solution 1

Jenkins has a link to their REST API in the bottom right of each page. This link appears on every page of Jenkins and points you to an API output for the exact page you are browsing. That should provide some understanding into how to build the API URls.

You can additionally use some wrapper, like I do, in Python, using http://jenkinsapi.readthedocs.io/en/latest/

Here is their website: https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API

Solution 2

Additional Solution: use Restul api wrapper libraries written in Java / python / Ruby - An object oriented wrappers which aim to provide a more conventionally way of controlling a Jenkins server.

For documentation and links: Remote Access API

Share:
117,956
Chuck
Author by

Chuck

email: [email protected]

Updated on July 08, 2022

Comments

  • Chuck
    Chuck almost 2 years

    I am trying to integrate an external system with jenkins by REST API.

    Although I have done lots of google search on its API reference, I still cannot get a full list of jenkins REST API reference.

    Anybody knows about this?

  • Lovato
    Lovato over 6 years
    The URLs you can copy are mainly read only, since they were used to generate data for HTML display. But if you follow the documentation on their website, the first example is how to trigger a build.
  • user1241663
    user1241663 almost 6 years
    There is a Java/Groovy library at github.com/cdancy/jenkins-rest
  • Siddharth Kumar
    Siddharth Kumar almost 6 years
    Node.js APIs also available, Python APIs taken as reference. npmjs.com/package/jenkins