Jenkins
App Vendor: Jenkins
App Category: IT Services
Connector Version: 1.0.0
API Version: 1.0.0
About App
Jenkins is an open source automation server that enables developers around the world to reliably build, test, and deploy their software.
The Jenkins app is configured with the Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Get Job Details | This action retrieves details of a job. |
List Build Queue | This action retrieves a list of jobs in the build queue. |
Trigger Job without Params | This action triggers a job without parameters. |
Trigger Job with Params | This action triggers a job with parameters |
Configuration Parameters
The following configuration parameters are required for the Jenkins app to communicate with the Jenkins enterprise application. The parameters can be configured by creating instances in Jenkins app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the Jenkins base URL. Example: "http://54.152.11.222:8080/" | Text | Required | |
Username | Enter the username to connect to Jenkins application. Example: "johndoe" | Text | Required | |
API Key | Enter the API key to connect to Jenkins application. Example: aT1xxxx5rzs | Password | Required |
Action: Get Job Details
This action retrieves details of a job.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Job Name | Enter a job name to retrieve its details. Example: "aws-cloud-job" | Text | Required |
Example Request
[
{
“job_name": "aws-cloud-job"
}
]Action: List Build Queue
This action retrieves a list of jobs in the build queue.
Action Input Parameters
This action does not require any input parameters.
Action: Trigger Job Without Params
This action triggers a job without parameters.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Job Name | Enter the job name to trigger. Example: "aws-cloud-job" | Text | Required |
Example Request
[
{
“job_name": "aws-cloud-job"
}
]Action: Trigger Job with Params
This action triggers a job with parameters.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Job Name | Enter the job name to trigger. Example: "aws-cloud-job" | Text | Required | |
Params | Enter the parameters to be passed to the job. Example: {"param1": "value1", "param2": "value2"} | Key Value | Required |
Example Request
[
{
"job_name": "aws-cloud-job",
"params": {
"name": "message",
"value": "HelloJenkins"
}
}
]