CloudBees CD/RO Perl API Commands Overview

deleteAccessToken

Delete an existing access token.

getAccessTokens

Returns access tokens for service account with associated trigger details.

breakAclInheritance

Breaks ACL (access control list) inheritance at the given object.

checkAccess

Checks ACL (access control list) permission information associated with an object (including inherited ACLs) for the current user.

createAclEntry

Creates an ACE (access control list entry) on an object for a given principal.

deleteAclEntry

Deletes an ACE on an object for a given principal.

getAccess

Retrieves ACL information associated with an object, including inherited ACLs.

getAclEntry

Retrieves an ACE on an object for a given principal.

modifyAclEntry

Modifies an ACE on an object for a given principal.

restoreAclInheritance

Restores ACL inheritance at the given object.

createApplication

Creates a new traditional or microservice application for the specified project.

deleteApplication

Deletes a traditional or microservice application.

getApplication

Retrieves a traditional or microservice application by name.

getApplications

Retrieves a traditional or microservice applications, based on type, in a project.

modifyApplication

Modifies an existing traditional or microservice application.

createApplicationTier

Creates a new application tier in the application.

deleteApplicationTier

Deletes a tier from an application.

getApplicationTier

Retrieves an application tier by name

getApplicationTiers

Retrieves all application tiers in an application

getApplicationTiersInComponent

Retrieves all application tiers that are used by the given component

modifyApplicationTier

Modifies an existing tier in the application.

addDependentsToArtifactVersion

Adds an artifact version query to an existing artifact. Dependent artifact versions are retrieved when the parent artifact version is retrieved.

cleanupArtifactCache

Deletes stale artifact versions from an artifact cache. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.

cleanupRepository

Deletes stale artifact versions from the repository backing-store. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.

createArtifact

Creates a new artifact.

createArtifactVersion

Creates a new artifact version.

createRepository

Creates a repository for one or more artifacts.

deleteArtifact

Deletes an existing artifact element and all artifact versions.

deleteArtifactVersion

Deletes artifact version metadata from the CloudBees CD/RO database. (This API call does not delete or remove artifacts stored on the repository machine.)

deleteRepository

Deletes artifact repository metadata from the CloudBees CD/RO database. (This API call does not delete or remove artifacts stored on the repository machine.)

findArtifactVersions

This command returns the most current artifact version that matches the filter criteria and its dependent artifact versions. This API implicitly searches for artifact versions in the "available" state, and if run in a job step, registers the step as a retriever for the returned artifact versions. Use the Perl API for the findArtifactVersions command.

getArtifact

Retrieves an artifact by its name.

getArtifacts

Retrieves all artifacts in the system.

getArtifactVersion

Retrieves an artifact version by its name.

getArtifactVersions

Retrieves all artifact versions in the system, filtered by artifact name, retriever job ID, and/or retriever job step ID.

getManifest

Retrieves the manifest for a specified artifact version, which includes a list of files and directories in the artifact version, plus its checksum file.

getRepositories

Retrieves all artifact repository objects known to the CloudBees CD/RO server.

getRepository

Retrieves an artifact repository by its name.

getRetrievedArtifacts

Retrieves artifacts during a job.

modifyArtifact

Modifies an existing artifact.

modifyArtifactVersion

Modifies an existing artifact version.

modifyRepository

Modifies an existing artifact repository.

moveRepository

Moves an artifact repository in front of another, specified repository or to the end of the list.

publishArtifactVersion

Publishes an artifact version to an artifact repository.

removeDependentsFromArtifactVersion

Removes a list of dependent artifact versions from an existing artifact version.

resolveRoute

Resolves the network route to an artifact repository.

retrieveArtifactVersions

Retrieves the most recent artifact version, including its dependents, from an artifact repository.

updateArtifactVersion

Updates an artifact version by adding or replacing one or more files in the existing file and publishes the result as a new artifact version to an artifact repository.

createCatalog

Creates a new catalog.

createCatalogItem

Creates a new catalog item in a catalog.

deleteCatalog

Deletes a catalog.

deleteCatalogItem

Deletes a catalog item.

getCatalog

Retrieves a catalog by name.

getCatalogItem

Retrieves a catalog item by name.

getCatalogItems

Retrieves all catalog items for catalog.

getCatalogs

Retrieves all catalogs in a project.

modifyCatalog

Modifies a catalog.

modifyCatalogItem

Modifies an existing catalog item.

runCatalogItem

Run a catalog item.

getDeploymentHistoryItems

Retrieves all the deployment history items for a specific environment.

getEntityChange

Retrieves the entity changes.

getEntityChangeDetails

Retrieves the differences between entities.

pruneChangeHistory

Prunes obsolete-for-days data from the Change History tables.

revert

Reverts the state of the object to a previous state.

searchEntityChange

Searches for entity changes.

createCIBuildDetail

Creates a new CIBuildDetail object.

deleteCIBuildDetail

Deletes a new CIBuildDetail object.

getCIBuildDetail

Retrieves the specified CIBuildDetail object.

getCIBuildDetails

Retrieves all CIBuildDetail objects.

modifyCIBuildDetail

Modifies an existing CIBuildDetail object.

setCIBuildDetail

A wrapper for create/modifyCIBuildDetail. It abstracts the logic for whether the build data needs to be created or, when the object already exists, updated.

createCIConfiguration

Creates a new CIConfiguration object.

deleteCIConfiguration

Deletes a new CIConfiguration object.

getCIConfiguration

Retrieves the specified CIConfiguration object.

getCIConfigurations

Retrieves all CIConfiguration objects.

modifyCIConfiguration

Modifies an existing CIConfiguration object.

getCIJob

Returns details for the specified CloudBees CI job

getCIJobs

Returns details for the specified CloudBees CI jobs

getCIJobparams

