How to update job config files using the Python API?

Issue

I would like to be able to update job config files remotely using the Jenkins Python API.

Environment

  • CloudBees Jenkins Enterprise
  • Remote Access API
  • JenkinsAPI

Resolution

Here is an example that replaces occurrences of oldvalue with newvalue in job test.

#!/usr/bin/python

from jenkinsapi.jenkins import Jenkins

if __name__ == '__main__':
        jenkins = 'http://localhost:8080/'
        server = Jenkins(jenkins, username = 'admin', password = 'admin')
        job = server.get_job('test')
        config=job.get_config()
        new = config.replace('oldvalue', 'newvalue')
        job.update_config(new)

Obviously, replace:

  • username = 'admin', password = 'admin' with your username and password
  • http://localhost:8080/ with your Jenkins URL
  • test with your job name

See Remote Access API and JenkinsAPI for more.

Was this article helpful?
0 out of 0 found this helpful

Have more questions?

2 Comments

Date Votes
  • 1
    Avatar
    Joyce Chidiadi

    Hi,

    Thanks for the explanation for updating job config files. I've tried this method but it doesn't work for me. Can you please let me know if this method currently works for you.

     

    Thank you.

  • 0
    Avatar
    Mihir Mehta

    I have also tried that method, doesn't work, also unable to create_job as well, keep failing.I also tried creating a requests still getting 403 errors:
    here is the code below I have tried, but keep failing:

    ```

    import requests
    auth = (user, pswd)
    #print(auth)
    crumb_data= requests.get("{0}/crumbIssuer/api/json".format(url),auth=auth,headers={'content-type': 'application/json'}, verify=False)
    sessionID = crumb_data.headers['X-Jenkins-Session']
    print(sessionID)
    print("HAL CRUMB: {}".format(crumb_data.json()['crumb']))
    job_url = "{}/{}".format(url,url_job)

    headers = {
    'Connection': 'keep-alive',
    'Cache-Control': 'no-cache',
    'Content-Type': 'application/json',
    'Content-Encoding': 'gzip',
    'Jenkins-Crumb': crumb_data.json()['crumb'],
    'X-Jenkins-Session': sessionID
    }
    pprint(headers)
    response = requests.post(job_url, headers=headers, data=params, verify=False)
    print(response.text.encode('utf8'))

    ```

Please sign in to leave a comment.