Skip to main content
Jenkins
Previewv0.2.0
96 actions · 5 events · 1 auth method
Developer ToolsIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Token · Connector Profile

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.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Token · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

96 actions
Action
Description
List Builds
List the builds of a job.
Get Build
Fetch full detail of a single build.
Get Build Console Output
Return the full plain-text console log of a build.
Get Build Progressive Text
Fetch console log text from a byte offset for incremental tailing.
Stop Build
Request a graceful abort of a running build.
Delete Build
Permanently delete a build record.
Submit Description
Set the description text of a build.
Toggle Log Keep
Toggle the keep-this-build-forever flag.
Get Build Test Report
Fetch the aggregated test report of a build.
Get Build Stages
Describe a Pipeline run with its stages.
Get Build Environment Variables
Fetch injected environment variables of a build.
Get Pending Input Actions
List input steps currently waiting on a Pipeline run.
Proceed Input
Approve a pending Pipeline input step that has no parameters.
Abort Input
Reject (abort) a pending Pipeline input step.
Create Credentials
Create a credential in a domain from an XML body.
Delete Credential
Permanently remove a stored credential from a Jenkins credentials store and domain.
Get Credential
Get the JSON representation of a single credential (metadata, not secrets).
Get Credential Config
Fetch the XML configuration of a credential.
List Credential Domains
List the credential domains in a credentials store.
List Credentials
List credentials in a domain of a credentials store.
Update Credential
Replace the XML configuration of an existing credential.
Create Domain
Create a credentials domain in a store from a domain XML document.
Get Domain Config
Read the XML definition of a credentials domain, including its name, description and specifications.
Update Domain Config
Replace the XML definition of a credentials domain with a new document.
Delete Domain
Permanently remove a credentials domain and every credential stored in it.
Get Unified Credentials
Get the current Jenkins connection’s unified credentials and identity.
Get Current User
Get the raw identity of the connected Jenkins account.
List Unified Roles
List unified roles in Jenkins.
Get Unified Role
Get a unified Jenkins role by ID.
List Unified Users
List unified users in Jenkins.
Get Unified User
Get a unified Jenkins user by ID.
List Jobs
List top-level jobs and folders.
Get Job
Get one job’s details (builds, health, nextBuildNumber).
Get Job Config
Fetch the job config.xml.
Create Job
Create a job from a raw XML config.
Copy Job
Copy an existing job within the same folder.
Update Job Config
Replace a job config.xml.
Delete Job
Permanently delete a job.
Enable Job
Turn a disabled Jenkins job back on so it can be triggered and scheduled again.
Disable Job
Stop a Jenkins job from being built, by triggers or manually, until it is enabled again.
Rename Job
Rename a job within its folder.
Build Job
Trigger a build of a non-parameterized job.
Build Job With Parameters
Trigger a parameterized build.
Wipe Out Workspace
Delete every file in the job workspace on the agents so the next build starts clean.
Set Next Build Number
Set next build number (requires Next Build Number plugin).
List Nodes
List all nodes (agents and built-in) with executor counts.
Get Node
Get a single node’s details (executors, labels, offline state).
Get Node Config
Return a node’s config.xml.
Create Node
Create a permanent (DumbSlave) agent via doCreateItem.
Update Node Config
Replace a node’s config.xml.
Delete Node
Permanently delete a node.
Toggle Offline
Toggle a node offline/online.
Launch Agent
Relaunch a disconnected agent (Computer.doLaunchSlaveAgent).
Change Offline Cause
Update the reason shown on a node that is already temporarily offline.
List Plugins
List installed plugins with version, enabled, hasUpdate, dependencies, url, active, bundled.
Install Necessary Plugins
Install plugins named in a posted XML document.
Uninstall Plugin
Uninstall an installed plugin by short name.
Get Update Center
Get Update Center state: sites, available and pending updates, and install jobs.
List Queue Items
List all items waiting in the Jenkins build queue.
Get Queue Item
Fetch one queue item by its queue id.
Cancel Queue Item
Remove a pending item from the build queue by id.
Get All Roles
List all roles of one role type with their assigned users/groups.
Get Role
Get one role permissions, pattern, assigned SIDs and template.
Get Role Assignments
List every SID (user/group) with the roles assigned to it for a role type.
Add Role
Create (or overwrite) a role of a given type.
Remove Roles
Delete one or more roles of a type.
Assign User Role
Grant a Role Strategy role to a Jenkins user by adding their user id to it.
Assign Group Role
Assign a group to a role.
Unassign User Role
Remove a user from a role.
Unassign Group Role
Remove a group from a role.
Get Matching Jobs
Preview which items a project role pattern matches.
Get Matching Agents
Preview which agents a slave role pattern matches.
Delete Role Strategy User
Remove a user from every role of one role type.
Delete Role Strategy Group
Remove a group from every role of one role type.
Get Template
Get one project permission template with its permission ids.
Add Template
Create a project permission template.
Remove Templates
Remove project permission templates.
Cancel Quiet Down
Cancel quiet-down mode so Jenkins starts builds again.
Get Load Statistics
Get executor and queue load time series for the whole controller.
Get Server Info
Get top-level Jenkins controller info.
Quiet Down
Put Jenkins into quiet-down mode so no new builds start.
Restart
Restart Jenkins immediately without waiting for builds.
Safe Restart
Queue a safe restart: running builds finish first, no new builds start.
Validate Jenkinsfile
Lint a Declarative Jenkinsfile.
List People
List people (users) known to Jenkins via the asynchPeople view.
Get User
Get one Jenkins user by id.
Create Account By Admin
Create a Jenkins user account as an admin (HudsonPrivateSecurityRealm only).
Delete User
Delete a Jenkins user record.
List Views
List all views on the controller.
Get View
Get a view with its jobs.
Get View Config
Read the config.xml definition of a view, including its job filters and columns.
Create View
Create a view from config XML.
Update View Config
Replace the config.xml definition of a view with a new XML document.
Delete View
Permanently remove a view. The jobs it lists are not affected.
Add Job To View
Add a job to a list view.
Remove Job From View
Remove a job from a list view.

Events

|
5 events
Event
Description
Tags
Webhook Verification
Acknowledges a manual Jenkins Notification plugin call sent with phase NONE.
Webhook
Build Queued
Processes Jenkins build QUEUED notifications from the Notification plugin.
WebhookBuilds
Build Started
Processes Jenkins build STARTED notifications from the Notification plugin.
WebhookBuilds
Build Completed
Processes Jenkins build COMPLETED notifications from the Notification plugin.
WebhookBuilds
Build Finalized
Processes Jenkins build FINALIZED notifications from the Notification plugin.
WebhookBuilds