Module "types/api"

Index

Interfaces

Type aliases

Type aliases

BuildResponse

BuildResponse: Build

Build info

property: {string} buildPath - The path to the build
example: GET : https://{jenkinsHost}/job/:buildPath/api/json

BuildsResponse

BuildsResponse: Builds

Builds info

property: {string} jobName - The path to the job
example: GET : https://{jenkinsHost}/job/:buildPath/api/json

JobResponse

JobResponse: Job

Job info

property: {string} jobName - The name of the job, or if in a folder, the path to the job, starting with the folder name. i.e. without the preceding "/job/"
example: GET : https://{jenkinsHost}/job/:jobName/api/json

JobsResponse

JobsResponse: Jobs

Jobs info

property: {string} folderName - Optional, the name of the folder in which to search for jobs
example: GET : https://{jenkinsHost}/:folderName/api/json?tree=jobs

UserResponse

UserResponse: User

User info

property: {string} username - A Jenkins user
example: GET : https://{jenkinsHost}/user/:username/api/json

Generated using TypeDoc