Returns the parameters for the specified CloudBees CI job.

addComponentToApplicationTier

Adds the specified component to the specified application tier.

copyComponent

Creates a new component based on an existing one.

createComponent

Creates a new component for a project.

deleteComponent

Deletes a component.

getComponent

Retrieves a component by name

getComponents

Retrieves all components in a project

getComponentsinApplicationTier

Retrieves the list of components in an application tier.

modifyComponent

Modifies an existing component.

removeComponentFromApplicationTier

Removes the specified component from an application tier.

attachCredential

Attaches a credential to an object.

createCredential

Creates a new credential for a project.

deleteCredential

Deletes a credential.

detachCredential

Detaches a credential from an object.

getCredential

Finds a credential by name.

getCredentials

Retrieves all credentials in a project.

getFullCredential

Finds a credential by name, including password, from within a running step.

modifyCredential

Modifies an existing credential.

createCredentialProvider

Creates a new credential for a project.

deleteCredentialProvider

Deletes a credential.

getCredentialProvider

Finds a credential by name.

getCredentialProviders

Retrieves all credentials in a project.

modifyCredentialProvider

Modifies an existing credential.

createSearchFilter

Creates a custom filter.

deleteSearchFilter

Deletes a custom filter.

getSearchFilter

Retrieves a custom filter by name.

getSearchFilters

Retrieves all custom filters

modifySearchFilter

Modifies an existing custom filter

getDatabaseConfiguration

Retrieves the current database configuration.

setDatabaseConfiguration

Sets the database configuration on the server. If the server is in bootstrap mode, these changes take effect immediately and the server attempts to start. If the server is running, these changes have no effect until the server is restarted.

validateDatabase

Performs consistency checks on the database.

Data Retention Policy Commands

createDataRetentionPolicy

Creates a new DataRetentionPolicy object.

deleteDataRetentionPolicy

Deletes the specified data retention policy.

getDataRetentionPolicy

Retrieves the specified dataRetentionPolicy object.

getDataRetentionPolicys

Retrieves all dataRetentionPolicy objects in the system.

modifyDataRetentionPolicy

Modifies the specified dataRetentionPolicy object.

Archive Connector Commands

createArchiveConnector

Creates a new archiveConnector object.

deleteArchiveConnector

Deletes the specified archiveConnector object.

getArchiveConnector

Retrieves the specified archiveConnector object.

getDataRetentionPolicyCategories

Retrieves all archiveConnector objects.

modifyArchiveConnector

Modifies the specified archiveConnector object.

Dashboard Commands

createDashboard

Creates a dashboard.

createDashboardColumn

Creates a dashboard column in a Command Center type of dashboard .

deleteDashboard

Deletes the specified dashboard.

deleteDashboardColumn

Deletes a dashboard column from a Command Center type of dashboard.

getDashboard

Gets the specified dashboard.

getDashboards

Gets all dashboards.

modifyDashboard

Modifies the specified dashboard.

modifyDashboardColumn

Modifies a dashboard column in a Command Center type of dashboard.

Data Source Commands

createDevOpsInsightDataSource

Creates a data source.

deleteDevOpsInsightDataSource

Deletes the specified data source.

getDevOpsInsightDataSource

Gets the specified data source.

getDevOpsInsightDataSources

Gets all data sources.

modifyDevOpsInsightDataSource

Modifies the specified data source.

Report commands

createReport

Creates a report.

deleteReport

Deletes the specified report.

getReport

Gets the specified report.

getReports

Gets all reports.

modifyReport

Modifies the specified report.

runReport

Runs a report.

sendReportingData

Sends data to the CloudBees Analytics server.

ReportFilter Commands

createReportingFilter

Creates a new reportingFilter object.

deleteReportingFilter

Deletes the specified reportReportingFilter object.

getReportingFilter

Retrieves the specified reportingFilter object.

getReportingFilters

Retrieves the specified reportingFilter objects.

modifyReportingFilter

Modifies the specified reportReportingFilter object.

ReportObjectAssociation Commands

createReportObjectAssociation

Creates a new reportObjectAssociation object.

deleteReportObjectAssociation

Deletes the specified reportObjectAssociation object.

getReportObjectAssociation

Retrieves the specified reportObjectAssociation object.

getReportObjectAssociations

Retrieves the associations for the specified reportObjectTypeName object.

modifyReportObjectAssociation

Modifies the specified reportObjectAssociation object.

ReportObjectAttribute Commands

createReportObjectAttribute

Creates a new reportObjectAttribute object.

deleteReportObjectAttribute

Deletes the specified reportObjectAttribute object.

getReportObjectAttribute

Retrieves the specified reportObjectAttribute object.

getReportObjectAttributeValues

Retrieves possible values for the specified reportObjectAttributeName object. Contents of the result set varies based on the type of reportObjectAttributeName :

getReportObjectAttributes

Retrieves the specified reportObjectAttribute objects.

modifyReportObjectAttribute

Modifies the specified reportObjectAttribute object.

ReportObjectType Commands

createReportObjectType

Creates a new reportObjectType object.

deleteReportObjectType

Deletes the specified reportObjectType object.

getReportObjectType

Retrieves the specified reportObjectType object.

getReportObjectTypes

Retrieves all reportObjectType objects.

modifyReportObjectType

Modifies the specified reportObjectType object.

Widget commands

createWidget

Creates a widget.

deleteWidget

Deletes the specified widget.

getWidget

Gets the specified widget.

getWidgets

Gets all widgets.

modifyWidget

Modifies the specified widget.

moveWidget

Moves a widget within a dashboard.

WidgetFilterOverride Commands

createWidgetFilterOverride

Creates a new widgetFilterOverride object.

deleteWidgetFilterOverride

Deletes the specified reportWidgetFilterOverride object.

getWidgetFilterOverride

Retrieves the specified widgetFilterOverride object.

