Swaggy Jenkins

Version: 3.4.1-pre.0

Jenkins API clients generated from Swagger / Open API specification

Schemes:

Summary

Tag: remoteAccess

Operation	Description
HEAD /api/json
GET /api/json
GET /computer/api/json
POST /createItem
POST /createView
GET /job/{name}/api/json
POST /job/{name}/build
GET /job/{name}/config.xml
POST /job/{name}/config.xml
POST /job/{name}/doDelete
POST /job/{name}/disable
POST /job/{name}/enable
GET /job/{name}/lastBuild/api/json
POST /job/{name}/lastBuild/stop
GET /job/{name}/{number}/logText/progressiveText
GET /queue/api/json
GET /queue/item/{number}/api/json
GET /view/{name}/api/json
GET /view/{name}/config.xml
POST /view/{name}/config.xml

Tag: base

Operation	Description
GET /crumbIssuer/api/json

Tag: blueOcean

Operation	Description
GET /jwt-auth/token
GET /jwt-auth/jwks/{key}
GET /blue/rest/classes/
GET /blue/rest/classes/{class}
GET /blue/rest/search/
GET /blue/rest/organizations/
GET /blue/rest/organizations/{organization}
GET /blue/rest/organizations/{organization}/pipelines/
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/activities
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run}
GET /blue/rest/organizations/{organization}/pipelines/{folder}/
GET /blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline}
PUT /blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue
DELETE /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue/{queue}
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs
POST /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log
GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log
POST /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay
PUT /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop
GET /blue/rest/organizations/{organization}/scm/{scm}
GET /blue/rest/organizations/{organization}/scm/{scm}/organizations
GET /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories
GET /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository}
GET /blue/rest/organizations/{organization}/user/
GET /blue/rest/organizations/{organization}/users/
GET /blue/rest/organizations/{organization}/users/{user}
GET /blue/rest/users/{user}/favorites

Paths

GET /api/json

Tags: remoteAccess

Retrieve Jenkins details

200 OK: Successfully retrieved Jenkins details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

HEAD /api/json

Tags: remoteAccess

Retrieve Jenkins headers

200 OK

Successfully retrieved Jenkins headers


x-jenkins	Jenkins version number	object

401 Unauthorized #/components/responses/unauthorized

Authentication failed - incorrect username and/or password

403 Forbidden #/components/responses/forbidden

Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/classes/

Tags: blueOcean

Get classes details


q	Query string containing an array of class names	query	object

200 OK: Successfully retrieved search result
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/classes/{class}

Tags: blueOcean

Get a list of class names supported by a given class


class	Name of the class	path	object	#/components/parameters/className

200 OK: Successfully retrieved class names
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/

Tags: blueOcean

Retrieve all organizations details

200 OK: Successfully retrieved pipelines details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}

Tags: blueOcean

Retrieve organization details


organization	Name of the organization	path	object	#/components/parameters/orgName

200 OK: Successfully retrieved pipeline details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/pipelineNotFound: Pipeline cannot be found on Jenkins instance


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/

Tags: blueOcean

Retrieve all pipelines details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName

200 OK: Successfully retrieved pipelines details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{folder}/

Tags: blueOcean

Retrieve pipeline folder for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
folder	Name of the folder	path	object	#/components/parameters/folderName

200 OK: Successfully retrieved folder details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{folder}/pipelines/{pipeline}

Tags: blueOcean

Retrieve pipeline details for an organization folder


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
folder	Name of the folder	path	object	#/components/parameters/folderName

200 OK: Successfully retrieved pipeline details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}

Tags: blueOcean

Retrieve pipeline details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully retrieved pipeline details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/pipelineNotFound: Pipeline cannot be found on Jenkins instance


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/activities

Tags: blueOcean

Retrieve all activities details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully retrieved all activities details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches

Tags: blueOcean

Retrieve all branches details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully retrieved all branches details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/

Tags: blueOcean

Retrieve branch details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
branch	Name of the branch	path	object	#/components/parameters/branchName

200 OK: Successfully retrieved branch details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/branches/{branch}/runs/{run}

Tags: blueOcean

Retrieve branch run details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
branch	Name of the branch	path	object	#/components/parameters/branchName
run	Name of the run	path	object	#/components/parameters/runName

200 OK: Successfully retrieved run details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

PUT /blue/rest/organizations/{organization}/pipelines/{pipeline}/favorite

Tags: blueOcean

Favorite/unfavorite a pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully favorited/unfavorited a pipeline
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue

Tags: blueOcean

Retrieve queue details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully retrieved queue details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

DELETE /blue/rest/organizations/{organization}/pipelines/{pipeline}/queue/{queue}

Tags: blueOcean

