Python Jenkins

https://python-jenkins.readthedocs.io/en/latest
Admin
Python Jenkins is a Python wrapper for the Jenkins REST API, providing a more conventionally...
Tokens:20,805
Snippets:295
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Build Information Example

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about a specific build after it has completed. Ensure a delay if checking immediately after triggering a build.

```python
>>> next_build_number = server.get_job_info('build_name')['nextBuildNumber']
>>> output = server.build_job('build_name')
>>> from time import sleep; sleep(10)
>>> build_info = server.get_build_info('build_name', next_build_number)
>>> print(build_info)
```

--------------------------------

### Get All Plugins Information

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information for all installed plugins, returning a multi-key dictionary for easy access by short or long name. This method simplifies version comparison using a helper class.

```python
>>> j = Jenkins()
>>> info = j.get_plugins()
>>> print(info)
{('gearman-plugin', 'Gearman Plugin'):
  {u'backupVersion': None, u'version': u'0.0.4',
   u'deleted': False, u'supportsDynamicLoad': u'MAYBE',
   u'hasUpdate': True, u'enabled': True, u'pinned': False,
   u'downgradable': False, u'dependencies': [], u'url':
   u'http://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin',
   u'longName': u'Gearman Plugin', u'active': True, u'shortName':
   u'gearman-plugin', u'bundled': False}, ...}
```

--------------------------------

### Install Python Jenkins using setup.py

Source: https://python-jenkins.readthedocs.io/en/latest/index.html

Installs the Python Jenkins library using the setup.py script. This method is typically used when building from source.

```bash
$ sudo python setup.py install

```

--------------------------------

### Install python-jenkins with easy_install

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Use easy_install to install the python-jenkins library. This is an alternative package installation method.

```bash
easy_install python-jenkins
```

--------------------------------

### Install Plugin

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Installs a plugin and its dependencies from the Jenkins public repository. Returns True if a Jenkins restart is required.

```python
>>> info = server.install_plugin("jabber")
>>> print(info)
True
```

--------------------------------

### Install python-jenkins with easy_install

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Use this command to install the python-jenkins library using easy_install, an older Python package installer.

```bash
easy_install python-jenkins

```

--------------------------------

### install_plugin()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Installs a plugin in Jenkins.