getWidgetFilterOverrides

Retrieves the specified widgetFilterOverride objects.

modifyWidgetFilterOverride

Modifies the specified widgetFilterOverride object.

createDirectoryProvider

Creates a new LDAP directory provider.

deleteDirectoryProvider

Deletes an LDAP directory provider.

getDirectoryProvider

Retrieves an LDAP directory provider by name.

getDirectoryProviders

Retrieves all LDAP directory providers.

modifyDirectoryProvider

Modifies an existing LDAP directory provider.

moveDirectoryProvider

Moves an LDAP directory provider in front of another specified provider or to the end of the list.

testDirectoryProvider

Tests an LDAP directory provider.

addResourcePoolToEnvironmentTier

Adds a resource pool to a specific environment tier.

addResourceTemplateToEnvironmentTemplateTier

Adds a resource template to the specified environment template tier.

addResourceToEnvironmentTemplateTier

Adds a resource to the specified environment template tier.

createEnvironmentTemplate

Creates an environment template.

createEnvironmentTemplateTier

Creates a tier in an environment template.

createEnvironmentTemplateTierMap

Creates an environment-template tier map for an application.

createHook

Creates a hook in a resource template, which can have one or more hooks.

createResourceTemplate

Creates a resource template.

deleteEnvironmentTemplate

Deletes an environment template.

deleteEnvironmentTemplateTier

Deletes an environment template tier.

deleteEnvironmentTemplateTierMap

Deletes an environment template tier map from an application.

deleteEnvironmentTemplateTierMapping

Deletes a tier mapping from a environment-template tier map.

deleteHook

Deletes a hook associated with an entity.

deleteResourceTemplate

Deletes a resource template.

getAvailableResourcesForEnvironment

Retrieve all non-dynamic resources or resource pools.

getEnvironmentTemplate

Retrieves an environment template.

getEnvironmentTemplateTier

Retrieves an environment tier in an environment template.

getEnvironmentTemplateTierMaps

Retrieves all the environment-template tier maps used by the specified application.

getEnvironmentTemplateTiers

Retrieves all the environment template tiers in the specified environment template.

getEnvironmentTemplates

Retrieves all the environment templates in the specified project.

getHook

Retrieves a hook associated in an entity.

getHooks

Retrieves all the hooks associated with an entity.

getProvisionedEnvironments

Retrieves provisioned environments.

getResourcePoolsInEnvironmentTier

Retrieves the list of resource pools in the specified environment tier.

getResourceTemplate

Retrieves the specified resource template.

getResourceTemplates

Retrieves all the resource templates.

getResourceTemplatesInEnvironmentTemplateTier

Retrieves all the resource templates in the specified environment template tier.

getResourcesInEnvironmentTemplateTier

Retrieves all the resources in the specified environment template tier.

modifyEnvironmentTemplate

Modifies an environment template.

modifyEnvironmentTemplateTier

Modifies all the environment template tiers in the specified environment template.

modifyEnvironmentTemplateTierMap

Modifies an existing environment template tier map.

modifyEnvTemplTierResourceTemplMapping

Modifies the resource count in an environment template tier.

modifyHook

Modifies an existing hook in a resource template.

modifyResourceTemplate

Modifies the specified resource template.

provisionEnvironment

Provisions an environment.

provisionResourcePool

Provisions a resource pool.

removeResourceFromEnvironmentTemplateTier

Removes a resource from an environment template tier.

removeResourcePoolFromEnvironmentTier

Removes a resource pool from the specified environment tier.

removeResourceTemplateFromEnvironmentTemplateTier

Removes a resource template from the specified environment template tier.

tearDown

Removes dynamic environments that are no longer needed.

createEmailConfig

Creates a new email configuration.

deleteEmailConfig

Deletes an email configuration.

getEmailConfig

Retrieves an email configuration by name.

getEmailConfigs

Retrieves all email configurations.

modifyEmailConfig

Modifies an existing email configuration.

createEmailNotifier

Creates an email notifier on an object specified by an emailNotifierSelector.

createEventSubscription

Creates a list of event subscriptions.

deleteEmailNotifier

Deletes an email notifier from a property sheet container.

deleteEventSubscription

Deletes a list of event subscriptions.

getEmailNotifier

Retrieves an email notifier from a property sheet container.

getEmailNotifiers

Retrieves all email notifiers defined for the specified property sheet container.

modifyEmailNotifier

Modifies an email notifier in a property sheet container specified by an emailNotifierSelector.

modifyEventSubscription

Modifies a list of event subscriptions.

sendEmail

Facilitates sending an email from the command-line or a Command Step without setting up an Email Notifier. This API is more dynamic than an email notifier because you do not need to setup some kind of a template beforehand. This API also makes sending email attachments easier than using a notifier template.

createEnvironment

Creates a new environment.

createEnvironmentInventoryItem

Creates a new environment inventory item.

createEnvironmentMap (deprecated)

Creates a new service environment map for a service.

createReservation

Creates a new reservation.

deleteEnvironment

Deletes an environment.

deleteEnvironmentInventoryItem

Deletes an inventory item.

deleteEnvironmentMap

Deletes a microservice environment map from a microservice.

deleteReservation

Deletes a reservation.

getApplicationEnvironmentInventory

Retrieves details for all applications and their inventory across all mapped environments.

getEnvironment

Retrieves an environment by name.

getEnvironmentApplications

Retrieves a list of applications installed on the given environment.

getEnvironmentInventory

Retrieves a per-component grouped list of inventory items.

getEnvironmentInventoryItem

Retrieves an inventory item.

getEnvironmentInventoryItems

Retrieves all the inventory items for a given environment.

getEnvironments

Retrieves all environments in a project.

getReservation

Retrieves an environment reservation by its name.

getReservations

Retrieves all the environment reservations.