Delete queue item from an organization pipeline queue


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
queue	Name of the queue item	path	object	#/components/parameters/queueItemName

200 OK: Successfully deleted queue item
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs

Tags: blueOcean

Retrieve all runs details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully retrieved runs details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

POST /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs

Tags: blueOcean

Start a build for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName

200 OK: Successfully started a build
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}

Tags: blueOcean

Retrieve run details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName

200 OK: Successfully retrieved run details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/log

Tags: blueOcean

Get log for a pipeline run


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
start	Start position of the log	query	object
download	Set to true in order to download the file, otherwise it's passed as a response body	query	object

200 OK: Successfully retrieved pipeline run log
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes

Tags: blueOcean

Retrieve run nodes details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName

200 OK: Successfully retrieved run nodes details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}

Tags: blueOcean

Retrieve run node details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
node	Name of the node	path	object	#/components/parameters/nodeName

200 OK: Successfully retrieved run node details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps

Tags: blueOcean

Retrieve run node steps details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
node	Name of the node	path	object	#/components/parameters/nodeName

200 OK: Successfully retrieved run node steps details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}

Tags: blueOcean

Retrieve run node details for an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
node	Name of the node	path	object	#/components/parameters/nodeName
step	Name of the step	path	object	#/components/parameters/stepName

200 OK: Successfully retrieved run node step details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/nodes/{node}/steps/{step}/log

Tags: blueOcean

Get log for a pipeline run node step


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
node	Name of the node	path	object	#/components/parameters/nodeName
step	Name of the step	path	object	#/components/parameters/stepName

200 OK: Successfully retrieved pipeline run node step log
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

POST /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/replay

Tags: blueOcean

Replay an organization pipeline run


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName

200 OK: Successfully replayed a pipeline run
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

PUT /blue/rest/organizations/{organization}/pipelines/{pipeline}/runs/{run}/stop

Tags: blueOcean

Stop a build of an organization pipeline


organization	Name of the organization	path	object	#/components/parameters/orgName
pipeline	Name of the pipeline	path	object	#/components/parameters/pipelineName
run	Name of the run	path	object	#/components/parameters/runName
blocking	Set to true to make blocking stop, default: false	query	object
timeOutInSecs	Timeout in seconds, default: 10 seconds	query	object

200 OK: Successfully stopped a build
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/scm/{scm}

Tags: blueOcean

Retrieve SCM details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
scm	Name of SCM	path	object	#/components/parameters/scmName

200 OK: Successfully retrieved SCM details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/scm/{scm}/organizations

Tags: blueOcean

Retrieve SCM organizations details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
scm	Name of SCM	path	object	#/components/parameters/scmName
credentialId	Credential ID	query	object

200 OK: Successfully retrieved SCM organizations details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories

Tags: blueOcean

Retrieve SCM organization repositories details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
scm	Name of SCM	path	object	#/components/parameters/scmName
scmOrganisation	Name of the SCM organization	path	object	#/components/parameters/scmOrgName
credentialId	Credential ID	query	object
pageSize	Number of items in a page	query	object
pageNumber	Page number	query	object

200 OK: Successfully retrieved SCM organization repositories details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/scm/{scm}/organizations/{scmOrganisation}/repositories/{repository}

Tags: blueOcean

Retrieve SCM organization repository details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
scm	Name of SCM	path	object	#/components/parameters/scmName
scmOrganisation	Name of the SCM organization	path	object	#/components/parameters/scmOrgName
repository	Name of the SCM repository	path	object	#/components/parameters/repositoryName
credentialId	Credential ID	query	object

200 OK: Successfully retrieved SCM organizations details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/user/

Tags: blueOcean

Retrieve authenticated user details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName

200 OK: Successfully retrieved authenticated user details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/users/

Tags: blueOcean

Retrieve users details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName

200 OK: Successfully retrieved users details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/organizations/{organization}/users/{user}

Tags: blueOcean

Retrieve user details for an organization


organization	Name of the organization	path	object	#/components/parameters/orgName
user	Name of the user	path	object	#/components/parameters/userName

200 OK: Successfully retrieved users details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/search/

Tags: blueOcean

Search for any resource details


q	Query string	query	object

200 OK: Successfully retrieved search result
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /blue/rest/users/{user}/favorites

Tags: blueOcean

Retrieve user favorites details for an organization


user	Name of the user	path	object	#/components/parameters/userName

200 OK: Successfully retrieved users favorites details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /computer/api/json

Tags: remoteAccess

Retrieve computer details


depth	Recursion depth in response model	query	object

200 OK: Successfully retrieved computer details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

POST /createItem

Tags: remoteAccess

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


name	Name of the new job	query	object
from	Existing job to copy from	query	object
mode	Set to 'copy' for copying an existing job	query	object
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb
Content-Type	Content type header application/xml	header	object

