> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jenkins

> How to set up the Jenkins connector, plus the actions and events that are available.

![Jenkins](https://stackone-logos.com/api/jenkins/filled/svg)

Previewv0.2.0[See changelog](https://docs.stackone.com/connectors/jenkins/changelog.md)

[96 actions](#actions) · [5 events](#events) · 1 auth method

Developer Tools
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/jenkins/guides/connector-profile/api-token.md)
>
> Uses HTTP Basic authentication with a Jenkins username and that user's own API token. The connection reads with that use...

Optionally, configure receiving Events for Jenkins into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/jenkins/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/jenkins/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

96 actions

ActionDescription

List Builds`jenkins_list_builds`

List the builds of a job.

Get Build`jenkins_get_build`

Fetch full detail of a single build.

Get Build Console Output`jenkins_get_build_console_output`

Return the full plain-text console log of a build.

Get Build Progressive Text`jenkins_get_build_progressive_text`

Fetch console log text from a byte offset for incremental tailing.

Stop Build`jenkins_stop_build`

Request a graceful abort of a running build.

Delete Build`jenkins_delete_build`

Permanently delete a build record.

Submit Description`jenkins_submit_description`

Set the description text of a build.

Toggle Log Keep`jenkins_toggle_log_keep`

Toggle the keep-this-build-forever flag.

Get Build Test Report`jenkins_get_build_test_report`

Fetch the aggregated test report of a build.

Get Build Stages`jenkins_get_build_stages`

Describe a Pipeline run with its stages.

Get Build Environment Variables`jenkins_get_build_env_vars`

Fetch injected environment variables of a build.

Get Pending Input Actions`jenkins_get_pending_input_actions`

List input steps currently waiting on a Pipeline run.

Proceed Input`jenkins_proceed_input`

Approve a pending Pipeline input step that has no parameters.

Abort Input`jenkins_abort_input`

Reject (abort) a pending Pipeline input step.

Create Credentials`jenkins_create_credentials`

Create a credential in a domain from an XML body.

Delete Credential`jenkins_delete_credential`

Permanently remove a stored credential from a Jenkins credentials store and domain.

Get Credential`jenkins_get_credential`

Get the JSON representation of a single credential (metadata, not secrets).

Get Credential Config`jenkins_get_credential_config`

Fetch the XML configuration of a credential.

List Credential Domains`jenkins_list_credential_domains`

List the credential domains in a credentials store.

List Credentials`jenkins_list_credentials`

List credentials in a domain of a credentials store.

Update Credential`jenkins_update_credential`

Replace the XML configuration of an existing credential.

Create Domain`jenkins_create_domain`

Create a credentials domain in a store from a domain XML document.

Get Domain Config`jenkins_get_domain_config`

Read the XML definition of a credentials domain, including its name, description and specifications.

Update Domain Config`jenkins_update_domain_config`

Replace the XML definition of a credentials domain with a new document.

Delete Domain`jenkins_delete_domain`

Permanently remove a credentials domain and every credential stored in it.

Get Unified Credentials`jenkins_unified_get_me`

Get the current Jenkins connection's unified credentials and identity.

Get Current User`jenkins_get_current_user`

Get the raw identity of the connected Jenkins account.

List Unified Roles`jenkins_unified_list_roles`

List unified roles in Jenkins.

Get Unified Role`jenkins_unified_get_role`

Get a unified Jenkins role by ID.

List Unified Users`jenkins_unified_list_users`

List unified users in Jenkins.

Get Unified User`jenkins_unified_get_user`

Get a unified Jenkins user by ID.

List Jobs`jenkins_list_jobs`

List top-level jobs and folders.

Get Job`jenkins_get_job`

Get one job's details (builds, health, nextBuildNumber).

Get Job Config`jenkins_get_job_config`

Fetch the job config.xml.

Create Job`jenkins_create_job`

Create a job from a raw XML config.

Copy Job`jenkins_copy_job`

Copy an existing job within the same folder.

Update Job Config`jenkins_update_job_config`

Replace a job config.xml.

Delete Job`jenkins_delete_job`

Permanently delete a job.

Enable Job`jenkins_enable_job`

Turn a disabled Jenkins job back on so it can be triggered and scheduled again.

Disable Job`jenkins_disable_job`

Stop a Jenkins job from being built, by triggers or manually, until it is enabled again.

Rename Job`jenkins_rename_job`

Rename a job within its folder.

Build Job`jenkins_build_job`

Trigger a build of a non-parameterized job.

Build Job With Parameters`jenkins_build_job_with_parameters`

Trigger a parameterized build.

Wipe Out Workspace`jenkins_wipe_out_workspace`

Delete every file in the job workspace on the agents so the next build starts clean.

Set Next Build Number`jenkins_set_next_build_number`

Set next build number (requires Next Build Number plugin).

List Nodes`jenkins_list_nodes`

List all nodes (agents and built-in) with executor counts.

Get Node`jenkins_get_node`

Get a single node's details (executors, labels, offline state).

Get Node Config`jenkins_get_node_config`

Return a node's config.xml.

Create Node`jenkins_create_node`

Create a permanent (DumbSlave) agent via doCreateItem.

Update Node Config`jenkins_update_node_config`

Replace a node's config.xml.

Delete Node`jenkins_delete_node`

Permanently delete a node.

Toggle Offline`jenkins_toggle_offline`

Toggle a node offline/online.

Launch Agent`jenkins_launch_agent`

Relaunch a disconnected agent (Computer.doLaunchSlaveAgent).

Change Offline Cause`jenkins_change_offline_cause`

Update the reason shown on a node that is already temporarily offline.

List Plugins`jenkins_list_plugins`

List installed plugins with version, enabled, hasUpdate, dependencies, url, active, bundled.

Install Necessary Plugins`jenkins_install_necessary_plugins`

Install plugins named in a posted XML document.

Uninstall Plugin`jenkins_uninstall_plugin`

Uninstall an installed plugin by short name.

Get Update Center`jenkins_get_update_center`

Get Update Center state: sites, available and pending updates, and install jobs.

List Queue Items`jenkins_list_queue_items`

List all items waiting in the Jenkins build queue.

Get Queue Item`jenkins_get_queue_item`

Fetch one queue item by its queue id.

Cancel Queue Item`jenkins_cancel_queue_item`

Remove a pending item from the build queue by id.

Get All Roles`jenkins_get_all_roles`

List all roles of one role type with their assigned users/groups.

Get Role`jenkins_get_role`

Get one role permissions, pattern, assigned SIDs and template.

Get Role Assignments`jenkins_get_role_assignments`

List every SID (user/group) with the roles assigned to it for a role type.

Add Role`jenkins_add_role`

Create (or overwrite) a role of a given type.

Remove Roles`jenkins_remove_roles`

Delete one or more roles of a type.

Assign User Role`jenkins_assign_user_role`

Grant a Role Strategy role to a Jenkins user by adding their user id to it.

Assign Group Role`jenkins_assign_group_role`

Assign a group to a role.

Unassign User Role`jenkins_unassign_user_role`

Remove a user from a role.

Unassign Group Role`jenkins_unassign_group_role`

Remove a group from a role.

Get Matching Jobs`jenkins_get_matching_jobs`

Preview which items a project role pattern matches.

Get Matching Agents`jenkins_get_matching_agents`

Preview which agents a slave role pattern matches.

Delete Role Strategy User`jenkins_delete_role_strategy_user`

Remove a user from every role of one role type.

Delete Role Strategy Group`jenkins_delete_role_strategy_group`

Remove a group from every role of one role type.

Get Template`jenkins_get_template`

Get one project permission template with its permission ids.

Add Template`jenkins_add_template`

Create a project permission template.

Remove Templates`jenkins_remove_templates`

Remove project permission templates.

Cancel Quiet Down`jenkins_cancel_quiet_down`

Cancel quiet-down mode so Jenkins starts builds again.

Get Load Statistics`jenkins_get_load_statistics`

Get executor and queue load time series for the whole controller.

Get Server Info`jenkins_get_server_info`

Get top-level Jenkins controller info.

Quiet Down`jenkins_quiet_down`

Put Jenkins into quiet-down mode so no new builds start.

Restart`jenkins_restart`

Restart Jenkins immediately without waiting for builds.

Safe Restart`jenkins_safe_restart`

Queue a safe restart: running builds finish first, no new builds start.

Validate Jenkinsfile`jenkins_validate_jenkinsfile`

Lint a Declarative Jenkinsfile.

List People`jenkins_list_people`

List people (users) known to Jenkins via the asynchPeople view.

Get User`jenkins_get_user`

Get one Jenkins user by id.

Create Account By Admin`jenkins_create_account_by_admin`

Create a Jenkins user account as an admin (HudsonPrivateSecurityRealm only).

Delete User`jenkins_delete_user`

Delete a Jenkins user record.

List Views`jenkins_list_views`

List all views on the controller.

Get View`jenkins_get_view`

Get a view with its jobs.

Get View Config`jenkins_get_view_config`

Read the config.xml definition of a view, including its job filters and columns.

Create View`jenkins_create_view`

Create a view from config XML.

Update View Config`jenkins_update_view_config`

Replace the config.xml definition of a view with a new XML document.

Delete View`jenkins_delete_view`

Permanently remove a view. The jobs it lists are not affected.

Add Job To View`jenkins_add_job_to_view`

Add a job to a list view.

Remove Job From View`jenkins_remove_job_from_view`

Remove a job from a list view.

## Events

Tags

Select all
|
Clear

Builds

Webhook

No tags found

5 events

EventDescriptionTags

Webhook Verification`jenkins_webhook_verification`

Acknowledges a manual Jenkins Notification plugin call sent with phase NONE.

Webhook

Build Queued`jenkins_webhook_build_queued`

Processes Jenkins build QUEUED notifications from the Notification plugin.

WebhookBuilds

Build Started`jenkins_webhook_build_started`

Processes Jenkins build STARTED notifications from the Notification plugin.

WebhookBuilds

Build Completed`jenkins_webhook_build_completed`

Processes Jenkins build COMPLETED notifications from the Notification plugin.

WebhookBuilds

Build Finalized`jenkins_webhook_build_finalized`

Processes Jenkins build FINALIZED notifications from the Notification plugin.

WebhookBuilds


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.