getRunSchedules

Retrieves the run schedules with environment reservations

modifyEnvironment

Modifies an environment.

modifyEnvironmentInventoryItem

Modifies an existing environment inventory item.

modifyReservation

Modifies an environment reservation.

seedEnvironmentInventory

Creates a new environment.

addResourcesToEnvironmentTier

Adds resources to the specified environment tier.

createEnvironmentTier

Creates a new environment tier.

deleteEnvironmentTier

Deletes an environment tier.

getEnvironmentTier

Retrieves an environment tier by name.

getEnvironmentTiers

Retrieves all environment tiers in an environment.

modifyEnvironmentTier

Modifies an environment tier.

removeResourcesFromEnvironmentTier

Removes the given resources from the given environment tier.

createGateway

Creates a new gateway.

deleteGateway

Deletes a gateway.

getGateway

Finds a gateway by name.

getGateways

Retrieves all gateways.

modifyGateway

Modifies an existing gateway.

createZone

Creates a new zone.

deleteZone

Deletes a zone.

getZone

Finds a zone by name.

getZones

Retrieves all zones.

modifyZone

Modifies an existing zone.

abortAllJobs

Aborts all running jobs.

abortJob

Aborts a running job.

abortJobStep

Aborts any type of step—command step or subprocedure step.

completeJob

Completes an externally managed job.

completeJobStep

Completes an externally managed job step.

createJob

Creates an externally managed job.

createJobStep

Creates a job step in an existing job.

deleteJob

Deletes a job from the CloudBees CD/RO database.

findJobSteps

Returns a list of job steps from a single job or from a single subprocedure job step. This API is used by the Job Details web page in the CloudBees CD/RO UI.

getJobDetails

Retrieves complete information about a job, including details from each job step.

getJobInfo

Retrieves all information about a job, except job step information.

getJobNotes

Retrieves the notes property sheet from a job.

getJobs

Retrieves summary information for a list of jobs.

getJobsForSchedule

Retrieves jobs started by a specific schedule.

getJobStatus

Retrieves the status of a job.

getJobStepDetails

Retrieves details for a job step.

getJobStepStatus

Retrieves the status of a job step.

getJobSummaries

Retrieves summary information about jobs.

getJobSummary

Retrieves a job and its job steps with only the specified job and job step properties.

modifyJob

Modifies the status of an externally managed job.

modifyJobStep

Transitions an externally managed job step through its lifecycle—pending, runnable, running, or complete—by setting the step’s status property.

moveJobs

Moves jobs from one project to another.

runProcedure

Creates and starts a new job using a procedure directly or specified indirectly through a schedule.

setJobName

Sets the name of a running job.

waitForJob

Waits until the specified job reaches a given status or the timeout expires.

runLicenseReport

Returns the license information details for the specified controller or operation center.

runUserReport

Produces a list of users based on the applied time filter.

createMicroservice

Creates a new microservice for a project or an application.

deleteMicroservice

Deletes a microservice.

getMicroservice

Retrieves a microservice by name.

getMicroservices

Retrieves all microservices in a project or application.

modifyMicroservice

Modifies an existing microservice.

createService (deprecated)

Creates a new microservice for a project or an application.

createServiceClusterMapping (deprecated)

Creates a new mapping between an application or project microservice and an environment cluster.

createServiceDependency (deprecated)

Adds a microservice dependency to the specified microservice.

deleteService (deprecated)

Deletes a microservice.

deleteServiceClusterMapping (deprecated)

Deletes a microservice cluster mapping.

deleteServiceDependency (deprecated)

Deletes a microservice dependency.

deleteServiceMapDetail (deprecated)

Deletes a microservice detail map for the given container.

getService (deprecated)

Retrieves a microservice by name.

getServices (deprecated)

Retrieves all microservices in a project or application.

modifyService (deprecated)

Modifies an existing microservice.

runServiceProcess (deprecated)

Runs a service process.

createTag

Creates a new object tag.

deleteTag

Deletes an existing object tag.

modifyTag

Modifies an existing object tag.

tagObject

Adds a tag to an object.

untagObject

Removes a tag from an object.

attachParameter

Attaches a formal parameter to a step.

createActualParameter

Creates a new actual parameter for a step that calls a nested procedure. The parameter is passed to the nested procedure when the step runs. At runtime, the actual parameter name needs to match the name of a formal parameter in the nested procedure.

createFormalOutputParameter

Creates a new formal output parameter.

createFormalParameter

Creates a new formal parameter for a procedure.

deleteActualParameter

Deletes an actual parameter.

deleteFormalOutputParameter

Deletes a formal output parameter.

deleteFormalParameter

Deletes a formal parameter.

detachParameter

Detaches a formal parameter from a step.

getActualParameter

Retrieves an actual parameter by its name.

getActualParameters

Retrieves all actual parameters from a job, job step, or step.

getFormalOutputParameter

Gets a formal output parameter by name.

getFormalOutputParameters

Gets all formal output parameters from an output parameter container.

getFormalParameter

Retrieves a formal parameter by its name.

getFormalParameterOptions

Retrieves possible option values for a procedure’s formal parameter in the procedure using the options script registered for it.

getFormalParameters

Retrieves all formal parameters from a procedure, schedule, or step.

getOutputParameter

Gets an output parameter by name.

getOutputParameters

Gets all output parameters from an output parameter container.

modifyActualParameter

Modifies an existing actual parameter. An actual parameter is a name/value pair that is passed to a subprocedure. This command supports renaming the actual parameter and setting its value.

modifyFormalOutputParameter

Modifies an existing formal output parameter.

modifyFormalParameter

Modifies an existing formal parameter.

setOutputParameter

Sets an output parameter value.

validateFormalParameters

Validates input parameters for a procedure using the validation script registered for it.

Persona

createPersona

