API reference

class api4jenkins.AsyncJenkins(url, **kwargs)[source]
async aiter(depth=0)[source]
async api_json(tree='', depth=0)
async build_job(full_name, **params)[source]
async copy_job(full_name, dest)[source]
async create_job(full_name, xml, recursive=False)[source]
property credentials
property crumb
async delete_job(full_name)[source]
async duplicate_job(full_name, new_name, recursive=False)[source]
property dynamic_attrs
async exists()
async get_job(full_name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async is_name_safe(name)[source]
property me
async move_job(full_name, new_full_name)[source]
property nodes
property plugins
property queue
async rename_job(full_name, new_name)[source]
property system
property users
async validate_jenkinsfile(content)[source]
property version
property views
class api4jenkins.Jenkins(url, **kwargs)[source]

Constructs Jenkins.

Parameters:
  • url – URL of Jenkins server, str

  • auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.

  • token – (optional) Boolean, Create user token when initialize instance and revoke token once instance is destroied. useful when LDAP server refuse username and password used too much often. Defaults to False.

  • **kwargs – other kwargs are same as httpx.Client

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> print(j)
<Jenkins: http://127.0.0.1:8080/>
>>> j.version
'2.176.2'
api_json(tree='', depth=0)
build_job(full_name, **params)[source]

Build job with/without params

Parameters:
  • full_namestr, full name of job

  • params – parameters for building, support delay and remote token

Returns:

QueueItem

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> item = j.build_job('freestylejob')
>>> import time
>>> while not item.get_build():
...      time.sleep(1)
>>> build = item.get_build()
>>> print(build)
<FreeStyleBuild: http://127.0.0.1:8080/job/freestylejob/1/>
>>> for line in build.progressive_output():
...     print(line)
...
copy_job(full_name, dest)[source]

Create job by copying other job, the source job and dest job are in same folder.

Parameters:
  • full_name – full name of source job

  • dest – name of new job

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> j.copy_job('folder/freestylejob', 'newjob')
>>> j.get_job('folder/newjob')
>>> print(job)
<FreeStyleProject: http://127.0.0.1:8080/job/folder/job/newjob/>
create_job(full_name, xml, recursive=False)[source]

Create new jenkins job with given xml configuration

Parameters:
  • full_namestr, full name of job

  • xml – xml configuration string

  • recursive – (optional) Boolean, recursively create folder if not existed

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> xml = """<?xml version='1.1' encoding='UTF-8'?>
... <project>
...   <builders>
...     <hudson.tasks.Shell>
...       <command>echo $JENKINS_VERSION</command>
...     </hudson.tasks.Shell>
...   </builders>
... </project>"""
>>> j.create_job('freestylejob', xml)
>>> job = j.get_job('freestylejob')
>>> print(job)
<FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
property credentials

An object for managing credentials. see Credentials

property crumb

Crumb of Jenkins

delete_job(full_name)[source]

Delete job

Parameters:

full_namestr, full name of job

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> job = j.get_job('freestylejob')
>>> print(job)
<FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
>>> j.delete_job('freestylejob')
>>> job = j.get_job('freestylejob')
>>> print(job)
None
duplicate_job(full_name, new_name, recursive=False)[source]
property dynamic_attrs
exists()
get_job(full_name)[source]

Get job by full name

Parameters:

full_namestr, full name of job

Returns:

Corresponding Job object or None

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> job = j.get_job('freestylejob')
>>> print(job)
<FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
is_name_safe(name)[source]
iter(depth=0)[source]

Iterate jobs with depth

Parameters:

depthint, depth to iterate, default is 0

Returns:

iterator of jobs

Usage:

>>> from api4jenkins import Jenkins
>>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin'))
>>> for job in j.iter():
...     print(job)
<FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
...
property me
move_job(full_name, new_full_name)[source]
property nodes

An object for managing nodes. see Nodes

property plugins

An object for managing plugins. see PluginsManager

property queue

An object for managing build queue. see Queue

rename_job(full_name, new_name)[source]
property system

An object for managing system operation. see System

property users
validate_jenkinsfile(content)[source]

validate Jenkinsfile, see https://www.jenkins.io/doc/book/pipeline/development/#linter

Args:

content (str): content of Jenkinsfile

Returns:

str: ‘Jenkinsfile successfully validated.’ if validate successful or error message

property version

Version of Jenkins

property views

An object for managing views of main window. see Views

class api4jenkins.job.AsyncBitbucketSCMNavigator(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncExternalJob(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncFolder(jenkins, url)[source]
async aiter(depth=0)[source]
async api_json(tree='', depth=0)
async configure(xml=None)
async copy(src, dest)[source]
async create(name, xml)[source]
property credentials
async delete()
async duplicate(path, recursive=False)
property dynamic_attrs
async exists()
property full_display_name
property full_name
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async move(path)
property name
property parent
async reload()[source]
async rename(name)
async set_description(text)
property views
class api4jenkins.job.AsyncFreeStyleProject(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncGitHubSCMNavigator(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncIvyModuleSet(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncJob(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async duplicate(path, recursive=False)[source]
property dynamic_attrs
async exists()
property full_display_name
property full_name
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async move(path)[source]
property name
property parent
async rename(name)[source]
async set_description(text)
class api4jenkins.job.AsyncMatrixProject(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncMavenModuleSet(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncMultiJobProject(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncOrganizationFolder(jenkins, url)[source]
async aiter(depth=0)
async api_json(tree='', depth=0)
property buildable
async configure(xml=None)
async copy(src, dest)
async create(name, xml)
property credentials
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
property full_display_name
property full_name
async get(name)
async get_scan_log()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async move(path)
property name
property parent
async reload()
async rename(name)
async scan(delay=0)
async set_description(text)
property views
class api4jenkins.job.AsyncPipelineMultiBranchDefaultsProject(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncProject(jenkins, url)[source]
async aiter()[source]
async api_json(tree='', depth=0)
async build(**params)[source]
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)[source]

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)[source]
async get_parameters()[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()[source]
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)[source]
class api4jenkins.job.AsyncWorkflowJob(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async build(**params)
property building
async configure(xml=None)
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
async filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
async get(number)
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_all_builds()
async move(path)
property name
property parent
async rename(name)
async set_description(text)
async set_next_build_number(number)
class api4jenkins.job.AsyncWorkflowMultiBranchProject(jenkins, url)[source]
async aiter(depth=0)
async api_json(tree='', depth=0)
property buildable
async configure(xml=None)
async copy(src, dest)
async create(name, xml)
property credentials
async delete()
async disable()
async duplicate(path, recursive=False)
property dynamic_attrs
async enable()
async exists()
property full_display_name
property full_name
async get(name)
async get_scan_log()[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async move(path)
property name
property parent
async reload()
async rename(name)
async scan(delay=0)[source]
async set_description(text)
property views
class api4jenkins.job.BitbucketSCMNavigator(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.ExternalJob(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.Folder(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
copy(src, dest)[source]
create(name, xml)[source]
property credentials
delete()
duplicate(path, recursive=False)
property dynamic_attrs
exists()
property full_display_name
property full_name
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter(depth=0)[source]
move(path)
property name
property parent
reload()[source]
rename(name)
set_description(text)
property views
class api4jenkins.job.FreeStyleProject(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.GitHubSCMNavigator(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.IvyModuleSet(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.Job(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
duplicate(path, recursive=False)[source]
property dynamic_attrs
exists()
property full_display_name
property full_name
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
move(path)[source]
property name
property parent
rename(name)[source]
set_description(text)
class api4jenkins.job.MatrixProject(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.MavenModuleSet(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.MultiJobProject(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.NameMixIn[source]
property full_display_name
property full_name
class api4jenkins.job.OrganizationFolder(jenkins, url)[source]
api_json(tree='', depth=0)
property buildable
configure(xml=None)
copy(src, dest)
create(name, xml)
property credentials
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
property full_display_name
property full_name
get(name)
get_scan_log()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter(depth=0)
move(path)
property name
property parent
reload()
rename(name)
scan(delay=0)
set_description(text)
property views
class api4jenkins.job.PipelineMultiBranchDefaultsProject(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.Project(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)[source]
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)[source]

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)[source]
get_parameters()[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()[source]
iter_all_builds()[source]
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)[source]
class api4jenkins.job.WorkflowJob(jenkins, url)[source]
api_json(tree='', depth=0)
build(**params)
property building
configure(xml=None)
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
filter_builds_by_result(*, result)

filter build by build results, avaliable results are: ‘SUCCESS’, ‘UNSTABLE’, ‘FAILURE’, ‘NOT_BUILT’, ‘ABORTED’ see: https://javadoc.jenkins-ci.org/hudson/model/Result.html

property full_display_name
property full_name
get(number)
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_all_builds()
move(path)
property name
property parent
rename(name)
set_description(text)
set_next_build_number(number)
class api4jenkins.job.WorkflowMultiBranchProject(jenkins, url)[source]
api_json(tree='', depth=0)
property buildable
configure(xml=None)
copy(src, dest)
create(name, xml)
property credentials
delete()
disable()
duplicate(path, recursive=False)
property dynamic_attrs
enable()
exists()
property full_display_name
property full_name
get(name)
get_scan_log()[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter(depth=0)
move(path)
property name
property parent
reload()
rename(name)
scan(delay=0)[source]
set_description(text)
property views
class api4jenkins.build.AsyncBuild(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async console_text()[source]
async delete()
property dynamic_attrs
async exists()
async get_causes()
async get_coverage_report()[source]

Access coverage report generated by JaCoCo

async get_coverage_result()[source]

Access coverage result generated by Code Coverage API

async get_next_build()[source]
async get_parameters()
async get_previous_build()[source]
async get_test_report()[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async kill()[source]
async progressive_output(html=False)[source]
property project
async set_description(text)
async stop()[source]
async term()[source]
class api4jenkins.build.AsyncFreeStyleBuild(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async console_text()
async delete()
property dynamic_attrs
async exists()
async get_causes()
async get_coverage_report()

Access coverage report generated by JaCoCo

async get_coverage_result()

Access coverage result generated by Code Coverage API

async get_next_build()
async get_parameters()
async get_previous_build()
async get_test_report()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async kill()
async progressive_output(html=False)
property project
async set_description(text)
async stop()
async term()
class api4jenkins.build.AsyncMatrixBuild(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async console_text()
async delete()
property dynamic_attrs
async exists()
async get_causes()
async get_coverage_report()

Access coverage report generated by JaCoCo

async get_coverage_result()

Access coverage result generated by Code Coverage API

async get_next_build()
async get_parameters()
async get_previous_build()
async get_test_report()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async kill()
async progressive_output(html=False)
property project
async set_description(text)
async stop()
async term()
class api4jenkins.build.AsyncWorkflowRun(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
property artifacts
async console_text()
async delete()
property dynamic_attrs
async exists()
async get_causes()
async get_coverage_report()

Access coverage report generated by JaCoCo

async get_coverage_result()

Access coverage result generated by Code Coverage API

async get_next_build()
async get_parameters()
async get_pending_input()[source]

get current pending input step

async get_previous_build()
async get_test_report()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async kill()
async progressive_output(html=False)
property project
async save_artifacts(filename='archive.zip')[source]
async set_description(text)
async stop()
async term()
class api4jenkins.build.Build(jenkins, url)[source]
api_json(tree='', depth=0)
console_text()[source]
delete()
property dynamic_attrs
exists()
get_causes()
get_coverage_report()[source]

Access coverage report generated by JaCoCo

get_coverage_result()[source]

Access coverage result generated by Code Coverage API

get_next_build()[source]
get_parameters()
get_previous_build()[source]
get_test_report()[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
kill()[source]
progressive_output(html=False)[source]
property project
set_description(text)
stop()[source]
term()[source]
class api4jenkins.build.FreeStyleBuild(jenkins, url)[source]
api_json(tree='', depth=0)
console_text()
delete()
property dynamic_attrs
exists()
get_causes()
get_coverage_report()

Access coverage report generated by JaCoCo

get_coverage_result()

Access coverage result generated by Code Coverage API

get_next_build()
get_parameters()
get_previous_build()
get_test_report()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
kill()
progressive_output(html=False)
property project
set_description(text)
stop()
term()
class api4jenkins.build.MatrixBuild(jenkins, url)[source]
api_json(tree='', depth=0)
console_text()
delete()
property dynamic_attrs
exists()
get_causes()
get_coverage_report()

Access coverage report generated by JaCoCo

get_coverage_result()

Access coverage result generated by Code Coverage API

get_next_build()
get_parameters()
get_previous_build()
get_test_report()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
kill()
progressive_output(html=False)
property project
set_description(text)
stop()
term()
class api4jenkins.build.WorkflowRun(jenkins, url)[source]
api_json(tree='', depth=0)
property artifacts
console_text()
delete()
property dynamic_attrs
exists()
get_causes()
get_coverage_report()

Access coverage report generated by JaCoCo

get_coverage_result()

Access coverage result generated by Code Coverage API

get_next_build()
get_parameters()
get_pending_input()[source]

get current pending input step

get_previous_build()
get_test_report()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
kill()
progressive_output(html=False)
property project
save_artifacts(filename='archive.zip')[source]
set_description(text)
stop()
term()
class api4jenkins.input.AsyncPendingInputAction(jenkins, raw)[source]
async abort()[source]
async aiter()
async api_json(tree='', depth=0)
property dynamic_attrs
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async submit(**params)[source]
class api4jenkins.input.PendingInputAction(jenkins, raw)[source]

this class implement functionality to process input step

abort()[source]

submit input step

api_json(tree='', depth=0)
property dynamic_attrs
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
submit(**params)[source]

submit input step

  • if input requires parameters:
    • if submit without parameters, it will use default value of parameters

    • if submit with wrong parameters, exception raised

  • if input does not requires parameters, but submit with parameters, exception raised

class api4jenkins.queue.AsyncBlockedItem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel()
property dynamic_attrs
async exists()
async get_build()
async get_causes()
async get_job()
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.AsyncBuildableItem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel()
property dynamic_attrs
async exists()
async get_build()
async get_causes()
async get_job()
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.AsyncLeftItem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel()
property dynamic_attrs
async exists()
async get_build()
async get_causes()
async get_job()
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.AsyncQueue(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel(id)[source]
property dynamic_attrs
async exists()
async get(id)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.AsyncQueueItem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel()[source]
property dynamic_attrs
async exists()
async get_build()[source]
async get_causes()
async get_job()[source]
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.AsyncWaitingItem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async cancel()
property dynamic_attrs
async exists()
async get_build()
async get_causes()
async get_job()
async get_parameters()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.queue.BlockedItem(jenkins, url)[source]
api_json(tree='', depth=0)
cancel()
property dynamic_attrs
exists()
get_build()
get_causes()
get_job()
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.queue.BuildableItem(jenkins, url)[source]
api_json(tree='', depth=0)
cancel()
property dynamic_attrs
exists()
get_build()
get_causes()
get_job()
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.queue.LeftItem(jenkins, url)[source]
api_json(tree='', depth=0)
cancel()
property dynamic_attrs
exists()
get_build()
get_causes()
get_job()
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.queue.Queue(jenkins, url)[source]
api_json(tree='', depth=0)
cancel(id)[source]
property dynamic_attrs
exists()
get(id)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.queue.QueueItem(jenkins, url)[source]
api_json(tree='', depth=0)
cancel()[source]
property dynamic_attrs
exists()
get_build()[source]
get_causes()
get_job()[source]
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.queue.WaitingItem(jenkins, url)[source]
api_json(tree='', depth=0)
cancel()
property dynamic_attrs
exists()
get_build()
get_causes()
get_job()
get_parameters()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.credential.AsyncCredential(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
property name
class api4jenkins.credential.AsyncCredentials(jenkins, url)[source]
async aiter()[source]
async api_json(tree='', depth=0)
async create(xml)[source]
property dynamic_attrs
async exists()
async get(name)[source]
property global_domain
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.credential.AsyncDomain(jenkins, url)[source]
async aiter()[source]
async api_json(tree='', depth=0)
async configure(xml=None)
async create(xml)[source]
async delete()
property dynamic_attrs
async exists()
async get(id)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
property name
class api4jenkins.credential.Credential(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
property name
class api4jenkins.credential.Credentials(jenkins, url)[source]
api_json(tree='', depth=0)
create(xml)[source]
property dynamic_attrs
exists()
get(name)[source]
property global_domain
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()[source]
class api4jenkins.credential.Domain(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
create(xml)[source]
delete()
property dynamic_attrs
exists()
get(id)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()[source]
property name
class api4jenkins.node.AsyncDockerComputer(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')
property dynamic_attrs
async enable()
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()
property name
async run_script(script)
class api4jenkins.node.AsyncEC2Computer(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')
property dynamic_attrs
async enable()
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()
property name
async run_script(script)
class api4jenkins.node.AsyncIterBuildingBuildsMixIn[source]
async iter_building_builds()[source]
class api4jenkins.node.AsyncKubernetesComputer(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')
property dynamic_attrs
async enable()
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()
property name
async run_script(script)
class api4jenkins.node.AsyncMasterComputer(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')
property dynamic_attrs
async enable()
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()
property name
async run_script(script)
class api4jenkins.node.AsyncNode(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')[source]
property dynamic_attrs
async enable()[source]
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()[source]
property name
async run_script(script)
class api4jenkins.node.AsyncNodes(jenkins, url)[source]
async aiter()[source]
async api_json(tree='', depth=0)
async create(name, **kwargs)[source]
property dynamic_attrs
async exists()
async filter_node_by_label(*labels)[source]
async filter_node_by_status(*, online)[source]
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()[source]
class api4jenkins.node.AsyncSlaveComputer(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
async disable(msg='')
property dynamic_attrs
async enable()
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async iter_building_builds()
async iter_builds()
property name
async run_script(script)
class api4jenkins.node.DockerComputer(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')
property dynamic_attrs
enable()
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()
property name
run_script(script)
class api4jenkins.node.EC2Computer(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')
property dynamic_attrs
enable()
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()
property name
run_script(script)
class api4jenkins.node.IterBuildingBuildsMixIn[source]
iter_building_builds()[source]
class api4jenkins.node.KubernetesComputer(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')
property dynamic_attrs
enable()
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()
property name
run_script(script)
class api4jenkins.node.MasterComputer(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')
property dynamic_attrs
enable()
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()
property name
run_script(script)
class api4jenkins.node.MasterComputerMixIn(jenkins, url)[source]
class api4jenkins.node.Node(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')[source]
property dynamic_attrs
enable()[source]
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()[source]
property name
run_script(script)
class api4jenkins.node.Nodes(jenkins, url)[source]

classdocs

api_json(tree='', depth=0)
create(name, **kwargs)[source]
property dynamic_attrs
exists()
filter_node_by_label(*labels)[source]
filter_node_by_status(*, online)[source]
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()[source]
iter_building_builds()
iter_builds()[source]
class api4jenkins.node.SlaveComputer(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
disable(msg='')
property dynamic_attrs
enable()
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
iter_building_builds()
iter_builds()
property name
run_script(script)
class api4jenkins.plugin.AsyncPlugin(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
property dynamic_attrs
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async uninstall()[source]
class api4jenkins.plugin.AsyncPluginsManager(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async check_updates_server()[source]
property dynamic_attrs
async exists()
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async install(*names, block=False)[source]
property installation_done
property restart_required
async set_proxy(name, port, *, username='', password='', no_proxy='', test_url='')[source]
async set_site(url)[source]
property site
async uninstall(*names)[source]
property update_center
class api4jenkins.plugin.AsyncUpdateCenter(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
property dynamic_attrs
async exists()
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
property installation_done
property restart_required
property site
class api4jenkins.plugin.Plugin(jenkins, url)[source]
api_json(tree='', depth=0)
property dynamic_attrs
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
uninstall()[source]
class api4jenkins.plugin.PluginsManager(jenkins, url)[source]
api_json(tree='', depth=0)
check_updates_server()[source]
property dynamic_attrs
exists()
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
install(*names, block=False)[source]
property installation_done
iter()
property restart_required
set_proxy(name, port, *, username='', password='', no_proxy='', test_url='')[source]
set_site(url)[source]
property site
uninstall(*names)[source]
property update_center
class api4jenkins.plugin.UpdateCenter(jenkins, url)[source]
api_json(tree='', depth=0)
property dynamic_attrs
exists()
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
property installation_done
iter()
property restart_required
property site
class api4jenkins.view.AllView(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
class api4jenkins.view.AsyncAllView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
class api4jenkins.view.AsyncDashboard(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
class api4jenkins.view.AsyncListView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
class api4jenkins.view.AsyncMyView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
class api4jenkins.view.AsyncNestedView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
property views
class api4jenkins.view.AsyncSectionedView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)
async exists()
async get(name)
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)
property name
async set_description(text)
class api4jenkins.view.AsyncView(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async configure(xml=None)
async delete()
property dynamic_attrs
async exclude(name)[source]
async exists()
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async include(name)[source]
property name
async set_description(text)
class api4jenkins.view.AsyncViews(owner)[source]

classdocs

async aiter()
async api_json(tree='', depth=0)
async create(name, xml)[source]
property dynamic_attrs
async exists()
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.view.Dashboard(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
class api4jenkins.view.ListView(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
class api4jenkins.view.MyView(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
class api4jenkins.view.NestedView(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
property views
class api4jenkins.view.SectionedView(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)
exists()
get(name)
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)
iter()
property name
set_description(text)
class api4jenkins.view.View(jenkins, url)[source]
api_json(tree='', depth=0)
configure(xml=None)
delete()
property dynamic_attrs
exclude(name)[source]
exists()
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
include(name)[source]
iter()
property name
set_description(text)
class api4jenkins.view.Views(owner)[source]

classdocs

api_json(tree='', depth=0)
create(name, xml)[source]
property dynamic_attrs
exists()
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
class api4jenkins.system.AsyncSystem(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async apply_jcasc(content)[source]
async decrypt_secret(text)[source]
property dynamic_attrs
async exists()
async export_jcasc()[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async reload_jcasc()[source]
async run_script(script)
class api4jenkins.system.System(jenkins, url)[source]
api_json(tree='', depth=0)
apply_jcasc(content)[source]
decrypt_secret(text)[source]
property dynamic_attrs
exists()
export_jcasc()[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
reload_jcasc()[source]
run_script(script)
class api4jenkins.user.ApiToken(name, uuid, value)
count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

name

Alias for field number 0

uuid

Alias for field number 1

value

Alias for field number 2

class api4jenkins.user.AsyncUser(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
async delete()
property dynamic_attrs
async exists()
async generate_token(name='')[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
async revoke_token(uuid)[source]
async set_description(text)
class api4jenkins.user.AsyncUsers(jenkins, url)[source]
async aiter()
async api_json(tree='', depth=0)
property dynamic_attrs
async exists()
async get(name)[source]
async handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
class api4jenkins.user.User(jenkins, url)[source]
api_json(tree='', depth=0)
delete()
property dynamic_attrs
exists()
generate_token(name='')[source]
handle_req(method, entry, **kwargs)
handle_stream(method, entry, **kwargs)
headers = {'Content-Type': 'text/xml; charset=utf-8'}
iter()
revoke_token(uuid)[source]
set_description(text)
class api4jenkins.user.Users(jenkins, url)[source]
api_json(tree='', depth=0)
property dynamic_attrs
exists()
get(name)[source]
handle_req(method, entry, **kwargs)
handle_stream