200 OK: Successfully created a new job
400 Bad Request #/components/responses/errorInHtml: An error has occurred - error message is embedded inside the HTML response
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

POST /createView

Tags: remoteAccess

Create a new view using view configuration


name	Name of the new view	query	object
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb
Content-Type	Content type header application/xml	header	object

200 OK: Successfully created the view
400 Bad Request #/components/responses/errorInHtml: An error has occurred - error message is embedded inside the HTML response
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /crumbIssuer/api/json

Tags: base

Retrieve CSRF protection token

200 OK: Successfully retrieved CSRF protection token
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /job/{name}/api/json

Tags: remoteAccess

Retrieve job details


name	Name of the job	path	object	#/components/parameters/jobName

200 OK: Successfully retrieved job details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/build

Tags: remoteAccess

Build a job


name	Name of the job	path	object	#/components/parameters/jobName
json		query	object
token		query	object
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully built the job (backward compatibility for older versions of Jenkins)
201 Created: Successfully built the job
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

GET /job/{name}/config.xml

Tags: remoteAccess

Retrieve job configuration


name	Name of the job	path	object	#/components/parameters/jobName

200 OK: Successfully retrieved job configuration in config.xml format
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/config.xml

Tags: remoteAccess

Update job configuration


name	Name of the job	path	object	#/components/parameters/jobName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully retrieved job configuration in config.xml format
400 Bad Request #/components/responses/errorInHtml: An error has occurred - error message is embedded inside the HTML response
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/disable

Tags: remoteAccess

Disable a job


name	Name of the job	path	object	#/components/parameters/jobName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully disabled the job
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/doDelete

Tags: remoteAccess

Delete a job


name	Name of the job	path	object	#/components/parameters/jobName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully deleted the job
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/enable

Tags: remoteAccess

Enable a job


name	Name of the job	path	object	#/components/parameters/jobName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully enabled the job
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

GET /job/{name}/lastBuild/api/json

Tags: remoteAccess

Retrieve job's last build details


name	Name of the job	path	object	#/components/parameters/jobName

200 OK: Successfully retrieved job's last build details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

POST /job/{name}/lastBuild/stop

Tags: remoteAccess

Stop a job


name	Name of the job	path	object	#/components/parameters/jobName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully stopped the job
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

GET /job/{name}/{number}/logText/progressiveText

Tags: remoteAccess

Retrieve job's build progressive text output


name	Name of the job	path	object	#/components/parameters/jobName
number	Build number	path	object
start	Starting point of progressive text output	query	object

200 OK: Successfully retrieved job's build progressive text output
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/jobNotFound: Job cannot be found on Jenkins instance


jenkins_auth

GET /jwt-auth/jwks/{key}

Tags: blueOcean

Retrieve JSON Web Key


key	Key ID received as part of JWT header field kid	path	object

200 OK: Successfully retrieved JWT token
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password

GET /jwt-auth/token

Tags: blueOcean

Retrieve JSON Web Token


expiryTimeInMins	Token expiry time in minutes, default: 30 minutes	query	object
maxExpiryTimeInMins	Maximum token expiry time in minutes, default: 480 minutes	query	object

200 OK: Successfully retrieved JWT token
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password

GET /queue/api/json

Tags: remoteAccess

Retrieve queue details

200 OK: Successfully retrieved queue details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /queue/item/{number}/api/json

Tags: remoteAccess

Retrieve queued item details


number	Queue number	path	object

200 OK: Successfully retrieved queued item details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password


jenkins_auth

GET /view/{name}/api/json

Tags: remoteAccess

Retrieve view details


name	Name of the view	path	object	#/components/parameters/viewName

200 OK: Successfully retrieved view details
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/viewNotFound: View cannot be found on Jenkins instance


jenkins_auth

GET /view/{name}/config.xml

Tags: remoteAccess

Retrieve view configuration


name	Name of the view	path	object	#/components/parameters/viewName

200 OK: Successfully retrieved view configuration in config.xml format
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/viewNotFound: View cannot be found on Jenkins instance


jenkins_auth

POST /view/{name}/config.xml

Tags: remoteAccess

Update view configuration


name	Name of the view	path	object	#/components/parameters/viewName
Jenkins-Crumb	CSRF protection token	header	object	#/components/parameters/crumb

200 OK: Successfully updated view configuration
400 Bad Request #/components/responses/errorInHtml: An error has occurred - error message is embedded inside the HTML response
401 Unauthorized #/components/responses/unauthorized: Authentication failed - incorrect username and/or password
403 Forbidden #/components/responses/forbidden: Jenkins requires authentication - please set username and password
404 Not Found #/components/responses/viewNotFound: View cannot be found on Jenkins instance


jenkins_auth