Creates a new persona object.

deletePersona

Deletes the specified persona.

getPersona

Retrieves the specified persona.

getPersonas

Retrieves persona objects subject to specified criteria sent with the request.

modifyPersona

Modifies the specified persona object.

Persona Details

addPersonaDetail

Creates a new personaDetail object.

removePersonaDetail

Removes a personaDetail object.

Persona Categories

createPersonaCategory

Creates a new personaCategory object.

deletePersonaCategory

Deletes the specified personaCategory object.

getPersonaCategory

Retrieves the specified personaCategory object.

getPersonaCategories

Retrieves all persona categories.

modifyPersonaCategory

Modifies the specified personaCategory object.

Persona Pages

createPersonaPage

Creates a new personaPage object.

deletePersonaPage

Deletes the specified personaPage object.

getPersonaPage

Retrieves the specified personaPage object.

getPersonaPages

Retrieves all persona pages.

modifyPersonaPage

Modifies the specified personaPage object.

Persona Assignment

assignPersonaToUser

Assigns a list of valid users to an existing persona.

unassignPersonaFromUser

Unassigns the specified list of users from the existing persona.

assignPersonaToGroup

Assigns the specified list of groups to an existing persona.

unassignPersonaFromGroup

Unassigns the specified groups from the specified persona.

abortAllPipelineRuns

Aborts all pipeline runs associated with a release..

abortPipelineRun

Aborts a pipeline run.

attachPipelineRun

Add a pipeline run to another release. All arguments are required.

completeManualTask

Completes the manual task.

completeRelease

Completes the Release.

createDeployer

Creates a new deployer task for a project or a Release.

createdeployerApplication

Creates a deployer application for a Release.

createDeployerConfiguration

Creates the Deployer configuration to the Deployer application.

createDeployerService (deprecated)

Adds a Deployer service to the specified release.

createGate

Creates a new gate for a stage.

createNote

Creates a new note.

createPipeline

Creates a new pipeline for a project.

createRelease

Creates a new Release for a project.

createStage

Creates a new stage in a pipeline for a project.

createTask

Creates a new task for a task container.

createTaskGroup

Modifies tasks in a stage or a gate to create a group of parallel tasks or adds them to an existing group.

deleteGate

Deletes a gate for a stage.

deleteNote

Deletes a note associated with an entity.

deletePipeline

Deletes a pipeline in a project.

deletePipelineRun

Deletes a pipeline runtime.

deleteRelease

Deletes a Release.

deleteStage

Deletes a stage in a project.

deleteTask

Deletes a task in a task container.

detachPipelineRun

Detach a pipeline run from the specified release. All arguments are required.

getAllWaitingTasks

Retrieves a list of all tasks across pipeline runs that are awaiting manual approval.

getAttachedPipelineRuns

Fetch all attached runs for the specified release.

getDeployerApplication

Retrieves the application used in the Release by name.

getDeployerApplications

Retrieves all the applications in a Release.

getDeployerConfiguration

Retrieves a Deployer configuration.

getDeployerConfigurations

Retrieves all the configurations in the Deployer.

getGate

Retrieves a gate by its stage name and gate type.

getNote

Retrieves a note associated with an entity.

getNotes

Retrieves all the notes associated with an entity.

getPipeline

Retrieves a pipeline by its name.

getPipelineRuntimeDetails

Retrieves pipeline runtime details.

getPipelineRunAuditReport

Retrieves aggregation of of pipeline run data for the specified pipeline or release run.

getPipelineRuntimes

Retrieves pipeline runs

getPipelineStageRuntimeDeployerTasks

Returns the list of Deployer tasks and their details to be displayed in Pipeline Run Details page.

getPipelineStageRuntimeTasks

Retrieves the list of pipeline stage tasks and the details about them that are displayed in the pipeline run view.

getPipelines

Retrieves all the pipelines.

getRelease

Retrieves a Release by name.

getReleaseInventory

Retrieves inventory artifacts created in a Release.

getReleases

Retrieves all releases.

getReleaseTimelineDetails

Retrieves planned versus actual time details for a release.

getStage

Retrieves a stage by its name.

getStages

Retrieves all the stages for a pipeline.

getTask

Retrieves a task by its name.

getTasks

Retrieves a task by name.

getWaitingTasks

Retrieves a list of all the stage tasks that are currently waiting on manual tasks in pipeline run view.

modifyDeployer

Modifies an existing Deployer.

modifyDeployerApplication

Modifies the Deployer application associated with a Release.

modifyDeployerConfiguration

Modifies a Deployer configuration associated with a Deployer application.

modifyGate

Modifies an existing gate.

modifyNote

Modifies a note associated with an entity.

modifyPipeline

Modifies an existing pipeline.

modifyRelease

Modifies an existing Release.

modifyStage

Modifies an existing stage.

modifyTask

Modifies an existing task.

removeDeployerApplication

Removes a Deployer application for a Release.

removeDeployerConfiguration

Removes a Deployer configuration associated with a Deployer application.

restartPipelineRun

Restarts a pipeline run.

removeTaskGroup

Removes a task group (but does not delete the tasks).

retryTask

Retries a pipeline task. Applies only to waiting for manual retry tasks.

runPipeline

Runs the specified pipeline.

startRelease

Starts a Release.

validateDeployer

Validates the Deployer configuration.

waitForFlowRuntime

Waits until the pipeline specified by the flow runtime ID is completed or the timeout expires.

createPluginConfiguration

Create a new plugin configuration.

deletePluginConfiguration

Delete an existing plugin configuration.

getPluginConfiguration

Retrieve a plugin configuration.

getPluginConfigurations

Retrieve all installed plugin configurations.

modifyPluginConfigurations

Modify specified plugin configuration.

createPlugin

Creates a plugin from an existing project.

deletePlugin