```APIDOC
## install_plugin()

### Description
Installs a plugin in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Example Usage of get_plugins_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches plugin information and prints the raw JSON data.

```python
>>> info = server.get_plugins_info()
>>> print(info)
[{u'backupVersion': None, u'version': u'0.0.4', u'deleted': False,
u'supportsDynamicLoad': u'MAYBE', u'hasUpdate': True,
u'enabled': True, u'pinned': False, u'downgradable': False,
u'dependencies': [], u'url':
```

--------------------------------

### Generate documentation locally

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Use tox to generate the project's documentation locally. Ensure tox is installed and configured.

```bash
tox -e docs
```

--------------------------------

### Get Installed Plugins Information (Deprecated)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about all installed plugins on the Jenkins master. Deprecated; use `get_plugins()` instead. Controls response detail with depth parameter.

```python
get_plugins_info(_depth=2_)
```

--------------------------------

### Install python-jenkins for development

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Install the python-jenkins library in development mode using setup.py. This allows for direct code modifications.

```bash
python setup.py develop
```

--------------------------------

### Install python-jenkins with pip

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Use pip to install the python-jenkins library. This is the standard method for Python package installation.

```bash
pip install python-jenkins
```

--------------------------------

### Get Jenkins Plugins Information

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Retrieve information about all installed plugins on the Jenkins server. Returns a dictionary containing plugin details.

```python
plugins = server.get_plugins_info()
print plugins
```

--------------------------------

### Example Usage of get_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches master information and prints the first job from the list of jobs.

```python
>>> info = server.get_info()
>>> jobs = info['jobs']
>>> print(jobs[0])
{u'url': u'http://your_url_here/job/my_job/', u'color': u'blue',
u'name': u'my_job'}
```

--------------------------------

### Example Usage of get_queue_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Demonstrates how to retrieve and print the first item from the Jenkins queue information.

```python
>>> queue_info = server.get_queue_info()
>>> print(queue_info[0])
{u'task': {u'url': u'http://your_url/job/my_job/', u'color': u'aborted_anime', u'name': u'my_job'}, u'stuck': False, u'actions': [{u'causes': [{u'shortDescription': u'Started by timer'}]}], u'buildable': False, u'params': u'', u'buildableStartMilliseconds': 1315087293316, u'why': u'Build #2,532 is already in progress (ETA:10 min)', u'blocked': True}
```

--------------------------------

### Install python-jenkins with pip

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Use this command to install the python-jenkins library using pip, the standard Python package installer.

```bash
pip install python-jenkins

```

--------------------------------

### Example Usage of get_version

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches the Jenkins master version and prints it.

```python
>>> info = server.get_version()
>>> print info
>>> 1.541
```

--------------------------------

### Install Kerberos Package

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Install the 'kerberos' Python package using pip. This is required for automatic Kerberos authentication with Jenkins.

```bash
pip install kerberos
```

--------------------------------

### Install python-jenkins on Debian-based systems

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Use this command to install the python-jenkins library on Ubuntu and other Debian-based distributions using apt-get.

```bash
apt-get install python-jenkins

```

--------------------------------

### Manage Jenkins Build Promotions

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Provides examples for creating, checking existence, retrieving, reconfiguring, and deleting promotion processes for Jenkins jobs. Requires the Promoted Builds Plugin.

```xml
<properties>
       <hudson.plugins.promoted__builds.JobPropertyImpl>
       <activeProcessNames>
          <string>prom_name</string>
        </activeProcessNames>
      </hudson.plugins.promoted__builds.JobPropertyImpl>
    </properties>
```

```python
server.create_promotion('prom_name', 'prom_job', jenkins.EMPTY_PROMO_CONFIG_XML)
server.promotion_exists('prom_name', 'prom_job')
print server.get_promotions('prom_job')

server.reconfig_promotion('prom_name', 'prom_job', jenkins.PROMO_RECONFIG_XML)
print server.get_promotion_config('prom_name', 'prom_job')

server.delete_promotion('prom_name', 'prom_job')
```

--------------------------------

### Install python-jenkins on Fedora

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Use this command to install the python-jenkins library on Fedora 19 and later using yum.

```bash
yum install python-jenkins

```

--------------------------------

### get_plugins()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves a list of all plugins installed in Jenkins.

```APIDOC
## get_plugins()

### Description
Retrieves a list of all plugins installed in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Install python-jenkins for development

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Use this command to install the python-jenkins library in development mode, which is useful for making changes to the library itself.

```bash
python setup.py develop

```

--------------------------------

### Install python-jenkins on Debian-based systems

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Install the python-jenkins package on Ubuntu and other Debian-based distributions using apt-get.

```bash
apt-get install python-jenkins
```

--------------------------------

### install_plugin

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Installs a Jenkins plugin and its dependencies from the Jenkins public repository. Returns a boolean indicating if a Jenkins restart is required.

```APIDOC
## install_plugin(name, include_dependencies=True)

### Description
Install a plugin and its dependencies from the Jenkins public repository at http://repo.jenkins-ci.org/repo/org/jenkins-ci/plugins

### Parameters
#### Path Parameters
- **name** (string) - The plugin short name
- **include_dependencies** (boolean) - Install the plugin’s dependencies

### Returns
Whether a Jenkins restart is required (bool)

### Example
```python
>>> info = server.install_plugin("jabber")
>>> print(info)
True
```
```

--------------------------------

### Install python-jenkins on Fedora

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Install the python-jenkins package on Fedora 19 and later using yum.

```bash
yum install python-jenkins
```

--------------------------------

### Install Python Jenkins using pip

Source: https://python-jenkins.readthedocs.io/en/latest/index.html

Installs the Python Jenkins library using pip. This is a common method for installing Python packages.

```bash
$ sudo pip install python-jenkins

```

--------------------------------

### Get Specific Plugin Information

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves detailed information about a single installed plugin by its short or long name. Calling this method queries Jenkins for fresh information on each call. For multiple plugins, use `get_plugins()`.

```python
>>> info = server.get_plugin_info("Gearman Plugin")
>>> print(info)
{u'backupVersion': None, u'version': u'0.0.4', u'deleted': False,
u'supportsDynamicLoad': u'MAYBE', u'hasUpdate': True,
u'enabled': True, u'pinned': False, u'downgradable': False,
u'dependencies': [], u'url':
u'http://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin',
u'longName': u'Gearman Plugin', u'active': True, u'shortName':
u'gearman-plugin', u'bundled': False}
```

--------------------------------

### Example Usage of get_whoami

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches the current user's full name and prints it.

```python
>>> me = server.get_whoami()
>>> print me['fullName']
>>> 'John'
```

--------------------------------

### get_plugins_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves detailed information about all plugins installed in Jenkins.

```APIDOC
## get_plugins_info()

### Description
Retrieves detailed information about all plugins installed in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### build_job_url

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Gets the URL to trigger a build job. Supports parameters and an optional token. Authenticated setups may require server-side token configuration.

```APIDOC
## build_job_url

### Description
Get URL to trigger build job.
Authenticated setups may require configuring a token on the server side.
Use `list of two membered tuples` to supply parameters with multi select options.

### Parameters
- **name** (str) - Name of Jenkins job
- **parameters** (dict or list of two membered tuples) - parameters for job, or None.
- **token** (str) - (optional) token for building job

### Returns
- URL for building job
```

--------------------------------

### get_plugins

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about all installed plugins, using a helper class for version comparison and a multi-key dictionary for access by short or long names.

```APIDOC
## get_plugins

### Description
Return plugins info using helper class for version comparison. This method retrieves information about all the installed plugins and uses a Plugin helper class to simplify version comparison. Also uses a multi key dict to allow retrieval via either short or long names.

When printing/dumping the data, the version will transparently return a unicode string, which is exactly what was previously returned by the API.

### Parameters
* **depth** (int) - JSON depth. Defaults to 2.

### Returns
info on all plugins `[dict]`

### Example
```python
j = Jenkins()
info = j.get_plugins()
print(info)
```
```

--------------------------------

### Log into Jenkins using Kerberos

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Connect to Jenkins. If the 'kerberos' package is installed and the Jenkins server supports it, authentication will be attempted automatically.

```python
import jenkins

server = jenkins.Jenkins('http://localhost:8080')
print server.jobs_count()
```

--------------------------------

### get_plugin_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves information about a specific plugin installed in Jenkins.

```APIDOC
## get_plugin_info()

### Description
Retrieves information about a specific plugin installed in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Get Build Stages

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches stage information for a specific build. Requires job name and build number.

```python
get_build_stages(_name_ , _number_)
```

--------------------------------

### get_plugins_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves detailed information about all installed plugins on the Jenkins master. Returns raw plugin data in JSON format. Deprecated; use `get_plugins()` instead.

```APIDOC
## get_plugins_info

### Description
Get all installed plugins information on this Master. This method retrieves information about each plugin that is installed on master returning the raw plugin data in a JSON format.

### Parameters
#### Path Parameters
- **depth** (int) - JSON depth

### Returns
info on all plugins `[dict]`

### Example
```python
>>> info = server.get_plugins_info()
>>> print(info)
[{u'backupVersion': None, u'version': u'0.0.4', u'deleted': False,
u'supportsDynamicLoad': u'MAYBE', u'hasUpdate': True,
u'enabled': True, u'pinned': False, u'downgradable': False,
u'dependencies': [], u'url':
```
```

--------------------------------

### get_plugin_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about a specific installed plugin on the Jenkins master. The plugin name must be an exact match.

```APIDOC
## get_plugin_info

### Description
Get an installed plugin information on this Master. This method retrieves information about a specific plugin and returns the raw plugin data in a JSON format. The passed in plugin name (short or long) must be an exact match.

Note: Calling this method will query Jenkins fresh for the information for all plugins on each call. If you need to retrieve information for multiple plugins it’s recommended to use `get_plugins()` instead, which will return a multi key dictionary that can be accessed via either the short or long name of the plugin.

### Parameters
* **name** (str) - Name (short or long) of plugin
* **depth** (int) - JSON depth. Defaults to 2.

### Returns
a specific plugin `dict`

### Example
```python
info = server.get_plugin_info("Gearman Plugin")
print(info)
```
```

--------------------------------

### Run Script and Print Info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Executes a Groovy script on Jenkins and prints the output. Useful for retrieving information about installed plugins.

```python
>>> info = server.run_script("println(Jenkins.instance.pluginManager.plugins)")
>>> print(info)
u'[Plugin:windows-slaves, Plugin:ssh-slaves, Plugin:translation,
Plugin:cvs, Plugin:nodelabelparameter, Plugin:external-monitor-job,
Plugin:mailer, Plugin:jquery, Plugin:antisamy-markup-formatter,
Plugin:maven-plugin, Plugin:pam-auth]'
```

--------------------------------

### Get Running Builds

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a list of currently running builds on Jenkins. Each build is represented as a dictionary.

```python
>>> builds = server.get_running_builds()
>>> print(builds)
[{'node': 'foo-slave', 'url': 'https://localhost/job/test/15/', 'executor': 0, 'name': 'test', 'number': 15}]
```

--------------------------------

### Retrieve and Cancel Jenkins Build Queue Items

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Shows how to get information about items in the Jenkins build queue and cancel a specific item by its ID.

```python
server.build_job('foo')
queue_info = server.get_queue_info()
id = queue_info[0].get('id')
server.cancel_queue(id)
```

--------------------------------

### Get Jenkins Job Configuration

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the XML configuration of an existing Jenkins job.

```python
>>> server.get_job_config('job_name')
'<xml>...</xml>'
```

--------------------------------

### Get Current User Information

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about the currently authenticated user. Useful for verifying credentials.

```python
get_whoami(_depth=0_)
```

--------------------------------

### Get Jenkins Server Version

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Connect to a Jenkins instance and retrieve its version and current user information. Authentication can be done with username/password or an API token for Jenkins versions 1.426+.

```python
import jenkins

server = jenkins.Jenkins('http://localhost:8080', username='myuser', password='mypassword')
user = server.get_whoami()
version = server.get_version()
print('Hello %s from Jenkins %s' % (user['fullName'], version))
```

--------------------------------

### Get Build Test Report

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches the test results report for a given build. Requires job name and build number. Returns None if no test report is available.

```python
get_build_test_report(_name_ , _number_ , _depth=0_)
```

--------------------------------

### Generate documentation locally

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Execute this command using tox to generate the project's documentation locally. The generated HTML files will be available in the doc/build/html directory.

```bash
tox -e docs

```

--------------------------------

### Get Build Environment Variables

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves environment variables for a specific build. Accepts job name and build number. Depth parameter controls JSON response detail.

```python
get_build_env_vars(_name_ , _number_ , _depth=0_)
```

--------------------------------

### Get Build Artifact

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a specific artifact from a build. Requires job name, build number, and the artifact's relative path.

```python
get_build_artifact(_name_ , _number_ , _artifact_)
```

--------------------------------

### Get Build Console Output

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches the console output for a specific Jenkins build. Accepts job name and build number (integer or string).

```python
server.get_build_console_output(name='my-job', number='5')
```

--------------------------------

### Get Queue Information

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a list of job dictionaries representing the current Jenkins queue. Useful for monitoring queued builds.

```python
get_queue_info()
```

--------------------------------

### Get Master or Item Information

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves information about the Jenkins master or specific items (like jobs or folders) on the master. Can filter with an XPath query.

```python
get_info(_item=''_ , _query=None_)
```

--------------------------------

### Get All Jobs Recursively

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches all jobs recursively up to a specified folder depth. This method is efficient for instances with many folders, fetching levels in batches. The `tree` query parameter is used for optimization.

```python
?tree=jobs[url,color,name,jobs[...,jobs[...,jobs[...,jobs]]]]
```

```python
{"name": "folder", "url": "...", "jobs": [{}, {}, ...]}}
```

--------------------------------

### Manage Jenkins Build Promotions

Source: https://python-jenkins.readthedocs.io/en/latest/examples.html

Illustrates creating, checking existence, retrieving, reconfiguring, and deleting a promotion process for a Jenkins job. Requires the Promoted Builds Plugin. The job must have the necessary properties configured beforehand.

```xml
<properties>
   <hudson.plugins.promoted__builds.JobPropertyImpl>
   <activeProcessNames>
      <string>prom_name</string>
    </activeProcessNames>
  </hudson.plugins.promoted__builds.JobPropertyImpl>
</properties>
```

```python
server.create_promotion('prom_name', 'prom_job', jenkins.EMPTY_PROMO_CONFIG_XML)
server.promotion_exists('prom_name', 'prom_job')
print server.get_promotions('prom_job')

server.reconfig_promotion('prom_name', 'prom_job', jenkins.PROMO_RECONFIG_XML)
print server.get_promotion_config('prom_name', 'prom_job')

server.delete_promotion('prom_name', 'prom_job')
```

--------------------------------

### Wait for Jenkins to be Ready

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Demonstrates how to configure a Jenkins client with a connection timeout and wait for the Jenkins API to become responsive within a specified duration.

```python
# timeout here is the socket connection timeout, for each connection
# attempt it will wait at most 5 seconds before assuming there is
# nothing listening. Useful where firewalls may black hole connections.
server = jenkins.Jenkins('http://localhost:8080', timeout=5)

# wait for at least 30 seconds for Jenkins to be ready
if server.wait_for_normal_op(30):
    # actions once running
    ...
else:
    print("Jenkins failed to be ready in sufficient time")
    exit 2
```

--------------------------------

### Create, Copy, and Delete Jenkins Folders

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Demonstrates creating Jenkins folders, copying jobs within folders, and deleting jobs and folders. Requires the Cloudbees Folders Plugin.

```python
server.create_job('folder', jenkins.EMPTY_FOLDER_XML)
server.create_job('folder/empty', jenkins.EMPTY_FOLDER_XML)
server.copy_job('folder/empty', 'folder/empty_copy')
server.delete_job('folder/empty_copy')
server.delete_job('folder')
```

--------------------------------

### Get List of Jobs

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a list of jobs, optionally filtered by a specific view. Each job is represented as a dictionary containing its name, URL, color, and fullname. The `folder_depth` parameter controls the recursion level.

```python
>>> jobs = server.get_jobs()
>>> print(jobs)
[{
    u'name': u'all_tests',
    u'url': u'http://your_url.here/job/all_tests/',
    u'color': u'blue',
    u'fullname': u'all_tests'
}]
```

--------------------------------

### Set Next Build Number for a Jenkins Job

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Sets the next build number for a specified Jenkins job. Requires the Next Build Number Plugin to be installed. If the specified number is less than the last build number, Jenkins will ignore the request.

```python
>>> next_bn = server.get_job_info('job_name')["nextBuildNumber"]
>>> server.set_next_build_number('job_name', next_bn + 50)
```

--------------------------------

### jenkins_open()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Opens a connection to a Jenkins instance.

```APIDOC
## jenkins_open()

### Description
Opens a connection to a Jenkins instance.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### create_promotion(name, job_name, config_xml)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins promotion.

```APIDOC
## create_promotion(name, job_name, config_xml)

### Description
Create a new Jenkins promotion

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins promotion
- **job_name** (str) - Job name
- **config_xml** (str) - config file text
```

--------------------------------

### create_promotion()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new promotion in Jenkins.

```APIDOC
## create_promotion()

### Description
Creates a new promotion in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves general information about the Jenkins instance.

```APIDOC
## get_info()

### Description
Retrieves general information about the Jenkins instance.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_promotions()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves a list of all promotions configured in Jenkins.

```APIDOC
## get_promotions()

### Description
Retrieves a list of all promotions configured in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Jenkins Class Initialization

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Initializes a handle to a Jenkins instance. All methods will raise JenkinsException on failure.

```APIDOC
## class jenkins.Jenkins(url, username=None, password=None, timeout=None)

### Description
Create handle to Jenkins instance. All methods will raise `JenkinsException` on failure.

### Parameters
* **url** (str) - URL of Jenkins server
* **username** (str, optional) - Server username
* **password** (str, optional) - Server password
* **timeout** (int, optional) - Server connection timeout in secs (default: not set)
```

--------------------------------

### get_job_config

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Gets the configuration of an existing Jenkins job in XML format.

```APIDOC
## get_job_config

### Description
Get configuration of existing Jenkins job.

### Parameters
- **name** (str) - Name of Jenkins job

### Returns
- job configuration (XML format)
```

--------------------------------

### Get Master Version

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the version number of the Jenkins master.

```python
get_version()
```

--------------------------------

### Run unit tests with tox

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Execute this command using tox to run the project's unit tests for Python 2.7. Refer to tox.ini for running tests on other Python versions.

```bash
tox -e py27

```

--------------------------------

### reconfig_promotion()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Reconfigures an existing promotion in Jenkins.

```APIDOC
## reconfig_promotion()

### Description
Reconfigures an existing promotion in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Manage Jenkins Views

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/examples.rst.txt

Create, retrieve, and delete Jenkins views. Requires view configuration XML for creation.

```python
server.create_view('EMPTY', jenkins.EMPTY_VIEW_CONFIG_XML)
view_config = server.get_view_config('EMPTY')
views = server.get_views()
server.delete_view('EMPTY')
print views
```

--------------------------------

### Get Jenkins Jobs Count

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the total number of jobs present on the Jenkins server.

```python
>>> server.jobs_count()
150
```

--------------------------------

### Run unit tests with tox (Python 2.7)

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Execute unit tests using tox for Python 2.7. Refer to tox.ini for running tests on other Python versions.

```bash
tox -e py27
```

--------------------------------

### create_view(name, config_xml)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins view with the provided configuration.

```APIDOC
## create_view(name, config_xml)

### Description
Create a new Jenkins view

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins view
- **config_xml** (str) - config file text
```

--------------------------------

### get_promotions_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves detailed information about all promotions in Jenkins.

```APIDOC
## get_promotions_info()

### Description
Retrieves detailed information about all promotions in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Get View Name

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the name of a Jenkins view using its API. Useful for verifying view existence or accessibility.

```python
server.get_view_name('my-view')
```

--------------------------------

### get_promotion_config()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves the configuration of a specific promotion in Jenkins.

```APIDOC
## get_promotion_config()

### Description
Retrieves the configuration of a specific promotion in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### create_folder()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new folder in Jenkins.

```APIDOC
## create_folder()

### Description
Creates a new folder in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Create Node

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins node with specified parameters. Allows configuration of executors, description, remote filesystem, labels, and launcher.

```python
server.create_node(name='new-node', numExecutors=2, nodeDescription='A new slave node', remoteFS='/var/lib/jenkins', labels='linux', exclusive=False, launcher='hudson.slaves.CommandLauncher', launcher_params={})
```

--------------------------------

### create_view()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new view in Jenkins.

```APIDOC
## create_view()

### Description
Creates a new view in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### list_credentials()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Lists all credentials available in Jenkins.

```APIDOC
## list_credentials()

### Description
Lists all credentials available in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### enable_node

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Enables a Jenkins node.

```APIDOC
## enable_node(name)

### Description
Enable a node

### Parameters
#### Path Parameters
- **name** (str) - Jenkins node name
```

--------------------------------

### get_promotion_config(name, job_name)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the configuration of an existing Jenkins promotion.

```APIDOC
## get_promotion_config(name, job_name)

### Description
Get configuration of existing Jenkins promotion.

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins promotion
- **job_name** (str) - Job name

### Returns
- promotion configuration (XML format)
```

--------------------------------

### assert_credential_exists(name, folder_name, domain_name='_', exception_message='credential[%s] does not exist in the domain[%s] of [%s]')

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Raises an exception if a credential does not exist in the specified domain of a folder.

```APIDOC
## assert_credential_exists(name, folder_name, domain_name='_', exception_message='credential[%s] does not exist in the domain[%s] of [%s]')

### Description
Raise an exception if credential does not exist in domain of folder

### Parameters
#### Path Parameters
- **name** (str) - Name of credential
- **folder_name** (str) - Folder name
- **domain_name** (str) - Domain name, default is ‘_’
- **exception_message** (str) - Message to use for the exception. Formatted with `name`, `domain_name`, and `folder_name`
```

--------------------------------

### create_folder

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins folder. Optionally ignores failures.

```APIDOC
## create_folder

### Description
Create a new Jenkins folder

### Parameters
- **folder_name** (str) - Name of Jenkins Folder
- **ignore_failures** (bool) - if True, don’t raise if it was not possible to create the folder
```

--------------------------------

### Create Jenkins Job

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins job with the specified XML configuration.

```python
>>> server.create_job('new_job', '<xml>...</xml>')

```

--------------------------------

### get_build_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches detailed information about a specific build of a job.

```APIDOC
## get_build_info(name, number, depth=0)

### Description
Get build information dictionary.

### Parameters
* **name** (str) - Job name
* **number** (str or int) - Build number
* **depth** (int) - JSON depth

### Returns
dictionary of build information, `dict`

### Example
```python
>>> next_build_number = server.get_job_info('build_name')['nextBuildNumber']
>>> output = server.build_job('build_name')
>>> from time import sleep; sleep(10)
>>> build_info = server.get_build_info('build_name', next_build_number)
>>> print(build_info)
```
```

--------------------------------

### jenkins_open

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Opens an HTTP request and returns the response body as a string.

```APIDOC
## jenkins_open(req, add_crumb=True, resolve_auth=True)

### Description
Return the HTTP response body from a `requests.Request`.

### Parameters
* **req** - A `requests.Request` to submit.
* **add_crumb** (bool, optional) - If True, try to add a crumb header to this `req` before submitting. Defaults to `True`.
* **resolve_auth** (bool, optional) - If True, maybe add authentication. Defaults to `True`.

### Returns
`str`
```

--------------------------------

### Run specific unit tests with tox

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Execute this command using tox to run tests against a specific API method, such as Jenkins.get_version(). This is useful for targeted testing.

```bash
tox -e py27 -- tests.test_version.JenkinsVersionTest

```

--------------------------------

### get_views()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves a list of all views configured in Jenkins.

```APIDOC
## get_views()

### Description
Retrieves a list of all views configured in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Measure test coverage with tox

Source: https://python-jenkins.readthedocs.io/en/latest/install.html

Execute this command using tox to measure the test coverage of the project. This helps in identifying areas of the code that are not adequately tested.

```bash
tox -e cover

```

--------------------------------

### Build Jenkins Job URL with Parameters

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the URL to trigger a Jenkins job build, supporting parameters and tokens. Parameters can be provided as a dictionary or a list of two-membered tuples for multi-select options.

```python
>>> server.build_job_url('job_name', parameters=[('param1', 'value1'), ('param2', 'value2')])
'http://jenkins.example.com/job/job_name/build?token=...' 
```

--------------------------------

### reconfig_promotion(name, job_name, config_xml)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Changes the configuration of an existing Jenkins promotion.

```APIDOC
## reconfig_promotion(name, job_name, config_xml)

### Description
Change configuration of existing Jenkins promotion.
To create a new promotion, see `Jenkins.create_promotion()`.

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins promotion
- **job_name** (str) - Job name
- **config_xml** (str) - New XML configuration
```

--------------------------------

### Create Jenkins Folder

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new folder in Jenkins. The `ignore_failures` parameter can be set to `True` to prevent exceptions if folder creation fails.

```python
>>> server.create_folder('new_folder')

```

--------------------------------

### assert_promotion_exists(name, job_name, exception_message='promotion[%s] does not exist for job[%s]')

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Raises an exception if a job does not have a specific promotion.

```APIDOC
## assert_promotion_exists(name, job_name, exception_message='promotion[%s] does not exist for job[%s]')

### Description
Raise an exception if a job lacks a promotion

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins promotion
- **job_name** (str) - Job name
- **exception_message** (str) - Message to use for the exception. Formatted with `name` and `job_name`

### Throws
- `JenkinsException` whenever the promotion does not exist on a job
```

--------------------------------

### check_jenkinsfile_syntax()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Checks the syntax of a Jenkinsfile.

```APIDOC
## check_jenkinsfile_syntax()

### Description
Checks the syntax of a Jenkinsfile.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_promotions_info(job_name, depth=0)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves promotion information for a job.

```APIDOC
## get_promotions_info(job_name, depth=0)

### Description
Get promotion information dictionary of a job

### Parameters
#### Path Parameters
- **job_name** (str) - job_name
- **depth** (int) - JSON depth, default is 0

### Returns
- Dictionary of promotion info, `dict`
```

--------------------------------

### create_credential

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new credential within a specified folder and domain using the provided XML configuration.

```APIDOC
## create_credential(folder_name, config_xml, domain_name='_')

### Description
Create credential in domain of folder.

### Parameters
#### Path Parameters
- **folder_name** (str) - Folder name
- **config_xml** (str) - New XML configuration
- **domain_name** (str) - Domain name, default is ‘_’
```

--------------------------------

### create_credential()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new credential in Jenkins.

```APIDOC
## create_credential()

### Description
Creates a new credential in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### promotion_exists()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Checks if a promotion with the given name exists in Jenkins.

```APIDOC
## promotion_exists()

### Description
Checks if a promotion with the given name exists in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### create_job()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new job in Jenkins.

```APIDOC
## create_job()

### Description
Creates a new job in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_build_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves information about a specific build in Jenkins.

```APIDOC
## get_build_info()

### Description
Retrieves information about a specific build in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_version()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves the version of the Jenkins instance.

```APIDOC
## get_version()

### Description
Retrieves the version of the Jenkins instance.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Build a Jenkins Job with Parameters

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Triggers a Jenkins job build, optionally with parameters and a token. Returns a queue item number that can be used to track the build's progress. The queue item number is only valid for about five minutes.

```python
>>> server.build_job('job_name', parameters={'param1': 'value1'})
123
```

--------------------------------

### get_queue_info()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves information about the Jenkins build queue.

```APIDOC
## get_queue_info()

### Description
Retrieves information about the Jenkins build queue.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Run specific unit tests with tox (Python 2.7)

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Execute tests for a specific API method, such as Jenkins.get_version, using tox for Python 2.7.

```bash
tox -e py27 -- tests.test_version.JenkinsVersionTest
```

--------------------------------

### run_script()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Executes a script on the Jenkins master.

```APIDOC
## run_script()

### Description
Executes a script on the Jenkins master.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### create_node

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Creates a new Jenkins node with specified configuration parameters.

```APIDOC
## create_node(name, numExecutors=2, nodeDescription=None, remoteFS='/var/lib/jenkins', labels=None, exclusive=False, launcher='hudson.slaves.CommandLauncher', launcher_params={})

### Description
Create a node

### Parameters
#### Path Parameters
- **name** (str) - name of node to create
- **numExecutors** (int) - number of executors for node (default: 2)
- **nodeDescription** (str) - Description of node (default: None)
- **remoteFS** (str) - Remote filesystem location to use (default: '/var/lib/jenkins')
- **labels** (str) - Labels to associate with node (default: None)
- **exclusive** (bool) - Use this node for tied jobs only (default: False)
- **launcher** (str) - The launch method for the slave, `jenkins.LAUNCHER_COMMAND`, `jenkins.LAUNCHER_SSH`, `jenkins.LAUNCHER_JNLP`, `jenkins.LAUNCHER_WINDOWS_SERVICE` (default: 'hudson.slaves.CommandLauncher')
- **launcher_params** (dict) - Additional parameters for the launcher (default: {})
```

--------------------------------

### assert_promotion_exists()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Asserts that a promotion with the given name exists in Jenkins.

```APIDOC
## assert_promotion_exists()

### Description
Asserts that a promotion with the given name exists in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### Measure test coverage with tox

Source: https://python-jenkins.readthedocs.io/en/latest/_sources/install.rst.txt

Use tox to measure the test coverage of the project. This command generates a coverage report.

```bash
tox -e cover
```

--------------------------------

### reconfig_view()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Reconfigures an existing view in Jenkins.

```APIDOC
## reconfig_view()

### Description
Reconfigures an existing view in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_promotions(job_name)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a list of promotions running for a job.

```APIDOC
## get_promotions(job_name)

### Description
Get list of promotions running.
Each promotion is a dictionary with ‘name’ and ‘url’ keys.

### Parameters
#### Path Parameters
- **job_name** (str) - Job name

### Returns
- list of promotions, `[ { str: str} ]`
```

--------------------------------

### jenkins_request()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Makes a generic request to the Jenkins API.

```APIDOC
## jenkins_request()

### Description
Makes a generic request to the Jenkins API.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### enable_job()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Enables a job in Jenkins, allowing it to be built.

```APIDOC
## enable_job()

### Description
Enables a job in Jenkins, allowing it to be built.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_credential_config

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches the configuration details of a credential in XML format from a specified folder and domain.

```APIDOC
## get_credential_config(name, folder_name, domain_name='_')

### Description
Get configuration of credential in domain of folder.

### Parameters
#### Path Parameters
- **name** (str) - Name of credential
- **folder_name** (str) - Folder name
- **domain_name** (str) - Domain name, default is ‘_’

### Returns
- **str** - Credential configuration (XML format).
```

--------------------------------

### merge_environment_settings()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Merges environment settings, likely for session configuration.

```APIDOC
## merge_environment_settings()

### Description
Merges environment settings, likely for session configuration.

### Method
jenkins.WrappedSession method

### Parameters
None explicitly documented.
```

--------------------------------

### promotion_exists(name, job_name)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Checks if a job has a specific promotion.

```APIDOC
## promotion_exists(name, job_name)

### Description
Check whether a job has a certain promotion

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins promotion
- **job_name** (str) - Job name

### Returns
- `True` if Jenkins promotion exists
```

--------------------------------

### run_script

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Executes a groovy script on the Jenkins master or a specified node.

```APIDOC
## run_script

### Description
Execute a groovy script on the jenkins master or on a node if specified..

### Parameters
- **script** (string) - The groovy script
- **node** (str) - Node to run the script on, defaults to None (master).

### Returns
- The result of the script run.

### Example
```python

```
```

--------------------------------

### list_credentials

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves a list of all credentials available within a specified folder and domain.

```APIDOC
## list_credentials(folder_name, domain_name='_')

### Description
List credentials in domain of folder.

### Parameters
#### Path Parameters
- **folder_name** (str) - Folder name
- **domain_name** (str) - Domain name, default is ‘_’

### Returns
- **list** - Credentials list.
```

--------------------------------

### create_node()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Creates a new node (agent) in Jenkins.

```APIDOC
## create_node()

### Description
Creates a new node (agent) in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves general information about the Jenkins master or a specific item on the master. This can include job lists and view configurations.

```APIDOC
## get_info

### Description
Get information on this Master or item on Master. This information includes job list and view information and can be used to retrieve information on items such as job folders.

### Parameters
#### Path Parameters
- **item** (str) - item to get information about on this Master
- **query** (str) - xpath to extract information about on this Master

### Returns
dictionary of information about Master or item, `dict`

### Example
```python
>>> info = server.get_info()
>>> jobs = info['jobs']
>>> print(jobs[0])
{u'url': u'http://your_url_here/job/my_job/', u'color': u'blue',
u'name': u'my_job'}
```
```

--------------------------------

### get_build_stages

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Fetches stage information for a specific build of a job. Requires the job name and build number.

```APIDOC
## get_build_stages

### Description
Get stages info from job

### Parameters
#### Path Parameters
- **name** (str) - Job name
- **number** (str or int) - Build number

### Returns
dictionary of stages in the job, `dict`
```

--------------------------------

### check_jenkinsfile_syntax

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Checks if a Pipeline Jenkinsfile has a valid syntax. Returns a list of errors, or an empty list if no errors.

```APIDOC
## check_jenkinsfile_syntax

### Description
Checks if a Pipeline Jenkinsfile has a valid syntax

### Parameters
- **jenkinsfile** (str) - Jenkinsfile text

### Returns
- List of errors in the Jenkinsfile. Empty list if no errors.
```

--------------------------------

### get_promotion_name(name, job_name)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Returns the name of a promotion for a given job.

```APIDOC
## get_promotion_name(name, job_name)

### Description
Return the name of a promotion using the API.
That is roughly an identity method which can be used to quickly verify a promotion exists for a job or is accessible without causing too much stress on the server side.

### Parameters
#### Path Parameters
- **name** (str) - Promotion name
- **job_name** (str) - Job name

### Returns
- Name of promotion or None
```

--------------------------------

### build_job

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Triggers a build job and returns a queue item number. The queue number is only valid for about five minutes.

```APIDOC
## build_job

### Description
Trigger build job.
This method returns a queue item number that you can pass to `Jenkins.get_queue_item()`.
Note that this queue number is only valid for about five minutes after the job completes, so you should get/poll the queue information as soon as possible to determine the job’s URL.

### Parameters
- **name** (str) - name of job
- **parameters** (dict) - parameters for job, or `None`
- **token** (str) - Jenkins API token

### Returns
- `int` queue item
```

--------------------------------

### get_credential_info

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves detailed information about a specific credential within a given folder and domain. The information is returned as a dictionary.

```APIDOC
## get_credential_info(name, folder_name, domain_name='_')

### Description
Get credential information dictionary in domain of folder.

### Parameters
#### Path Parameters
- **name** (str) - Name of credential
- **folder_name** (str) - Folder name
- **domain_name** (str) - Domain name, default is ‘_’

### Returns
- **dict** - Dictionary of credential info.
```

--------------------------------

### get_view_config(name)

Source: https://python-jenkins.readthedocs.io/en/latest/api.html

Retrieves the configuration of an existing Jenkins view.

```APIDOC
## get_view_config(name)

### Description
Get configuration of existing Jenkins view.

### Parameters
#### Path Parameters
- **name** (str) - Name of Jenkins view

### Returns
- view configuration (XML format)
```

--------------------------------

### get_running_builds()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves a list of currently running builds in Jenkins.

```APIDOC
## get_running_builds()

### Description
Retrieves a list of currently running builds in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### reconfig_credential()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Reconfigures an existing credential in Jenkins.

```APIDOC
## reconfig_credential()

### Description
Reconfigures an existing credential in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### get_whoami()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Retrieves information about the currently authenticated user in Jenkins.

```APIDOC
## get_whoami()

### Description
Retrieves information about the currently authenticated user in Jenkins.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```

--------------------------------

### enable_node()

Source: https://python-jenkins.readthedocs.io/en/latest/genindex.html

Enables a node (agent) in Jenkins, allowing it to accept builds.

```APIDOC
## enable_node()

### Description
Enables a node (agent) in Jenkins, allowing it to accept builds.

### Method
jenkins.Jenkins method

### Parameters
None explicitly documented.
```
Tokens:
Raw