The ectool is a command line interface that provides operational control over the CloudBees CD/RO system. It supports a large collection of commands, each of which translates to a message sent to the CloudBees CD/RO server. For example, ectool getProjects returns information about all projects defined on the server.
Download URL - https://downloads.cloudbees.com/cloudbees-cd/
$ wget https://downloads.cloudbees.com/cloudbees-cd/Release_2023.10/2023.10.0.169425/linux/CloudBeesFlowTools-2023.10.0.169425.tar.gz
$ ls
$ tar -zxvf CloudBeesFlowTools-2023.10.0.169425.tar.gz
$ cd CloudBeesFlowTools-2023.10.0.169425
$ pwd
$ export PATH=/home/ubuntu/CloudBeesFlowTools-2023.10.0.169425/bin:$PATH
$ ls bin/
$ ectool --help
# To test ectool:
ectool --help
# To test ectool:
bin/ectool --help
Example Commands
ectool --server 34.201.174.35 login "admin" "changeme"
ectool --server localhost --securePort 443 login admin changeme
ectool getVersions
ectool --server 34.201.174.35 login "admin" "changeme"
ectool createProject --help
ectool createProject raj1
ectool deleteProject --help
ectool deleteProject raju
ubuntu@ip-172-31-52-75:~/CloudBeesFlowTools-2023.10.0.169425$ ectool --help | |
CloudBees CD Tool version 2023.10.0.169425 | |
Copyright (C) 2005-2023 CloudBees, Inc. | |
All rights reserved. | |
Usage: ectool [options] <subcommand> [suboptions] | |
Global Options: | |
--help Print this message if no subcommand is | |
specified, otherwise print subcommand help. | |
--version Print ectool version number. | |
--server <hostname> Address of the CloudBees CD server. | |
Defaults to the value of the | |
COMMANDER_SERVER environment variable. If | |
that doesn't exist, it defaults to | |
the server most recently used or localhost | |
if there is no connection info in the | |
user's session file. | |
--port <port> HTTP listener port on the server. Defaults | |
to 8000. | |
--securePort <securePort> HTTPS listener port on the server. Defaults | |
to 8443. | |
--secure <0|1> Use https to communicate with the server. | |
Defaults to 1. | |
--timeout <s> Timeout for server communication. Defaults | |
to 180 seconds (3 minutes). | |
--retryTimeout <s> Amount of time to continue retrying requests | |
that fail due to communication errors. | |
Defaults to --timeout value unless running | |
in a job step, in which case the default is | |
24 hours. | |
--retry <0|1> Retry the request if it times out. | |
Defaults to 0. | |
--user <username> Use the session associated with the given | |
user. Defaults to the user from the last | |
login. | |
--setDefault <0|1> Use the current session as the default | |
for subsequent invocations. | |
Defaults to 1. | |
--encoding <charEncoding> Use the specified encoding for input/output. | |
Default is autodetected. | |
--dryrun Display session information and the request | |
that would be sent, without communicating | |
with the server. | |
--silent Suppress printing of the result. | |
--suppressAdvisoryMessages <0|1> | |
Suppress printing of the advisory messages. | |
Defaults to 1. | |
--valueOf For a successful response, emit the element | |
referred by this argument rather than the | |
whole response. | |
--format <format> Specifies the response format. Must be one | |
of 'xml' or 'json'. Defaults to 'xml'. | |
--ignoreEnvironment Force ectool to ignore COMMANDER_ENV variables. | |
Subcommands: | |
abortAllJobs Aborts all running jobs. | |
abortAllPipelineRuns Aborts all pipeline runs associated with | |
a release. | |
abortJob Aborts a running job. | |
abortJobStep Abort a running job step. | |
abortPipelineRun Aborts a pipeline run. | |
addComponentToApplicationTier Adds the specified component to the | |
specified application tier. | |
addCredentialToPluginConfiguration | |
Adds a credential to a given plugin | |
configuration. | |
addDependentsToArtifactVersion Adds an artifact version query to an | |
existing artifact. Dependent artifact | |
versions are retrieved when the parent | |
artifact version is retrieved. | |
addPageToPersonaCategory Adds a persona page to a given category. | |
addPersonaDetail Creates a new `personaDetail` object. | |
addPersonaSubpage Adds one or more persona subpage to a | |
given page. | |
addResourcePoolToEnvironmentTier | |
Adds a resource pool to a specific | |
environment tier. A resource pool is a | |
named group of resources. | |
addResourceTemplateToEnvironmentTemplateTier | |
Adds a resource template to the | |
specified environment template tier. | |
addResourceToEnvironmentTemplateTier | |
Adds a resource to the specified | |
environment template tier. | |
addResourceToEnvironmentTier Adds a resource to the specified | |
environment tier. | |
addResourcesToEnvironmentTier Adds resources to the specified | |
environment tier. | |
addResourcesToPool Adds resources to the specified resource | |
pool (a named group of resources). | |
addSubrelease Adds a subrelease to a given release. | |
addUsersToGroup Adds one or more specified users to a | |
local group. | |
assignPersonaToGroup Assigns the specified list of groups to | |
an existing persona. | |
assignPersonaToUser Assigns a list of valid users to an | |
existing persona. | |
attachCredential Attaches a credential to an object, such | |
as a step or a schedule. Attaching a | |
credential allows the credential to be | |
passed as an actual argument by a | |
schedule or subprocedure step, or to be | |
used in a `getFullCredential` call by a | |
command step. | |
attachParameter Attach a formal parameter to a step. | |
attachPipelineRun Adds a pipeline run to a release with a | |
status of `running` or `planning`; | |
pipeline runs cannot be attached to | |
completed releases. | |
breakAclInheritance Breaks access control list (ACL) | |
inheritance at the specified object. | |
When inheritance is broken, only the | |
access control entries directly on the | |
ACL will be considered. You must specify | |
one or more of the following arguments | |
(called locator arguments) to find the | |
object where you want to break | |
inheritance. | |
changeOwner Change the owner of an object. | |
checkAccess Return effective permissions of the | |
current user on an object. | |
cleanupArtifactCache Deletes stale artifacts from an artifact | |
cache. A 'stale artifact' is one whose | |
metadata has been previously deleted | |
from the CloudBees CD server. | |
cleanupRepository Deletes stale artifacts from the | |
repository backing-store. A 'stale | |
artifact' is one whose metadata has been | |
previously deleted from the CloudBees CD | |
server. | |
clone Clone a CloudBees CD entity. | |
completeJob Completes an externally managed job. | |
Marks the job root step so the job is | |
marked `completed` when all child steps | |
are completed, and updates the runtime | |
for the root step. | |
completeJobStep Completes an externally managed job | |
step. Marks the job step `completed` | |
when all child steps are completed and | |
updates the step runtime. | |
completeManualProcessStep Completes a manual process step. | |
completeManualTask Completes the manual task. | |
completeRelease Completes the release. | |
completeRuntimeWaitDependency Manually forces the specific wait | |
dependency to complete for the specified | |
source pipeline runtime. | |
completeWorkflow Marks a workflow as completed. When | |
completed, transitions are no longer | |
evaluated. | |
copyComponent Creates a new component based on an | |
existing one. | |
createAclEntry Creates an access control list entry | |
(ACE) 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 must | |
match the name of a formal parameter in | |
the nested procedure. | |
createApplication Creates a new application for a project. | |
createApplicationDependency Defines a dependency of an application | |
(or its snapshot) on another application | |
(or snapshot). At runtime, the | |
deployment process checks for the | |
dependent applications on the | |
environment. The deployment stops if | |
dependent applications or their versions | |
are not present and you have requested | |
enforcement of the dependency check. | |
Otherwise, the deployment continues with | |
a warning. | |
createApplicationFromDeploymentPackage | |
Runs a procedure that creates an | |
application from a deployment package. | |
createApplicationTier Creates a new application tier in the | |
application. | |
createArchiveConnector Creates a new `archiveConnector` object. | |
createArtifact Creates a new artifact. | |
createArtifactVersion Creates a new artifact version. | |
createCIBuildDetail Creates a new CI build for a project. | |
createCIConfiguration Creates a new CI server configuration. | |
createCatalog Creates a new catalog. | |
createCatalogItem Creates a new catalog item in a catalog. | |
createCluster Creates a new cluster configuration | |
object for a microservice application. | |
createComponent Creates a new component for a project. | |
createCredential Creates a new credential for a project. | |
createCredentialProvider Creates a new external credential | |
provider definition for a project. | |
createDashboard Creates a new dashboard. | |
createDashboardColumn Creates a dashboard column. | |
createDataRetentionPolicy Creates a new `DataRetentionPolicy` | |
object. | |
createDeployerApplication Adds a deployer application to a | |
release. | |
createDeployerConfiguration Adds the deployer configuration to the | |
deployer application. | |
createDevOpsInsightDataSource Creates a new DevOps Insight data | |
source. | |
createDirectoryProvider Creates a new Active Directory or LDAP | |
directory provider. | |
createEmailConfig Creates a new email configuration. | |
createEmailNotifier Create an EmailNotifier on a property | |
sheet container specified by an | |
emailNotifierSelector. | |
createEnvironment Creates a new environment. | |
createEnvironmentInventoryItem Creates a new environment inventory | |
item. | |
createEnvironmentTemplate Creates an environment template. | |
createEnvironmentTemplateTier Creates a tier in an environment | |
template. | |
createEnvironmentTemplateTierMap | |
Creates an environment-template tier map | |
for an application. | |
createEnvironmentTemplateTierMapping | |
Creates a new environment template tier | |
mapping for an environment template tier | |
map. | |
createEnvironmentTier Creates a new environment tier. | |
createEventSubscription Creates a list of event subscriptions. | |
createFormalOutputParameter Creates a new formal output parameter. | |
createFormalParameter Creates a formal parameter. | |
createGate Creates a new gate for a stage. | |
createGateway Creates a new gateway. | |
createGroup Creates a new local group of users or | |
personas. | |
createHook Creates a hook in a resource template, | |
which can have one or more hooks. A hook | |
stores a reference to a procedure in a | |
CloudBees CD project or plugin project. | |
When a resource template is used to | |
create a resource pool, these procedures | |
are invoked. | |
createJob Creates an externally managed job that | |
serves as a container for external job | |
steps. | |
createJobStep Create a job step in an existing job. | |
createKerberosKeytab [DEPRECATED] This API is deprecated. | |
Creates a new Kerberos keytab. | |
createKerberosKeytabEntry [DEPRECATED] This API is deprecated. | |
Creates a new Kerberos keytab entry. | |
createMicroservice Creates a new microservice for a project | |
or application. | |
createMicroserviceMapping Creates a new mapping between a | |
microservice and an environment cluster. | |
createNote Creates a new note. | |
createOpenIDConnectConfiguration | |
Creates a new OpenID Connect | |
configuration. | |
createPersona Creates a new `persona` object. | |
createPersonaCategory Creates a new `personaCategory` object. | |
Specify the name of the new page with | |
`personaCategoryName`. | |
createPersonaPage Create a new persona page. | |
createPipeline Creates a new pipeline for a project. | |
createPluginConfiguration Creates a new plugin configuration. | |
createProcedure Creates a new procedure for an existing | |
project. | |
createProcess Creates a new process for an application | |
or component. | |
createProcessDependency Creates a dependency between two process | |
steps. | |
createProcessStep Creates a new process step. | |
createProject Creates a new project. | |
createProperty Create a property using a combination of | |
property path and context. | |
createRelease Creates a new release for a project. | |
createReport Creates a new report. | |
createReportObjectAssociation Creates a new report object association. | |
createReportObjectAttribute Creates a new report object attribute. | |
createReportObjectType Creates a new report object type. | |
createReportingFilter Creates a new reporting filter. | |
createRepository Creates a repository for one or more | |
artifacts. | |
createReservation Creates a new reservation. | |
createResource Creates a new resource. For a proxy | |
resource, proxyHostName and proxyPort | |
arguments refer to the proxying | |
CloudBees CD agent. hostName and port | |
refer to the proxy target. | |
createResourcePool Creates a new pool for resources. | |
createResourceTemplate Creates a resource template. | |
createRollingDeployPhase Adds a rolling deploy phase to the | |
specified environment. | |
createSamlIdentityProvider Creates a new SAML identity provider. | |
createSamlServiceProvider Creates a new SAML service provider. | |
createSchedule Create a new schedule. | |
createScmSync Creates a new source code | |
synchronization object. | |
createSearchFilter Creates a new custom filter for the | |
currently logged in user. | |
createServiceAccount Creates a new service account object and | |
uses a service account when creating and | |
managing webhooks sessions. | |
createSession [DEPRECATED] This API is deprecated. | |
Creates a session. | |
createSnapshot Creates a new snapshot of the specified | |
application or microservice. | |
createStage Creates a new stage in a pipeline for a | |
project. | |
createStateDefinition Creates a new state definition for a | |
workflow definition. Optionally, a state | |
may launch either a procedure or a | |
sub-workflow as its `process` when the | |
state is entered. | |
createStep Creates a new procedure step. | |
createTag Creates a new tag for an object. | |
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. The default | |
error handling for group tasks is | |
`stopOnError` or to add them into an | |
existing group. | |
createTemplateCatalogItem Create template catalog item for an | |
object. | |
createTierMap Creates a tier map for an application. | |
createTierMapping Creates a tier mapping in the specified | |
tier map for the application. | |
createTransitionDefinition Creates a new transition definition for | |
workflow definition. | |
createTrigger Creates a new trigger. | |
createTriggerErrorDetail Creates a trigger error detail object. | |
createUser Create a new user. | |
createUserAccessToken Generate personal access token for an | |
authorized user. | |
createUserEmail Creates a new alternative user/email | |
address mapping. | |
createUtilityResource Creates a new utility resource. | |
createWaitDependency Creates a wait dependency for a stage or | |
task. | |
createWidget Creates a new widget. | |
createWidgetFilterOverride Creates a new widget filter override. | |
createWorkflowDefinition Creates a new workflow definition for a | |
project. | |
createWorkspace Creates a new workspace. | |
createZone Creates a new zone. | |
deleteAccessToken Deletes an access token. | |
deleteAclEntry Deletes an access control entry (ACE) in | |
an access control list (ACL) on an | |
object for a given principal (user or | |
group). | |
deleteActualParameter Deletes an actual parameter. | |
deleteApplication Deletes an application. | |
deleteApplicationDependency Deletes a dependency between two | |
applications. | |
deleteApplicationTier Deletes a tier from an application. | |
deleteArchiveConnector Deletes the specified `archiveConnector` | |
object. | |
deleteArtifact Deletes an existing artifact element and | |
all artifact versions. | |
deleteArtifactVersion Deletes artifact version metadata from | |
the CloudBees CD database. (This API | |
call does not delete or remove artifacts | |
stored on the repository machine.) | |
deleteCIBuildDetail Deletes a CI build object. | |
deleteCIConfiguration Deletes a CI configuration. | |
deleteCatalog Deletes a catalog. | |
deleteCatalogItem Deletes a catalog item. | |
deleteCatalogItemRun Deletes a catalog item run. | |
deleteCluster Deletes a cluster reference. | |
deleteComponent Deletes a component. | |
deleteCredential Deletes a credential. | |
deleteCredentialProvider Deletes a credential provider. | |
deleteDashboard Deletes a dashboard. | |
deleteDashboardColumn Deletes a dashboard column. | |
deleteDataRetentionPolicy Deletes the specified | |
`dataRetentionPolicy` object. | |
deleteDevOpsInsightDataSource Deletes a DevOps Insight data source. | |
deleteDirectoryProvider Deletes an Active Directory or LDAP | |
directory provider. | |
deleteEmailConfig Deletes an email configuration. | |
deleteEmailNotifier Delete an EmailNotifier from a (property | |
sheet) container. | |
deleteEnvironment Deletes an environment. | |
deleteEnvironmentInventoryItem Deletes an inventory item. | |
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 an | |
environment template tier map. A tier | |
mapping is a mapping of an application | |
tier to an environment template tier. A | |
tier map has one or more mappings. | |
deleteEnvironmentTier Deletes an environment tier. | |
deleteEventSubscription Delete a list of event subscriptions. | |
deleteFormalOutputParameter Deletes a formal output parameter. | |
deleteFormalParameter Deletes a formal parameter and any | |
additional property that was created by | |
`createFormalParameter` or | |
`modifyFormalParameter`. | |
deleteGate Deletes a gate in a stage. | |
deleteGateway Deletes a gateway. | |
deleteGroup Deletes a local group. | |
deleteHook Deletes a hook associated with an | |
entity. | |
deleteJob Deletes a job from the CloudBees CD | |
database. | |
deleteKerberosKeytab [DEPRECATED] This API is deprecated. | |
Deletes a Kerberos keytab from the | |
database. | |
deleteKerberosKeytabEntry [DEPRECATED] This API is deprecated. | |
Creates a new Kerberos keytab entry. | |
deleteLicense Deletes a license. | |
deleteMicroservice Deletes a microservice application. | |
deleteMicroserviceMapping Deletes a microservice cluster mapping. | |
deleteNote Deletes a note associated with an | |
entity. | |
deleteOpenIDConnectConfiguration | |
Deletes an OpenID Connect configuration. | |
deletePersona Deletes the specified persona. | |
deletePersonaCategory Deletes the specified `personaCategory` | |
object by name. | |
deletePersonaPage Deletes the specified `personaPage` | |
object. | |
deletePipeline Deletes a pipeline in a project. | |
deletePipelineRun Deletes a pipeline runtime. | |
deletePlugin Deletes an existing plugin object | |
without deleting the associated project | |
or files. | |
deletePluginConfiguration Deletes a plugin configuration. | |
deleteProcedure Deletes a procedure, including all | |
steps. | |
deleteProcess Deletes an application or component | |
process. | |
deleteProcessDependency Deletes a dependency between two process | |
steps. | |
deleteProcessStep Deletes an application or component | |
process step. | |
deleteProject Deletes a project, including all | |
procedures, procedure steps, and jobs | |
within that project. | |
deleteProperty Delete a property from a property sheet. | |
deleteRelease Deletes a release. | |
deleteReport Deletes a report. | |
deleteReportObjectAssociation Deletes a report object association. | |
deleteReportObjectAttribute Deletes a report object attribute. | |
deleteReportObjectType Deletes a report object type. | |
deleteReportingFilter Deletes a reporting filter. | |
deleteRepository Deletes artifact repository metadata | |
from the CloudBees CD database. (This | |
API call does not delete or remove | |
artifacts stored on the repository | |
machine.) | |
deleteReservation Deletes the specified reservation. | |
deleteResource Deletes a resource. | |
deleteResourcePool Deletes a resource pool. | |
deleteResourceTemplate Deletes a resource template. | |
deleteRollingDeployPhase Deletes the rolling deploy phase | |
associated with an environment. | |
deleteSamlIdentityProvider Deletes a SAML identity provider. | |
deleteSamlServiceProvider Deletes a SAML service provider. | |
deleteSchedule Deletes a schedule. | |
deleteScmSync Deletes a source code synchronization | |
object. | |
deleteSearchFilter Deletes a search filter. | |
deleteServiceAccount Deletes a service account. | |
deleteSession [DEPRECATED] This API is deprecated. | |
Deletes a session. | |
deleteSnapshot Deletes a snapshot from an application. | |
deleteStage Deletes a stage in a project. | |
deleteStateDefinition Deletes a state definition. | |
deleteStep Deletes a step from a procedure. | |
deleteTag Deletes an existing object tag. | |
deleteTask Deletes a task in a task container. | |
deleteTierMap Deletes a tier map from an application. | |
deleteTierMapping Deletes a tier mapping from a tier map. | |
deleteTransitionDefinition Deletes a transition definition. | |
deleteTrigger Deletes a trigger. | |
deleteTriggerErrorDetail Deletes the specified trigger error | |
detail. | |
deleteUser Deletes a local or registered user. | |
deleteUserEmail Deletes a new user/email address | |
mapping. | |
deleteUtilityResource Deletes a utility resource. | |
deleteWaitDependency Deletes the specified wait dependency | |
from the pipeline object definition. | |
deleteWidget Deletes a widget. | |
deleteWidgetFilterOverride Deletes a widget filter override. | |
deleteWorkflow Deletes a workflow, including all states | |
and transitions. | |
deleteWorkflowDefinition Deletes a workflow definition, including | |
all state and transition definitions. | |
deleteWorkspace Deletes a workspace. | |
deleteZone Deletes an existing zone. | |
describeObject Retrieves a list of intrinsic properties | |
for an object. | |
describeObjectTypeDslStructure Retrieves an object type DSL structure. | |
detachCredential Detach a credential from an object. | |
detachParameter Detaches a formal parameter from a step. | |
detachPipelineRun Detaches a pipeline run from the | |
specified release. | |
doActionOnRealtimeCluster Perform action on the given object in | |
the container platform for the given | |
CloudBees CD cluster reference. | |
evalDsl Evaluates and runs a CloudBees CD | |
domain-specific language (DSL) script. | |
evalScript Evaluates a script in the specified | |
context. This API is similar to | |
`expandString` except 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. | |
expandString Expand property references in a string | |
in the given context. | |
export Export part or all of the server data to | |
an XML file. `--compress` can be used to | |
compress the XML output. `--excludeJobs` | |
can be used to exclude jobs from the | |
export data. `--path` exports the single | |
object specified by the path. The | |
default is to export all data in the | |
system. | |
exportPlugin Exports a plugin to a .zip file. You can | |
use this file to import a plugin to | |
another CloudBees CD server. | |
generateDsl Generates a domain-specific language | |
(DSL) script for the specified object | |
including all nested objects, | |
parameters, and custom properties, | |
subject to arguments passed in with the | |
command. | |
getAccess Return ACL info associated with an | |
object, including inherited ACLs. | |
getAccessTokens Returns access tokens for a service | |
account with associated trigger details. | |
getAclEntry Get an ACE on an object for a given | |
principal. | |
getActualParameter Retrieves an actual parameter by its | |
name. | |
getActualParameters Get all actual parameters from a job, | |
step, schedule, state, or transition. | |
getAdminLicense Retrieves the admin license, which can | |
be used when all concurrent user | |
licenses are in use. | |
getAllWaitingTasks Retrieves a list of all tasks across | |
pipeline runs that are awaiting manual | |
approval. | |
getApplication Retrieves an application by name. | |
getApplicationDependencies Retrieves a list of dependencies of an | |
application based on the specified | |
filters in its arguments. For instance, | |
if you use the | |
`dependentApplicationName` argument, it | |
returns all dependencies between the two | |
applications regardless of their | |
snapshot names. | |
getApplicationEnvironmentInventory | |
Retrieves inventory items by | |
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. | |
getApplications Retrieves the specified applications in | |
a project. | |
getArchiveConnector Retrieves the specified | |
`archiveConnector` object. | |
getArchiveConnectors Retrieves all `archiveConnector` | |
objects. | |
getArtifact Retrieves an artifact by name. | |
getArtifactVersion Retrieves an artifact version by its | |
name. | |
getArtifactVersions Retrieve all artifact versions in the | |
system, possibly filtered by artifact, | |
retriever job, or retriever job-step. | |
getArtifacts Retrieves all artifacts in the system. | |
getAttachedPipelineRuns Fetches all attached runs for the | |
specified release. | |
getAvailableResourcesForEnvironment | |
Retrieves all non-dynamic resources or | |
resource pools. | |
getCIBuildAuditReport Retrieves the CI build audit report. | |
getCIBuildDetail Retrieves the specified CI build | |
details. | |
getCIBuildDetails Retrieves all CI builds. | |
getCIBuildLog Retrieves a CI build by name. | |
getCIConfiguration Retrieves a CI configuration. | |
getCIConfigurations Retrieves all CI configurations. | |
getCIJob Retrieves the specified CI job. | |
getCIJobParameters Retrieves parameters for the given CI | |
job. | |
getCIJobs Retrieves CI jobs for the specified CI | |
configuration. | |
getCatalog Retrieves a catalog by name. | |
getCatalogItem Retrieves a catalog item by name. | |
getCatalogItems Retrieves all catalog items for a | |
catalog. | |
getCatalogs Retrieves all catalogs in a project. | |
getCluster Retrieves a cluster reference by name. | |
getClusters Retrieves all cluster references in a | |
project or environment. | |
getComplianceConfiguration Retrieves the current Compliance | |
configuration. | |
getComplianceGateDecision [PREVIEW] This API is in preview mode, | |
and therefore subject to change. Sends | |
gate request to compliance and retrieves | |
a decision. | |
getComponent Retrieves a component by name. | |
getComponents Retrieves all components in a project. | |
getComponentsInApplicationTier Retrieves the list of components in an | |
application tier. | |
getCredential Finds a credential by name. | |
getCredentialProvider Retrieves the specified credential | |
provider definition. | |
getCredentialProviders Retrieves all credential provider | |
definitions in the specified project. | |
getCredentials Retrieves all credentials in a project. | |
getDashboard Retrieves a dashboard by name. | |
getDashboardVisualizations Retrieves all dashboard visualizations. | |
getDashboards Retrieves all dashboards in a project. | |
getDataRetentionPolicies Retrieves all `dataRetentionPolicy` | |
objects in the system. | |
getDataRetentionPolicy Retrieves the specified | |
`dataRetentionPolicy` object. | |
getDatabaseConfiguration Retrieves the current database | |
configuration. | |
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 configurations in the | |
deployer. | |
getDeploymentHistoryItems Retrieves all the deployment history | |
items for a specific environment. | |
getDevOpsInsightDataSource Retrieves a new DevOps Insight data | |
source. | |
getDevOpsInsightDataSources Retrieves all DevOps Insight data | |
sources. | |
getDevOpsInsightServerConfiguration | |
Retrieves the current DevOps Insight | |
Server configuration. | |
getDirectoryProvider Retrieves a directory provider by name. | |
getDirectoryProviders Retrieves all directory providers. | |
getEmailConfig Retrieves an email configuration by | |
name. | |
getEmailConfigs Retrieves all email configurations. | |
getEmailNotifier Get an EmailNotifier from a property | |
sheet container. | |
getEmailNotifiers Retrieves all email notifiers defined | |
for the specified property sheet. | |
getEntityChange Retrieves the entity changes. | |
getEntityChangeDetails Retrieves the differences between | |
entities. | |
getEnvironment Retrieves an environment by name. | |
getEnvironmentApplications Retrieves a list of applications | |
installed on the given environment. | |
getEnvironmentDeployments Retrieves environment deployments for | |
the specified environment. | |
getEnvironmentInventory Retrieves a per-component grouped list | |
of inventory items. | |
getEnvironmentInventoryItem Retrieves an inventory item. | |
getEnvironmentInventoryItems Retrieves all inventory items for a | |
given environment. | |
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 environment template tiers | |
in the specified environment template. | |
getEnvironmentTemplates Retrieves all environment templates in | |
the specified project. | |
getEnvironmentTier Retrieves an environment tier by name. | |
getEnvironmentTiers Retrieves all environment tiers in an | |
environment. | |
getEnvironments Retrieves all environments in a project. | |
getEventSubscription Retrieves an event subscription for the | |
specified user or group. | |
getEventSubscriptions Retrieves a list event subscriptions for | |
a specified event. | |
getFormalOutputParameter Retrieves a formal output parameter by | |
name. | |
getFormalOutputParameters Retrieves all formal output parameters | |
from an output parameter container. | |
getFormalParameter Retrieves a formal parameter by its | |
name. | |
getFormalParameters Retrieves all formal parameters from the | |
specified container. You must specify | |
locator arguments to identify the | |
container. If the locators identify a | |
schedule or step, the formal parameters | |
of the called procedure are returned. | |
getFullCredential Retrieves a credential by name, | |
including a user name or password, from | |
within a running step. | |
getGate Retrieves a gate by its stage name and | |
gate type. | |
getGateway Finds a gateway by name. | |
getGateways Retrieves all gateways. | |
getGroup Retrieves a group by its name. | |
getGroups Retrieves all groups. | |
getHook Retrieves a hook associated in an | |
entity. | |
getHooks Retrieves all hooks associated with an | |
entity. | |
getJobDetails Retrieves complete information about a | |
job, including details from each job | |
step. | |
getJobInfo Retrieves all information about a job, | |
_except_ for job step information. | |
getJobNotes Retrieves the notes property sheet from | |
a job. | |
getJobStatus Retrieves the status of a job. | |
getJobStepDetails Retrieves details for a job step. You | |
may never need to use this command. This | |
information is available for all job | |
steps in a job by using the | |
`getJobDetails` command. The | |
`getJobStepDetails` command can be used | |
to refresh data for a single step if you | |
need an update in real time. | |
getJobStepStatus Retrieves the status of a job step. | |
getJobSummary Retrieves a job and its job steps with | |
only the specified job and job step | |
properties. | |
getJobs Retrieve all jobs. | |
getJobsForSchedule Retrieves jobs started by a specific | |
schedule. | |
getKerberosKeytab [DEPRECATED] This API is deprecated. | |
Retrieves a Kerberos keytab by name. | |
getKerberosKeytabs [DEPRECATED] This API is deprecated. | |
Retrieves all Kerberos keytabs. | |
getLicense Retrieves information for one license. | |
getLicenseUsage Retrieves the current license usage. | |
getLicenses Retrieves all license data. | |
getManifest Gets the manifest for the given artifact | |
version. | |
getMicroservice Retrieves a microservice by name. | |
getMicroservices Retrieves all microservices in a project | |
or application. | |
getNote Retrieves a note associated with an | |
entity. | |
getNotes Retrieves all notes associated with an | |
entity. | |
getObjectDslStructure Retrieves the DSL structure for a | |
specified object. | |
getOpenIDConnectConfiguration Retrieves an OpenID Connect | |
configuration by name. | |
getOpenIDConnectConfigurations Retrieves all OpenID Connect | |
configurations. | |
getOutputParameter Gets all output parameters from an | |
output parameter container. You must | |
specify either the jobId or | |
flowRuntimeId object locators to find | |
the parameter. | |
getOutputParameters Retrieves all output parameters from an | |
output parameter container. | |
getPartialApplicationRevision Retrieves a partial application when a | |
snapshot is created. | |
getPathToProperty Retrieves the path to a property. | |
getPersona Retrieves the specified persona. | |
getPersonaCategories Retrieves all persona categories. | |
getPersonaCategory Retrieves the specified | |
`personaCategory` object. | |
getPersonaGroups Retrieves all groups that have a certain | |
persona. | |
getPersonaPage Retrieves the specified `personaPage` | |
object. | |
getPersonaPages Retrieves all persona pages. | |
getPersonaUsers Retrieves all users that have a certain | |
persona. | |
getPersonas Retrieves persona objects subject to | |
specified criteria sent with the | |
request. If no arguments are specified, | |
all personas in the system are returned, | |
sorted by persona name. | |
getPipeline Retrieves a pipeline by its name. | |
getPipelineRunAuditReport Retrieves a detailed data set for the | |
specified pipeline run to be used in | |
audit reports. | |
getPipelineRuntimeDetails Retrieves pipeline runtime details. | |
getPipelineRuntimes Retrieves pipeline runs. | |
getPipelineStageRuntimeDeployerTasks | |
Retrieves the list of deployer tasks and | |
their details to be displayed in | |
CloudBees CD 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. | |
getPlugin Retrieves an installed plugin. | |
getPluginCatalog Retrieves plugin catalog. | |
getPluginConfiguration Finds a plugin configuration. | |
getPluginConfigurations Find plugin configurations. | |
getPlugins Retrieves all installed plugins. | |
getProcedure Finds a procedure by its name. | |
getProcedures Retrieves all procedures in a project. | |
getProcess Retrieves an application or component | |
process. | |
getProcessDependencies Retrieves all dependencies for a | |
process. | |
getProcessStep Retrieves an application or component | |
process step. | |
getProcessSteps Retrieves all the process steps in an | |
application or component process. | |
getProcesses Retrieves all processes in an | |
application or component. | |
getProject Finds a project by its name. | |
getProjects Retrieves all projects. | |
getProperties Return all properties associated with an | |
object, along with the property sheet | |
identifier of the object's property | |
sheet. | |
getProperty Get value of the specified property. | |
getPropertyHierarchy Retrieves properties for an entity | |
hierarchy. | |
getProvisionedEnvironments Retrieves provisioned environments. | |
getRealtimeClusterDetails Retrieves details for the given object | |
from the container platform for the | |
given CloudBees CD cluster reference. | |
getRealtimeClusterTopology Retrieves cluster topology from the | |
container platform for the given | |
CloudBees CD cluster reference. | |
getRelease Retrieves a release by name. | |
getReleaseInventory Retrieves the artifact inventory created | |
in a release. | |
getReleaseTimelineDetails Retrieves planned versus actual time | |
details for a release. | |
getReleases Retrieve all releases. | |
getReport Retrieves a report by name. | |
getReportObjectAssociation Retrieves a report object association by | |
associated type. | |
getReportObjectAssociations Retrieves all report object associations | |
for the report object type. | |
getReportObjectAttribute Retrieves a report object attribute by | |
name. | |
getReportObjectAttributeValues Retrieves the report object attribute | |
values from DevOps Insight Server. | |
getReportObjectAttributes Retrieves all report object attributes | |
for the report object type. | |
getReportObjectType Retrieves a report object type by name. | |
getReportObjectTypes Retrieves all report object types in a | |
project. | |
getReportingFilter Retrieves a reporting filter by name. | |
getReportingFilters Retrieves all reporting filters. | |
getReports Retrieves all reports in a project. | |
getRepositories Retrieves all artifact repository | |
objects known to the CloudBees CD | |
server. | |
getRepository Retrieves an artifact repository by its | |
name. | |
getReservation Retrieves an environment reservation by | |
its name. | |
getReservations Retrieves all environment reservations. | |
getResource Retrieves a resource by its name. | |
getResourcePool Retrieves a specified resource pool by | |
name. | |
getResourcePools Retrieves a list of resource pools. | |
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 resource templates in the | |
specified environment template tier. | |
getResourceUsage Retrieves resource usage information. | |
getResources Retrieves all resources. | |
getResourcesInEnvironmentTemplateTier | |
Retrieves all resources in the specified | |
environment template tier. | |
getResourcesInEnvironmentTier Retrieves the list of resources in an | |
environment tier. | |
getResourcesInPool Retrieves a list of resources in a pool. | |
getRetrievedArtifacts Retrieves artifacts during a job. | |
getRollingDeployPhase Retrieves the rolling deploy phase | |
associated with an environment. | |
getRollingDeployPhases Retrieves all rolling deploy phases | |
associated with an environment. | |
getRunHierarchy Retrieves either the definition view or | |
the runtime view for the specified | |
release. | |
getRunSchedules Retrieves the run schedules with | |
environment reservations. | |
getRuntimeWaitDependencies Retrieves runtime wait dependencies for | |
the specified pipeline runtime or | |
pipeline runtime object. | |
getSamlIdentityProvider Retrieves a SAML identity provider by | |
name. | |
getSamlIdentityProviders Retrieves all SAML identity providers. | |
getSamlServiceProvider Retrieves a SAML service provider by | |
name. | |
getSamlServiceProviderMetadata Retrieves SAML identity provider | |
metadata. | |
getSamlServiceProviders Retrieves all SAML service providers. | |
getSchedule Retrieves a schedule by its name. | |
getSchedules Retrieves all schedules. | |
getScmSync Retrieves a source code synchronization | |
object by name. | |
getScmSyncs Retrieves all source code | |
synchronization objects for the | |
specified project. | |
getSearchFilter Retrieves a search filter by name. | |
getSearchFilters Retrieves all search filters. | |
getServerInfo Retrieves information about server ports | |
and message delivery. | |
getServerPublicKey Retrieves the public key of the | |
CloudBees CD server. | |
getServerSettings Retrieves all server settings by | |
category. | |
getServerSettingsCategories Retrieves server settings categories. | |
getServerStatus Retrieves the current status of the | |
CloudBees CD server, including log | |
messages generated during the startup | |
sequence. | |
getServiceAccount Retrieves a service account by its name. | |
getServiceAccounts Retrieves all service accounts. | |
getSessions [DEPRECATED] This API is deprecated. | |
Retrieves all sessions for a service | |
account. | |
getSnapshot Retrieves a snapshot by name. | |
getSnapshotEnvironments Retrieves a list of environments | |
deployed in the specified snapshot. | |
getSnapshots Retrieves all snapshots in an | |
application. | |
getSsoConfiguration Retrieves the SSO server configuration. | |
getStage Retrieves a stage by its name. | |
getStages Retrieves all the stages for a pipeline. | |
getState Finds a state by its name. | |
getStateDefinition Retrieves a state definition by its | |
name. | |
getStateDefinitions Retrieves all state definitions in a | |
workflow definition. | |
getStates Retrieves all states in a workflow. | |
getStatsdConfiguration Retrieves the statsd configuration. | |
getStep Retrieves a step from a procedure. | |
getSteps Retrieves all steps in a procedure. | |
getSubrelease Retrieves a subrelease for a given | |
release. | |
getSubreleases Retrieves subreleases for a given | |
release. | |
getTag Retrieves an existing object tag. | |
getTags Retrieves tags based on requested | |
criteria. | |
getTask Retrieves a task by its name. | |
getTasks Retrieves all tasks. | |
getTierMaps Retrieves all tier maps that are used by | |
an application. | |
getTransition Finds a transition by its name. | |
getTransitionDefinition Finds a transition definition by its | |
name. | |
getTransitionDefinitions Retrieves all transition definitions in | |
a workflow definition. | |
getTransitions Retrieves all transitions in a workflow. | |
getTrigger Retrieves a trigger by name. | |
getTriggerErrorDetails Retrieves a list of trigger error | |
details. | |
getTriggers Retrieves all triggers. | |
getUser Retrieves information about a user. | |
getUserAccessToken Retrieves user access token. | |
getUserAccessTokenSessions Retrieves user access token sessions. | |
getUserAccessTokens Retrieves user access token. | |
getUserEmail Retrieves the specified user/email | |
mapping. | |
getUserEmails Retrieves all user/email mappings for | |
the specified user. | |
getUsers Retrieve all users. | |
getUtilityResource Retrieves a utility resource by name. | |
getUtilityResources Retrieves all utility resources in an | |
environment or environment template. | |
getVersions Retrieves server version information. | |
getWaitDependencies Retrieves all wait dependencies for | |
`projectName`. | |
getWaitDependency Retrieves the specified wait dependency. | |
getWaitingTasks Retrieves a list of all stage tasks that | |
are waiting on a manual approval or | |
waiting for manual retry tasks in a | |
pipeline run view. | |
getWidget Retrieves a dashboard widget by name. | |
getWidgetFilterOverride Retrieves a widget filter override by | |
dashboard filter name. | |
getWidgetFilterOverrides Retrieves all widget filter overrides | |
for the widget. | |
getWidgets Retrieves all dashboard widgets for | |
dashboard. | |
getWorkItems Retrieves waiting items for the current | |
user or a user specified with | |
`userName`, subject to optionally | |
supplied filters. | |
getWorkflow Finds a workflow by its name. | |
getWorkflowDefinition Retrieves a workflow definition by its | |
name. | |
getWorkflowDefinitions Retrieves all workflow definitions in a | |
project. | |
getWorkflows Retrieves all workflow instances in a | |
project. | |
getWorkspace Retrieves a workspace by its name. | |
getWorkspaces Retrieves all workspaces. | |
getZone Finds a zone by name. | |
getZones Retrieves all zones. | |
import Import data from an XML export file. If | |
`--disableSchedules` is `1`, any | |
imported schedules will be disabled. | |
`--path` can be used to import a single | |
object to a different location from | |
where it was exported. `--force` can be | |
provided to replace a single object at | |
the provided path. | |
importLicenseData Imports one or more licenses. | |
incrementProperty Atomically increments an integer | |
property by the specified amount and | |
returns the new value. | |
installPlugin Installs a plugin from a .jar or .zip | |
file. Extracts the .jar or .zip file | |
contents on the server and creates a | |
project and a plugin. | |
logStatistic Prints (emits) a statistics value to | |
StatsD. | |
login Login the client with the given | |
credentials. | |
logout Signs out of the client session. | |
modifyAclEntry Modify an ACE on an object for a given | |
principal. | |
modifyActualParameter Modify an existing actual parameter. | |
modifyApplication Modifies an existing application. | |
modifyApplicationDependency Modifies a dependency between two | |
applications. | |
modifyApplicationTier Modifies an existing tier in the | |
application. | |
modifyArchiveConnector Modifies the specified | |
`archiveConnector` object. | |
modifyArtifact Modifies an existing artifact. | |
modifyArtifactVersion Modifies an existing artifact version. | |
modifyCIBuildDetail Modifies an existing CI build detail | |
object. | |
modifyCIConfiguration Modifies an existing CI server | |
configuration. | |
modifyCatalog Modifies a catalog. | |
modifyCatalogItem Modifies an existing catalog item. | |
modifyCluster Modifies an existing cluster | |
configuration object for a microservice | |
application. | |
modifyComponent Modifies an existing component. | |
modifyCredential Modifies an existing credential. | |
modifyCredentialProvider Modifies an existing credential | |
provider. | |
modifyDashboard Modifies a dashboard. | |
modifyDashboardColumn Modifies a dashboard column. | |
modifyDataRetentionPolicy Modifies the specified | |
`dataRetentionPolicy` object. | |
modifyDeployerApplication Modifies the deployer application | |
associated with a release. | |
modifyDeployerConfiguration Modifies a deployer configuration | |
associated with a deployer application. | |
modifyDevOpsInsightDataSource Modifies an existing DevOps Insight data | |
source. | |
modifyDirectoryProvider Modifies an existing Active Directory or | |
LDAP directory provider. | |
modifyEmailConfig Modifies an existing email | |
configuration. | |
modifyEmailNotifier Modify an EmailNotifier on a property | |
sheet container specified by an | |
emailNotifierSelector. | |
modifyEnvTemplTierResourceTemplMapping | |
Modifies the resource count in an | |
environment template tier. | |
modifyEnvironment Modifies an environment. | |
modifyEnvironmentInventoryItem Modifies an existing environment | |
inventory item. | |
modifyEnvironmentTemplate Modifies an environment template. | |
modifyEnvironmentTemplateTier Modifies all environment template tiers | |
in the specified environment template. | |
modifyEnvironmentTemplateTierMap | |
Modifies an existing environment | |
template tier map. | |
modifyEnvironmentTemplateTierMapping | |
Modifies an existing environment | |
template tier mapping. | |
modifyEnvironmentTier Modifies an environment tier. | |
modifyEventSubscription Modifies a list of event subscriptions. | |
modifyFormalOutputParameter Modifies an existing formal output | |
parameter. | |
modifyFormalParameter Modifies a formal parameter. | |
modifyGate Modifies an existing gate. | |
modifyGateway Modifies an existing gateway. | |
modifyGroup Modifies an existing group. | |
modifyHook Modifies an existing hook in a resource | |
template. | |
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. | |
modifyKerberosKeytab [DEPRECATED] This API is deprecated. | |
Modifies an existing Kerberos keytab. | |
modifyMicroservice Modifies an existing microservice. | |
modifyMicroserviceMapping Modifies an existing environment | |
mapping. | |
modifyNote Modifies a note associated with an | |
entity. | |
modifyOpenIDConnectConfiguration | |
Modifies an existing OpenID Connect | |
configuration. | |
modifyPersona Modifies the specified persona object. | |
modifyPersonaCategory Modifies the specified `personaCategory` | |
object. | |
modifyPersonaPage Modifies the specified `personaPage` | |
object. | |
modifyPipeline Modifies an existing pipeline. | |
modifyPlugin Modifies a plugin. | |
modifyPluginConfiguration Modifies a plugin configuration. | |
modifyProcedure Modifies an existing procedure. | |
modifyProcess Modifies an existing process. | |
modifyProcessDependency Modifies a dependency between two | |
process steps. | |
modifyProcessStep Modifies an existing process step. | |
modifyProject Modifies an existing project. | |
modifyProperty Modifies a regular string or nested | |
property sheet using a combination of | |
property path and context. | |
modifyRelease Modifies an existing release. When the | |
`pipelineName` and `pipelineProjectName` | |
arguments are provided, the existing | |
pipeline associated with the release is | |
deleted, and the resolved pipeline is | |
cloned to a new pipeline under the new | |
release. | |
modifyReport Modifies a report. | |
modifyReportObjectAssociation Modifies a report object association. | |
modifyReportObjectAttribute Modifies a report object attribute. | |
modifyReportObjectType Modifies a report object type. | |
modifyReportingFilter Modifies a reporting filter. | |
modifyRepository Modifies an existing artifact | |
repository. | |
modifyReservation Modifies an environment reservation. | |
modifyResource Modifies an existing resource. For a | |
proxy resource, the `proxyHostName` and | |
`proxyPort` arguments refer to the | |
proxying CloudBees CD agent. The | |
`hostName` and `port` arguments refer to | |
the proxy target. | |
modifyResourcePool Modifies an existing resource pool. | |
modifyResourceTemplate Modifies the specified resource | |
template. | |
modifyRollingDeployPhase Modifies the rolling deploy phase | |
associated with an environment. | |
modifySamlIdentityProvider Modifies an existing SAML identity | |
provider. | |
modifySamlServiceProvider Modifies an existing SAML service | |
provider. | |
modifySchedule Modify a schedule. | |
modifyScmSync Modifies an existing source code | |
synchronization object. | |
modifySearchFilter Modifies an existing search filter. | |
modifyServiceAccount Modifies a service account. | |
modifySession [DEPRECATED] This API is deprecated. | |
Modifies a session. | |
modifySnapshot Modifies an existing snapshot of an | |
application. | |
modifyStage Modifies an existing stage. | |
modifyStateDefinition Modifies an existing state definition. | |
modifyStep Modifies an existing step. | |
modifyTag Modifies an existing tag. | |
modifyTask Modifies an existing task. | |
modifyTierMap Modifies an existing tier map. | |
modifyTierMapping Modifies a tier mapping in the specified | |
tier map for the application. | |
modifyTransitionDefinition Modifies an existing transition | |
definition. | |
modifyTrigger Modifies an existing trigger. | |
modifyUser Modifies a non-local (LDAP) user that is | |
registered with CloudBees CD (with | |
certain limitations described below) or | |
a local user. | |
modifyUserAccessToken Modify user access token details for an | |
authorized user. | |
modifyUserEmail Modifies a user/email mapping. | |
modifyUtilityResource Modifies a utility resource. | |
modifyWaitDependency Modifies an existing wait dependency. | |
modifyWidget Modifies a widget. | |
modifyWidgetFilterOverride Modifies a widget filter override. | |
modifyWorkflowDefinition Modifies an existing workflow | |
definition. | |
modifyWorkspace Modifies an existing workspace. | |
modifyZone Modifies an existing zone. | |
moveDirectoryProvider Moves an Active Directory or LDAP | |
directory provider in front of another | |
specified provider or to the end of the | |
list. | |
moveJobs Moves jobs from one project to another | |
project. | |
moveRepository Moves an artifact repository in front of | |
another, specified repository or to the | |
end of the list. This API does not move | |
artifact version data to another | |
repository server machine. Only the | |
repository order in which CloudBees CD | |
searches to retrieve an artifact version | |
is changed. | |
moveStateDefinition Moves a state definition within a | |
workflow definition. | |
moveStep Moves a step within a procedure. | |
moveTransitionDefinition Moves a transition definition within a | |
workflow definition. | |
moveWidget Moves a widget within a dashboard. | |
pausePipelineRun Pause the pipeline run. | |
pingAllResources Pings all resources. | |
pingResource Pings the specified resource. | |
processWebhookTrigger Processes webhook events. | |
promotePlugin Sets the `promoted` argument 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 | |
`0/plugins/<key>]` or a plugin name | |
argument without a specified version. | |
provisionCluster Provisions a cluster. | |
provisionEnvironment Provisions an environment. | |
provisionResourcePool Provisions a resource pool. | |
pruneChangeHistory Prunes obsolete-for-days data from the | |
Change History tables. | |
publishArtifactVersion Publishes an artifact version to an | |
artifact repository. | |
removeComponentFromApplicationTier | |
Removes the specified component from an | |
application tier. | |
removeDependentsFromArtifactVersion | |
Removes a list of dependent artifact | |
versions from an existing artifact | |
version. | |
removeDeployerApplication Removes a deployer application for a | |
release. | |
removeDeployerConfiguration Removes a deployer configuration | |
associated with a deployer application. | |
removePersonaDetail Removes a `personaDetail` object. | |
removePersonaSubpage Deletes a persona subpage. | |
removeResourceFromEnvironmentTemplateTier | |
Removes a resource from an environment | |
template tier. | |
removeResourceFromEnvironmentTier | |
Removes a resource from the specified | |
environment tier. | |
removeResourcePoolFromEnvironmentTier | |
Removes a resource pool from the | |
specified environment tier. | |
removeResourceTemplateFromEnvironmentTemplateTier | |
Removes a resource template from the | |
specified environment template tier. | |
removeResourcesFromEnvironmentTier | |
Removes the given resources from the | |
given environment tier. | |
removeResourcesFromPool Removes resources from the specified | |
resource pool. | |
removeSubrelease Removes a subrelease from a release. | |
removeTaskGroup Removes a task group, but does not | |
delete the tasks. The location of the | |
ungrouped tasks is the same as the | |
location of the group task. | |
removeUsersFromGroup Removes one or more users from an | |
existing local group. | |
restartPipelineRun Restart a pipeline run. | |
restoreAclInheritance Restore acl inheritance at the given | |
object. | |
resumePipelineRun Resume the pipeline run. | |
retrieveArtifactVersions Retrieves the most recent artifact | |
version, including its dependents, from | |
an artifact repository. | |
retryProcessStep Allows a job step that is waiting on | |
manual input to perform a retry. | |
retryTask Retries a pipeline task. This only | |
applies to tasks that are waiting for a | |
manual retry. It can be any pipeline | |
task (excluding `MANUAL`, `APPROVAL`, | |
`GROUP`, and `DEPLOYER` tasks) or an | |
application deployment that is a part of | |
a deployer task. For application | |
deployments, a subapplication (and a | |
subproject by Perforce) should be | |
provided. | |
revert Revert data to a previous state. | |
revokeToken [DEPRECATED] This API is deprecated. | |
Revokes a user's token. The API is | |
deprecated. Use RevokeUserAccessToken | |
instead. | |
revokeUserAccessToken Revoke access user's token. | |
revokeUserAccessTokens Revoke access user's token. | |
runCatalogItem Run a catalog item. | |
runDiscovery Runs the Discover procedure in a plugin | |
to discover contents of a list or set of | |
resources, and store settings for them | |
in the `ec_discovery` property sheets. | |
runFutureTask Run a task out of order - in a stage or | |
gate that hasn't started yet. | |
runLicenseReport Run licenseReport to get license usage | |
analytics data. | |
runPipeline Runs the specified pipeline. If the | |
pipeline configures | |
`disableMultipleActiveRuns=` `true`, | |
only one active run of this pipeline is | |
allowed at a time and attempts to start | |
more than one results in an exception. | |
runProcedure Run the specified procedure, return new | |
job ID. If the --pollInterval option is | |
provided, wait until the job completes | |
up to a maximum of --timeout seconds (if | |
also provided). If the --scheduleName | |
option is provided, the parameters | |
provided by that schedule will be used. | |
runProcess Runs the specified process. For | |
microservice applications, it is used to | |
deploy a microservice to a Kubernetes | |
cluster. | |
runReport Retrieves data for the requested report | |
from the reporting system. | |
runScmSync Runs the specified source code | |
synchronization object. | |
runTrigger Run the specified trigger, returns the | |
flowRuntimeId. | |
runUserReport Run userReport to retrieve users | |
activity data. | |
runWorkflow Runs the specified workflow definition | |
and returns the workflow name. | |
searchEntityChange Searches for entity changes. | |
seedEnvironmentInventory Seeds the environment with a new | |
inventory to mimic an actual application | |
or release-scoped deployment. | |
sendEmail Send an email message. | |
sendReportingData Sends data to the DevOps Insight server. | |
setCIBuildDetail This command is a wrapper for the | |
`create/modifyCIBuildDetail` API. It | |
abstracts the logic for whether the | |
build data needs to be created or, if it | |
already exists, updated. | |
setCIEventsSchemaConfiguration Change the CI events schema | |
configuration. | |
setComplianceConfiguration [PREVIEW] This API is in preview mode, | |
and therefore subject to change. Sets | |
the Compliance configuration. | |
setDatabaseConfiguration Sets the database configuration in the | |
server. If the server is in bootstrap | |
mode, these changes take effect | |
immediately, and the server will attempt | |
to start. If the server is already | |
running, these changes have no effect | |
until the server is restarted. | |
setDevOpsInsightServerConfiguration | |
Sets the DevOps Insight Server | |
configuration. | |
setJobName Sets the name of a running job. | |
setOutputParameter Sets an output parameter value. | |
setPipelineRunName Renames a running pipeline. | |
setProperty Sets the value for the specified | |
property. | |
setSsoConfiguration Sets the SSO server configuration. | |
setStatsdConfiguration Change the statsd configuration. | |
setTierResourcePhase Maps a resource to a rolling deploy | |
phase. | |
setupWebhook Run the specified setupWebhook, returns | |
RunProcedureResult. | |
shutdownServer Shut down the CloudBees CD server. | |
startRelease Starts a release. If the release | |
pipeline configures | |
`disableMultipleActiveRuns= true`, only | |
one active run of this release pipeline | |
is allowed at a time and attempts to | |
start more than one results in an | |
exception. | |
tagObject Adds a tag to an object. | |
tearDownEnvironment Used to get rid of an environment that | |
is no longer needed, and tear down | |
associated dynamic resources. | |
tearDownResource Used to tear down a dynamic resource | |
that is no longer needed. | |
tearDownResourcePool Used to get rid of resource pools that | |
are no longer needed, and tear down | |
associated dynamic resources. | |
testDirectoryProvider Tests that a specific user name and | |
password combination work with the | |
specified directory provider settings. | |
transitionWorkflow Manually transitions from the active | |
workflow state. | |
unassignPersonaFromGroup Unassigns the specified groups from the | |
specified persona. | |
unassignPersonaFromUser Unassigns the specified list of users | |
from the existing persona. | |
uninstallPlugin Uninstalls a plugin and deletes the | |
associated project and any installed | |
files. | |
untagObject Removes a tag from an object. | |
updateArtifactVersion Update an artifact version by updating | |
or adding files and publish it to an | |
artifact repository with a new version. | |
validateDeployer Validates the deployer configuration. | |
verifyUserEmail Email address verification process. |
I’m a DevOps/SRE/DevSecOps/Cloud Expert passionate about sharing knowledge and experiences. I am working at Cotocus. I blog tech insights at DevOps School, travel stories at Holiday Landmark, stock market tips at Stocks Mantra, health and fitness guidance at My Medic Plus, product reviews at I reviewed , and SEO strategies at Wizbrand.
Please find my social handles as below;
Rajesh Kumar Personal Website
Rajesh Kumar at YOUTUBE
Rajesh Kumar at INSTAGRAM
Rajesh Kumar at X
Rajesh Kumar at FACEBOOK
Rajesh Kumar at LINKEDIN
Rajesh Kumar at PINTEREST
Rajesh Kumar at QUORA
Rajesh Kumar at WIZBRAND