Deletes an existing plugin object without deleting the associated project or files.

getPlugin

Retrieves an installed plugin.

getPlugins

Retrieves all installed plugins.

installPlugin

Installs a plugin from a JAR file. Extracts the JAR contents on the server and creates a project and a plugin.

modifyPlugin

Modifies a plugin.

promotePlugin

Sets the promoted flag on a plugin. Only one version of a plugin can be promoted at a time, so setting the promoted flag to true on one version sets the flag to false on all other plugins with the same key. The promoted version is the one resolved by an indirect reference of the form $[/plugins/<key>] or a plugin name argument without a specified version.

uninstallPlugin

Uninstalls a plugin, deleting the associated project and any installed files.

createProcedure

Creates a new procedure for an existing project.

createStep

Creates a new procedure step.

deleteProcedure

Deletes a procedure, including all steps.

deleteStep

Deletes a step from a procedure.

getProcedure

Finds a procedure by its name.

getProcedures

Retrieves all procedures in a project.

getStep

Retrieves a step from a procedure.

getSteps

Retrieves all steps in a procedure.

modifyProcedure

Modifies an existing procedure.

modifyStep

Modifies an existing step.

moveStep

Moves a step within a procedure.

createProcess

Creates a new process for an application or component.

deleteProcess

Deletes an application or component process.

getProcess

Retrieves an application or component process.

getProcesses

Retrieves all processes in an application or component.

modifyProcess

Modifies an existing process.

runProcess

Runs the specified process.

createProcessDependency

Creates a dependency between two process steps.

deleteProcessDependency

Deletes a dependency between two process steps.

getProcessDependencies

Retrieves all dependencies for a process.

modifyProcessDependency

Modifies a dependency between two process steps.

createProcessStep

Creates a new process step.

deleteProcessStep

Deletes an application or component process step.

getProcessStep

Retrieves an application or component process step.

getProcessSteps

Retrieves all the process steps in an application or component process.

modifyProcessStep

Modifies an existing process step.

createProject

Creates a new project.

deleteProject

Deletes a project, including all procedures, procedure steps, and jobs.

getProject

Finds a project by its name.

getProjects

Retrieves all projects.

modifyProject

Modifies an existing project.

reloadSetupScripts

Runs new, modified, or previously unsuccessful setup scripts.

createProperty

Creates a regular string or nested property sheet using a combination of property path and context.

deleteProperty

Deletes a property from a property sheet.

expandString

Expands property references in a string, in the current context.

findProperties

Returns properties of a particular object..

getProperties

Retrieves all properties associated with an object.

getProperty

Retrieves the specified property value.

incrementProperty

Increments the specified property value by the incrementBy amount. If the property does not exist, it will be created with an initial value of the incrementBy amount.

This API call is atomic. This means that the actions of reading the property, incrementing the value, and writing the new value to the property cannot be interrupted, and thus the call is parallel or thread-safe.

modifyProperty

Modifies a regular string or nested property sheet using a combination of property path and context.

setProperty

Sets the value for the specified property.

addResourcesToPool

Adds resources to a specified resource pool.

addResourceToEnvironmentTier

Adds a resource to the specified environment tier.

createResource

Creates a new resource.

createResourcePool

Creates a pool container for resource.

deleteResource

Deletes a resource.

deleteResourcePool

Deletes a resource pool.

getResource

Retrieves a resource by its name.

getResources

Retrieves all resources.

getResourcesInEnvironmentTier

Retrieves the list of resources in an environment tier.

getResourcesInPool

Retrieves a list of resources in a pool.

getResourcePool

Retrieves a specified resource pool by name.

getResourcePools

Retrieves a list of resource pools.

getResourceUsage

Retrieves resource usage information.

modifyResource

Modifies an existing resource.

modifyResourcePool

Modifies an existing resource pool.

pingAllResources

Pings all resources.

pingResource

Pings one resource.

removeResourceFromEnvironmentTier

Removes a resource from the specified environment tier.

removeResourcesFromPool

Removes resources from a specified resource pool.

runDiscovery

Runs a plugin Discover procedure to discover contents of a list or set of resources, and store settings for them in the ec_discovery property sheets.

signCertificate

Signs an agent certificate.

createRollingDeployPhase

Adds a rolling deploy phase to the specified environment.

deleteRollingDeployPhase

Deletes the rolling deploy phase associated with an environment.

getRollingDeployPhase

Retrieves the rolling deploy phase associated with an environment.

getRollingDeployPhases

Retrieves all the rolling deploy phases associated with an environment.

modifyRollingDeployPhase

Modifies the rolling deploy phase associated with an environment.

setTierResourcePhase

Maps a resource to a rolling deploy phase.

createSchedule

Creates a new schedule.

deleteSchedule

Deletes a schedule.

getSchedule

Retrieves a schedule by its name.

getSchedules

Retrieves all schedules.

modifySchedule

Modifies an existing schedule.

pauseScheduler

Sets the scheduler to pause.

deleteLicense

Deletes a license.

getAdminLicense

Retrieves the admin license, which can be used when all concurrent user licenses are in use.

getCertificates

Returns the certificates in the trust chain for the server.

getLicense

Retrieves information for one license.

getLicenses

Retrieves all license data.

getLicenseUsage

Retrieves the current license usage.

getServerInfo

Retrieves information about server ports and message delivery.

getServerStatus

Returns the status of the server.

getVersions

Retrieves server version information.

importLicenseData

Imports one or more licenses.

logMessage

Enters a message in the server log.

setLogLevel

Changes the log level of a logger.

shutdownServer

Shuts down the CloudBees CD/RO server.

tunePerformance

Adjusts how the server is performing.

getSsoConfiguration

Shuts down the CloudBees CD/RO server.

setSsoConfiguration

Adjusts how the server is performing.

createServiceAccount

