Appearance
Jenkins
Manage jobs, trigger builds, and monitor queues with the Jenkins API.
| Detail | Value |
|---|---|
| Category | CI/CD |
| Base URL | https://jenkins.example.com |
| Authentication | Bearer Token |
| Endpoints | 8 |
| Connector key | jenkins |
Using Jenkins in a workflow
- Go to Connections and click New Connection.
- Pick Jenkins from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
GET /api/json | Get Jenkins info |
GET /job/{name}/api/json | Get job details |
POST /job/{name}/build | Trigger a build |
POST /job/{name}/buildWithParameters | Trigger parameterized build |
GET /job/{name}/{number}/api/json | Get build details |
GET /job/{name}/{number}/consoleText | Get build console output |
POST /job/{name}/{number}/stop | Stop a build |
GET /queue/api/json | Get build queue |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
GET /api/json
Get Jenkins info
| Detail | Value |
|---|---|
| Operation ID | cicd.getJenkinsInfo |
| Method | GET |
| Path | /api/json |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.getJenkinsInfo. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
GET /job/{name}/api/json
Get job details
| Detail | Value |
|---|---|
| Operation ID | cicd.getJob |
| Method | GET |
| Path | /job/{name}/api/json |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.getJob. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
POST /job/{name}/build
Trigger a build
| Detail | Value |
|---|---|
| Operation ID | cicd.buildJob |
| Method | POST |
| Path | /job/{name}/build |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.buildJob. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
POST /job/{name}/buildWithParameters
Trigger parameterized build
| Detail | Value |
|---|---|
| Operation ID | cicd.buildJobWithParameters |
| Method | POST |
| Path | /job/{name}/buildWithParameters |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.buildJobWithParameters. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
GET /job/{name}/{number}/api/json
Get build details
| Detail | Value |
|---|---|
| Operation ID | cicd.getBuild |
| Method | GET |
| Path | /job/{name}/{number}/api/json |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.getBuild. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
GET /job/{name}/{number}/consoleText
Get build console output
| Detail | Value |
|---|---|
| Operation ID | cicd.getBuildConsoleOutput |
| Method | GET |
| Path | /job/{name}/{number}/consoleText |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.getBuildConsoleOutput. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
POST /job/{name}/{number}/stop
Stop a build
| Detail | Value |
|---|---|
| Operation ID | cicd.stopBuild |
| Method | POST |
| Path | /job/{name}/{number}/stop |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.stopBuild. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.
GET /queue/api/json
Get build queue
| Detail | Value |
|---|---|
| Operation ID | cicd.getQueue |
| Method | GET |
| Path | /queue/api/json |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Jenkins connection from the Connection dropdown.
- In the Operation dropdown, select
cicd.getQueue. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Jenkins API reference.