Home

Jenkins (version v2.*.*)

build_job#

Build a job

Parameters

job_name (required)#

Name of the job

Type: string

delay#

Delay, if desired. Set to 0sec for immediate job build

Type: string

build_job_with_parameters#

Build a job with parameters

Parameters

job_name (required)#

Name of the job

Type: STRING

parameters (required)#

An array of name-value objects corresponding to the build parameters. For a build parameter with the name 'param' and the value 'value1', the parameters object would look like: [
{ "name": "param", "value": "value1" }
]

Type: ARRAY

delay#

Delay, if desired. Set to 0sec for immediate job build

Type: STRING

create_job#

Create a new job using job configuration, or copied from an existing job

Parameters

name (required)#

Name of the new job

Type: string

$body#

Job configuration in config.xml format

Type: object

{ }

Content-Type#

Content type header application/xml

Type: string

from#

Existing job to copy from

Type: string

mode#

Set to 'copy' for copying an existing job

Type: string

create_view#

Create a new view using view configuration

Parameters

name (required)#

Name of the new view

Type: string

$body#

View configuration in config.xml format

Type: object

{ }

Content-Type#

Content type header application/xml

Type: string

delete_job#

Delete a job

Parameters

job_name (required)#

Name of the job

Type: string

disable_job#

Disable a job

Parameters

job_name (required)#

Name of the job

Type: string

enable_job#

Enable a job

Parameters

job_name (required)#

Name of the job

Type: string

get_build_number#

Retrieve job's build number

Parameters

job_name (required)#

Name of the job

Type: string

get_computer_details#

Retrieve computer details

Parameters

depth (required)#

Recursion depth in response model

Type: integer

get_config_for_job#

Retrieve job configuration

Parameters

job_name (required)#

Name of the job

Type: string

get_config_for_view#

Retrieve view configuration

Parameters

view_name (required)#

Name of the view

Type: string

get_item_in_queue#

Retrieve queued item details

Parameters

queue_item_number (required)#

Queue item number

Type: string

get_jenkins_details#

This operation has no parameters

get_job#

Retrieve job details

Parameters

job_name (required)#

Name of the job

Type: string

get_last_build_for_job#

Retrieve job's last build details

Parameters

job_name (required)#

Name of the job

Type: string

get_output_for_job_build#

Retrieve job's build progressive text output

Parameters

build_number (required)#

Build number

Type: string

job_name (required)#

Name of the job

Type: string

start (required)#

Starting point of progressive text output

Type: string

get_queue#

This operation has no parameters

get_timestamp_for_build#

Retrieve build's timestamp

Parameters

build_number (required)#

Build number

Type: string

job_name (required)#

Name of the job

Type: string

format#

Control the date format, which follows the SimpleDateFormat format pattern

Type: string

get_timestamp_for_last_build#

Retrieve last build's timestamp

Parameters

job_name (required)#

Name of the job

Type: string

format#

Control the date format, which follows the SimpleDateFormat format pattern

Type: string

get_view#

Retrieve view details

Parameters

view_name (required)#

Name of the view

Type: string

stop_job#

Stop a job

Parameters

job_name (required)#

Name of the job

Type: string

update_config_for_job#

Update job configuration

Parameters

job_name (required)#

Name of the job

Type: string

$body#

Job configuration in config.xml format

Type: object

{ }

update_config_for_view#

Update view configuration

Parameters

view_name (required)#

Name of the view

Type: string

$body#

View configuration in config.xml format

Type: object

{ }