Creates a service account object. Use a service account when creating and managing webhooks sessions.

deleteServiceAccount

Deletes a service account object.

getServiceAccount

Gets a service account object.

getServiceAccounts

Retrieves all service account objects.

modifyServiceAccount

Modifies an existing service account object.

createOpenIDConnectConfiguration

Creates a new an OIDC configuration.

deleteOpenIDConnectConfiguration

Deletes a an OIDC configuration.

getOpenIDConnectConfiguration

Retrieves an OIDC configuration.

getOpenIDConnectConfigurations

Retrieves all an OIDC configurations.

modifyOpenIDConnectConfiguation

Modifies an existing OIDC configuration.

createSamlIdentityProvider

Creates a new SAML identity provider.

createSamlServiceProvider

Creates a new SAML service provider.

deleteSamlIdentityProvider

Deletes a SAML identity provider.

deleteSamlServiceProvider

Deletes a SAML service provider.

getSamlAuthnRequest

Retrieves an AuthnRequest by IDP name.

getSamlIdentityProvider

Retrieves a SAML identity provider by name.

getSamlIdentityProviders

Retrieves all SAML identity providers.

getSamlLogoutRequest

Retrieves a SAML logout request by identity provider name.

getSamlServiceProvider

Retrieves a SAML service provider by name.

getSamlServiceProviders

Retrieves all SAML service providers.

loginSaml

Logs in the client with the given SAML response.

modifySamlIdentityProvider

Modifies an existing SAML identity provider.

modifySamlServiceProvider

Modifies an existing SAML service provider.

createSnapshot

Creates a new snapshot of the specified application or microservice.

deleteSnapshot

Deletes snapshot from an application.

getPartialApplicationRevision

Retrieves a partial application when a snapshot is created.

getSnapshot

Find a snapshot by name.

getSnapshotEnvironments

Retrieves a list of environments deployed in the specified snapshot.

getSnapshots

Retrieves all the snapshots in an application.

modifySnapshot

Modifies an existing snapshot of an application.

createScmSync

Creates a new source control synchronization (scmSync) object.

deleteScmSync

Deletes a source control synchronization (scmSync) object.

getScmSyncs

Retrieves specified source control synchronization (scmSync) objects.

getScmSync

Retrieves the single, specified source control synchronization (scmSync) object.

modifyScmSync

Modifies an existing source control synchronization (scmSync) object.

runScmSync

Runs an existing source control synchronization (scmSync) object.

createTierMapping

Creates a tier mapping in the specified tier map for the application.

createTierMap

Creates a tier map for an application.

deleteTierMap

Deletes a tier map from an application.

deleteTierMapping

Deletes a tier mapping from a tier map.

getTierMaps

Retrieves all tier maps that are used by an application.

modifyTierMap

Modifies an existing tier map.

modifyTierMapping

Modifies a tier mapping in the specified tier map for the application.

createTrigger

Creates a new webhooks trigger.

deleteTrigger

Deletes a webhooks trigger.

getTriggers

Retrieves specified webhooks triggers.

getTrigger

Retrieves the single, specified webhooks trigger.

modifyTrigger

Modifies an existing webhooks trigger.

runTrigger

Run an existing webhooks trigger.

createTriggerErrorDetail

Creates a new webhooks trigger error detail.

deleteTriggerErrorDetail

Deletes a webhooks trigger error detail.

getTriggerErrorDetails

Retrieves specified webhooks trigger error details.

setupWebhook

Sets up the webhook trigger in the source control repository specified in the trigger.

login

Logs into the server and saves the session ID for subsequent ectool use. The username provided determines the permissions for commands that can be run during the session.

logout

Logs out of the client session.

addUsersToGroup

Adds ones or more specified users to a particular group.

createGroup

Creates a new local group of users.

createUser

Creates a new local user.

deleteGroup

Deletes a local group.

deleteUser

Deletes a local user.

getGroup

Retrieves a group by its name.

getGroups

Retrieves all groups.

getUser

Retrieves a user by name.

getUsers

Retrieves all users.

login

Logs into the server and saves the session ID for subsequent ectool use. The username provided determines the permissions for commands that can be run during the session.

logout

Logs out of the client session.

modifyGroup

Modifies an existing group.

modifyUser

Modifies an existing non-local (LDAP) user that is registered with CloudBees CD/RO (with certain limitations) or an existing local user.

removeUsersFromGroup

Removes one or more users from a particular group.

createUserEmail

Creates a new alternative user/email mapping.

deleteUserEmail

Deletes an alternative user/email mapping.

getUserEmail

Retrieves the specified alternative user/email mapping

getUserEmails

Retrieves all alternative user/email mappings for the specified user.

modifyUserEmail

Modifies an alternative user/email mapping.

verifyUserEmail

Verifies an alternative user/email mapping.

completeRuntimeWaitDependency

Manually force the specific wait dependency to complete for the specified source pipeline runtime.

createWaitDependency

Creates a new wait dependency.

deleteWaitDependency

Deletes an existing wait dependency.

getRuntimeWaitDependency

Gets the specified runtime wait dependency.

getWaitDependency

Gets the specified wait dependency.

getWaitDependencies

Gets all wait dependencies.

modifyWaitDependency

Modifies an existing wait dependency.

createStateDefinition

Creates a new state definition for a workflow definition.

createTransitionDefinition

Creates a new transition definition for a workflow definition.

createWorkflowDefinition

Creates a new workflow definition for a project.

deleteStateDefinition

Deletes a state definition.

deleteTransitionDefinition

Deletes a transition definition.

deleteWorkflowDefinition

Deletes a workflow definition, including all state and transition definitions.

getStateDefinition

Finds a state definition by name.

getStateDefinitions

Retrieves all state definitions in a workflow definition.

getTransitionDefinition

Finds a transition definition by name.

getTransitionDefinitions

Retrieves all transition definitions in a workflow definition.

getWorkflowDefinition

Finds a workflow definition by name.

getWorkflowDefinitions

Retrieves all workflow definitions in a project.

modifyStateDefinition

Modifies an existing state definition.

modifyTransitionDefinition

Modifies an existing transition definition.

modifyWorkflowDefinition

Modifies an existing workflow definition.

moveStateDefinition

Moves a state definition within a workflow definition.

moveTransitionDefinition

Moves a transition definition within a workflow definition.

completeWorkflow

Marks a workflow as complete, which means transitions are no longer evaluated.

deleteWorkflow

Deletes a workflow, including all states and transitions.

getState

Finds a state by name.

getStates

Retrieves all states in a workflow.

getTransition

Finds a transition by name.

getTransitions

Retrieves all transitions in a workflow.

getWorkflow

Finds a workflow by name.

getWorkflows

Retrieves all workflow instances in a project.

runWorkflow

Runs the specified workflow definition, returns the workflow name.

transitionWorkflow

Manually transition from a workflow active state.

getWorkItems

Retrieves objects waiting for user interaction.

createWorkspace

Creates a new workspace.

deleteWorkspace

Deletes a workspace.

getWorkspace

Retrieves a workspace by name.

getWorkspaces

Retrieves all workspaces.

modifyWorkspace

Modifies an existing workspace.

resolveFile

Resolves the path to a log file or artifact in a workspace.

acquireNamedLock

Retrieves the named lock.

changeOwner

Changes the owner of an object.

clone

Makes a copy of an existing CloudBees CD/RO project, procedure, step, schedule, resource, directory provider, email configuration, or email notifier.

countObjects

Returns the count of objects specified by the provided filter.

deleteObjects

Deletes objects specified by the provided filters. Because of the complexity of specifying filter criteria, this API is not supported by ectool. However, all of its capabilities are supported through the Perl API.

describeObject

Returns a list of intrinsic properties for an object.

dumpHeap

Captures a Java heap dump.

dumpStatistics

Prints (emits) internal timing statistics.

evalDsl

Evaluates and runs a CloudBees CD/RO domain-specific language (DSL) script.

evalScript

Evaluates a script in a given context.This API is similar to expandString except that it evaluates the value argument as a Javascript block, without performing any property substitution on either the script or the result. The string value of the final expression in the script is returned as the value element of the response.

export

Exports part or all server data to an XML file. The default is to export all data in the system—the specified path is interpreted by the server. If the path is local, it will be created on the server machine. If it is a network path, it must be accessible by the server and the server user. If it is a relative path (not recommended), it must be relative to the server’s working directory.

findObjects

Finds several different types of CloudBees CD/RO objects—It is the underlying mechanism used to implement the CloudBees CD/RO "Search" feature. Because of this command’s general nature and the complexity of specifying filter and sort criteria, it is not supported by ectool. Use the Perl API for the findObjects command.

finishCommand

The agent uses this command to indicate that a command has been run.

generateDsl

Generates domain-specific language (DSL) script for an existing object.

getObjects

Retrieves the full object based on IDs returned by findObjects. All requested objects must be of the same objectType. See findObjects for a list of object types.

graphStateMachine

Generates a graph element with a stateMachine DOT graph as CDATA content.

import

Imports data from an XML export file.

logStatistic

Prints (emits) a statistics value to StatsD.

releaseNamedLock

Releases the named lock that synchronizes the name of an object.

abortAllJobs

Aborts all running jobs.

abortJob

Aborts a running job.

abortJobStep

Aborts any type of step—command step or subprocedure step.

addDependentsToArtifactVersion

Adds an artifact version query to an existing artifact. Dependent artifact versions are retrieved when the parent artifact version is retrieved.

addResourcesToPool

Adds resources to a specific resource pool.

addUsersToGroup

Adds ones or more specified users to a particular group.

attachCredential

Attaches a credential to an object.

attachParameter

Attaches a formal parameter to a step.

breakAclInheritance

Breaks ACL (access control list) inheritance at the given object.

changeOwner

Changes the owner of an object.

checkAccess

Checks ACL (access control list) permission information associated with an object ( including inherited ACLs) for the current user.

cleanupArtifactCache

Deletes stale artifact versions from an artifact cache. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.

cleanupRepository

Deletes stale artifact versions from the repository backing-store. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.

clone

Makes a copy of an existing CloudBees CD/RO project, procedure, step, schedule, resource, directory provider, email configuration, or email notifier.

completeJob

Completes an externally managed job.

completeJobStep

Completes an externally managed job step.

completeWorkflow

Marks a workflow as complete, which means transitions are no longer evaluated.

createAclEntry

Creates an ACE (access control list entry) on an object for a given principal.

createActualParameter

Creates a new actual parameter for a step that calls a nested procedure. The parameter is passed to the nested procedure when the step runs. At runtime, the actual parameter name needs to match the name of a formal parameter in the nested procedure.

createArtifact

Creates a new artifact.

createCredential

Creates a new credential for a project.

createDirectoryProvider

Creates a new LDAP directory provider.

createEmailConfig

Creates a new email configuration.

createEmailNotifier

Creates an email notifier on an object specified by an emailNotifierSelector.

createFormalParameter

Creates a new formal parameter for a procedure.

createGateway

Creates a new gateway.

createGroup

Creates a new local group of users.

createJob

Creates an externally managed job.

createJobStep

Creates a job step in an existing job.

createProcedure

Creates a new procedure for an existing project.

createProject

Creates a new project.

createProperty

Creates a regular string or nested property sheet using a combination of property path and context.

createRepository

Creates a repository for one or more artifacts.

createResource

Creates a new resource.

createResourcePool

Creates a pool container for resources.

createSchedule

Creates a new schedule.

createStateDefinition