CloudBees Flow Perl API Commands Overview

Click an API command name in the table below to go to a section for that API command containing arguments and their descriptions, command syntax, and usage examples. Information for each API provides positional arguments for each command. However, you can use "value pairs" to construct your command scripts instead. For more information, see Using the CloudBees Flow API, ectool, and ec-perl.

ACL Management (Access Control List)

Commands Description

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

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

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

Deletes an ACE on an object for a given principal.

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

Retrieves an ACE on an object for a given principal.

Modifies an ACE on an object for a given principal.

Restores ACL inheritance at the given object.

Applications

Commands Description

Creates a new application for a project.

Deletes an application.

Retrieves an application by name.

Retrieves all applications in a project.

Modifies an existing application.

Application Tiers

Commands Description

Creates a new application tier in the application.

Deletes a tier from an application.

Retrieves an application tier by name

Retrieves all application tiers in an application

Retrieves all application tiers that are used by the given component

Modifies an existing tier in the application.

Artifact Management

Commands Description

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

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

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

Creates a new artifact.

Creates a new artifact version.

Creates a repository for one or more artifacts.

Deletes an existing artifact element and all artifact versions.

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

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

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.

Retrieves an artifact by its name.

Retrieves all artifacts in the system.

Retrieves an artifact version by its name.

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

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

Retrieves all artifact repository objects known to the CloudBees Flow server.

Retrieves an artifact repository by its name.

Retrieves artifacts during a job.

Modifies an existing artifact.

Modifies an existing artifact version.

Modifies an existing artifact repository.

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

Publishes an artifact version to an artifact repository.

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

Resolves the network route to an artifact repository.

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

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.

Catalogs

Commands Description

Creates a new catalog.

Creates a new catalog item in a catalog.

Deletes a catalog.

Deletes a catalog item.

Retrieves a catalog by name.

Retrieves a catalog item by name.

Retrieves all catalog items for catalog.

Retrieves all catalogs in a project.

Modifies a catalog.

Modifies an existing catalog item.

Run a catalog item.

Change History

Commands Description

Retrieves all the deployment history items for a specific environment.

Retrieves the entity changes.

Retrieves the differences between entities.

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

Reverts the state of the object to a previous state.

Searches for entity changes.

Components

Commands Description

Adds the specified component to the specified application tier.

Creates a new component based on an existing one.

Creates a new component for a project.

Deletes a component.

Retrieves a component by name

Retrieves all components in a project

Retrieves the list of components in an application tier.

Modifies an existing component.

Removes the specified component from an application tier.

Credential Management

Commands Description

Attaches a credential to an object.

Creates a new credential for a project.

Deletes a credential.

Detaches a credential from an object.

Finds a credential by name.

Retrieves all credentials in a project.

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

Modifies an existing credential.

Custom Filters

Commands Description

Creates a custom filter.

Deletes a custom filter.

Retrieves a custom filter by name.

Retrieves all custom filters

Modifies an existing custom filter

Database Configuration

Commands Description

Retrieves the current database configuration.

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.

Performs consistency checks on the database.

Data Retention

Commands Description

Data Retention Policy Commands

Creates a new DataRetentionPolicy object.

Deletes the specified data retention policy.

Retrieves the specified dataRetentionPolicy object.

Retrieves all dataRetentionPolicy objects in the system.

Modifies the specified dataRetentionPolicy object.

Archive Connector Commands

Creates a new archiveConnector object.

Deletes the specified archiveConnector object.

Retrieves the specified archiveConnector object.

Retrieves all archiveConnector objects.

Modifies the specified archiveConnector object.

DevOps Insight

Commands Description

Dashboard Commands

Creates a dashboard.

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

Deletes the specified dashboard.

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

Gets the specified dashboard.

Gets all dashboards.

Modifies the specified dashboard.

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

Data Source Commands

Creates a data source.

Deletes the specified data source.

Gets the specified data source.

Gets all data sources.

Modifies the specified data source.

Report commands

Creates a report.

Deletes the specified report.

Gets the specified report.

Gets all reports.

Modifies the specified report.

Runs a report.

Sends data to the DevOps Insight server.

ReportFilter Commands

Creates a new reportingFilter object.

Deletes the specified reportReportingFilter object.

Retrieves the specified reportingFilter object.

Retrieves the specified reportingFilter objects.

Modifies the specified reportReportingFilter object.

ReportObjectAssociation Commands

Creates a new reportObjectAssociation object.

Deletes the specified reportObjectAssociation object.

Retrieves the specified reportObjectAssociation object.

Retrieves the associations for the specified reportObjectTypeName object.

Modifies the specified reportObjectAssociation object.

ReportObjectAttribute Commands

Creates a new reportObjectAttribute object.

Deletes the specified reportObjectAttribute object.

Retrieves the specified reportObjectAttribute object.

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

  • For enumerated types, all possible types are returned.

  • For string types, all values in the devops server are returned.

  • For boolean types, the boolean values in the devops server are returned.

Retrieves the specified reportObjectAttribute objects.

Modifies the specified reportObjectAttribute object.

ReportObjectType Commands

Creates a new reportObjectType object.

Deletes the specified reportObjectType object.

Retrieves the specified reportObjectType object.

Retrieves all reportObjectType objects.

Modifies the specified reportObjectType object.

Widget commands

Creates a widget.

Deletes the specified widget.

Gets the specified widget.

Gets all widgets.

Modifies the specified widget.

Moves a widget within a dashboard.

WidgetFilterOverride Commands

Creates a new widgetFilterOverride object.

Deletes the specified reportWidgetFilterOverride object.

Retrieves the specified widgetFilterOverride object.

Retrieves the specified widgetFilterOverride objects.

Modifies the specified widgetFilterOverride object.

Directory Provider Management

Commands Description

Creates a new LDAP directory provider.

Deletes an LDAP directory provider.

Retrieves an LDAP directory provider by name.

Retrieves all LDAP directory providers.

Modifies an existing LDAP directory provider.

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

Tests an LDAP directory provider.

Dynamic Environments

Commands Description

Adds a resource pool to a specific environment tier.

Adds a resource template to the specified environment template tier.

Adds a resource to the specified environment template tier.

Creates an environment template.

Creates a tier in an environment template.

Creates an environment-template tier map for an application.

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

Creates a resource template.

Deletes an environment template.

Deletes an environment template tier.

Deletes an environment template tier map from an application.

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

Deletes a hook associated with an entity.

Deletes a resource template.

Retrieve all non-dynamic resources or resource pools.

Retrieves an environment template.

Retrieves an environment tier in an environment template.

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

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

Retrieves all the environment templates in the specified project.

Retrieves a hook associated in an entity.

Retrieves all the hooks associated with an entity.

Retrieves provisioned environments.

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

Retrieves the specified resource template.

Retrieves all the resource templates.

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

Retrieves all the resources in the specified environment template tier.

Modifies an environment template.

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

Modifies an existing environment template tier map.

Modifies the resource count in an environment template tier.

Modifies an existing hook in a resource template.

Modifies the specified resource template.

Provisions an environment.

Provisions a resource pool.

Removes a resource from an environment template tier.

Removes a resource pool from the specified environment tier.

Removes a resource template from the specified environment template tier.

Removes dynamic environments that are no longer needed.

Email Configuration and Management

Commands Description

Creates a new email configuration.

Deletes an email configuration.

Retrieves an email configuration by name.

Retrieves all email configurations.

Modifies an existing email configuration.

Email Notifiers Management

Commands Description

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

Creates a list of event subscriptions.

Deletes an email notifier from a property sheet container.

Deletes a list of event subscriptions.

Retrieves an email notifier from a property sheet container.

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

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

Modifies a list of event subscriptions.

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.

Environments

Commands Description

Creates a new environment.

Creates a new environment inventory item.

Creates a new service environment map for a service.

Creates a new reservation.

Deletes an environment.

Deletes an inventory item.

Deletes a microservice environment map from a microservice.

Deletes a reservation.

Retrieves an environment by name.

Retrieves a list of applications installed on the given environment.

Retrieves a per-component grouped list of inventory items.

Retrieves an inventory item.

Retrieves all the inventory items for a given environment.

Retrieves all environments in a project.

Retrieves an environment reservation by its name.

Retrieves all the environment reservations.

Retrieves the run schedules with environment reservations

Modifies an environment.

Modifies an existing environment inventory item.

Modifies an environment reservation.

Creates a new environment.

Environment Tiers

Commands Description

Adds resources to the specified environment tier.

Creates a new environment tier.

Deletes an environment tier.

Retrieves an environment tier by name.

Retrieves all environment tiers in an environment.

Modifies an environment tier.

Removes the given resources from the given environment tier.

Gateway and Zone Management

Commands Description

Creates a new gateway.

Deletes a gateway.

Finds a gateway by name.

Retrieves all gateways.

Modifies an existing gateway.

Creates a new zone.

Deletes a zone.

Finds a zone by name.

Retrieves all zones.

Modifies an existing zone.

Job Management

Commands Description

Aborts all running jobs.

Aborts a running job.

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

Completes an externally managed job.

Completes an externally managed job step.

Creates an externally managed job.

Creates a job step in an existing job.

Deletes a job from the CloudBees Flow database.

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 Flow UI.

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

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

Retrieves the notes property sheet from a job.

Retrieves summary information for a list of jobs.

Retrieves jobs started by a specific schedule.

Retrieves the status of a job.

Retrieves details for a job step.

Retrieves the status of a job step.

Retrieves summary information about jobs.

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

Modifies the status of an externally managed job.

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

Moves jobs from one project to another.

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

Sets the name of a running job.

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

Microservices

Commands Description

Creates a new microservice for a project or an application.

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

Adds a microservice dependency to the specified microservice.

Deletes a microservice.

Deletes a microservice cluster mapping.

Deletes a microservice dependency.

Deletes a microservice detail map for the given container.

Retrieves a microservice by name.

Retrieves all microservices in a project or application.

Modifies an existing microservice.

Runs a service process.

Object Tagging

Commands Description

Creates a new object tag.

Deletes an existing object tag.

Modifies an existing object tag.

Adds a tag to an object.

Removes a tag from an object.

Parameter Management

Commands Description

Attaches a formal parameter to a step.

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.

Creates a new formal output parameter.

Creates a new formal parameter for a procedure.

Deletes an actual parameter.

Deletes a formal output parameter.

Deletes a formal parameter.

Detaches a formal parameter from a step.

Retrieves an actual parameter by its name.

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

Gets a formal output parameter by name.

Gets all formal output parameters from an output parameter container.

Retrieves a formal parameter by its name.

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

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

Gets an output parameter by name.

Gets all output parameters from an output parameter container.

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.

Modifies an existing formal output parameter.

Modifies an existing formal parameter.

Sets an output parameter value.

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

Personas

Commands Description

Persona

Creates a new persona object.

Deletes the specified persona.

Retrieves the specified persona.

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

Modifies the specified persona object.

Persona Details

Creates a new personaDetail object.

Removes a personaDetail object.

Persona Categories

Creates a new personaCategory object.

Deletes the specified personaCategory object.

Retrieves the specified personaCategory object.

Retrieves all persona categories.

Modifies the specified personaCategory object.

Persona Pages

Creates a new personaPage object.

Deletes the specified personaPage object.

Retrieves the specified personaPage object.

Retrieves all persona pages.

Modifies the specified personaPage object.

Persona Assignment

Assigns a list of valid users to an existing persona.

Unassigns the specified list of users from the existing persona.

Assigns the specified list of groups to an existing persona.

Unassigns the specified groups from the specified persona.

Pipelines and Releases

Commands Description

Aborts all pipeline runs associated with a release..

Aborts a pipeline run.

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

Completes the manual task.

Completes the Release.

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

Creates a deployer application for a Release.

Creates the Deployer configuration to the Deployer application.

Adds a Deployer service to the specified release.

Creates a new gate for a stage.

Creates a new note.

Creates a new pipeline for a project.

Creates a new Release for a project.

Creates a new stage in a pipeline for a project.

Creates a new task for a task container.

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

Deletes a gate for a stage.

Deletes a note associated with an entity.

Deletes a pipeline in a project.

Deletes a pipeline runtime.

Deletes a Release.

Deletes a stage in a project.

Deletes a task in a task container.

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

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

Fetch all attached runs for the specified release.

Retrieves the application used in the Release by name.

Retrieves all the applications in a Release.

Retrieves a Deployer configuration.

Retrieves all the configurations in the Deployer.

Retrieves a gate by its stage name and gate type.

Retrieves a note associated with an entity.

Retrieves all the notes associated with an entity.

Retrieves a pipeline by its name.

Retrieves pipeline runtime details.

Retrieves pipeline runs

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

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

Retrieves all the pipelines.

Retrieves a Release by name.

Retrieves inventory artifacts created in a Release.

Retrieves all releases.

Retrieves planned versus actual time details for a release.

Retrieves a stage by its name.

Retrieves all the stages for a pipeline.

Retrieves a task by its name.

Retrieves a task by name.

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

Modifies an existing Deployer.

Modifies the Deployer application associated with a Release.

Modifies a Deployer configuration associated with a Deployer application.

Modifies an existing gate.

Modifies a note associated with an entity.

Modifies an existing pipeline.

Modifies an existing Release.

Modifies an existing stage.

Modifies an existing task.

Removes a Deployer application for a Release.

Removes a Deployer configuration associated with a Deployer application.

Restarts a pipeline run.

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

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

Runs the specified pipeline.

Starts a Release.

Validates the Deployer configuration.

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

Plugin Management

Commands Description

Creates a plugin from an existing project.

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

Retrieves an installed plugin.

Retrieves all installed plugins.

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

Modifies a plugin.

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.

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

Procedure Management

Commands Description

Creates a new procedure for an existing project.

Creates a new procedure step.

Deletes a procedure, including all steps.

Deletes a step from a procedure.

Finds a procedure by its name.

Retrieves all procedures in a project.

Retrieves a step from a procedure.

Retrieves all steps in a procedure.

Modifies an existing procedure.

Modifies an existing step.

Moves a step within a procedure.

Process

Commands Description

Creates a new process for an application or component.

Deletes an application or component process.

Retrieves an application or component process.

Retrieves all processes in an application or component.

Modifies an existing process.

Runs the specified process.

Process Dependency Management

Commands Description

Creates a dependency between two process steps.

Deletes a dependency between two process steps.

Retrieves all dependencies for a process.

Modifies a dependency between two process steps.

Process Step Management

Commands Description

Creates a new process step.

Deletes an application or component process step.

Retrieves an application or component process step.

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

Modifies an existing process step.

Project Management

Commands Description

Creates a new project.

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

Finds a project by its name.

Retrieves all projects.

Modifies an existing project.

Runs new, modified, or previously unsuccessful setup scripts.

Property Management

Commands Description

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

Deletes a property from a property sheet.

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

Returns properties of a particular object..

Retrieves all properties associated with an object.

Retrieves the specified property value.

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.

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

Sets the value for the specified property.

Resource Management

Commands Description

Adds resources to a specified resource pool.

Adds a resource to the specified environment tier.

Creates a new resource.

Creates a pool container for resource.

Deletes a resource.

Deletes a resource pool.

Retrieves a resource by its name.

Retrieves all resources.

Retrieves the list of resources in an environment tier.

Retrieves a list of resources in a pool.

Retrieves a specified resource pool by name.

Retrieves a list of resource pools.

Retrieves resource usage information.

Modifies an existing resource.

Modifies an existing resource pool.

Pings all resources.

Pings one resource.

Removes a resource from the specified environment tier.

Removes resources from a specified resource pool.

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.

Signs an agent certificate.

Rolling Deployments

Commands Description

Adds a rolling deploy phase to the specified environment.

Deletes the rolling deploy phase associated with an environment.

Retrieves the rolling deploy phase associated with an environment.

Retrieves all the rolling deploy phases associated with an environment.

Modifies the rolling deploy phase associated with an environment.

Maps a resource to a rolling deploy phase.

Schedule Management

Commands Description

Creates a new schedule.

Deletes a schedule.

Retrieves a schedule by its name.

Retrieves all schedules.

Modifies an existing schedule.

Sets the scheduler to pause.

Server Management

Commands Description

Deletes a license.

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

Returns the certificates in the trust chain for the server.

Retrieves information for one license.

Retrieves all license data.

Retrieves the current license usage.

Retrieves information about server ports and message delivery.

Returns the status of the server.

Retrieves server version information.

Imports one or more licenses.

Enters a message in the server log.

Changes the log level of a logger.

Shuts down the CloudBees Flow server.

Adjusts how the server is performing.

Single Sign-On

Commands Description

Creates a new SAML identity provider.

Creates a new SAML service provider.

Deletes a SAML identity provider.

Deletes a SAML service provider.

Retrieves an AuthnRequest by IDP name.

Retrieves a SAML identity provider by name.

Retrieves all SAML identity providers.

Retrieves a SAML logout request by identity provider name.

Retrieves a SAML service provider by name.

Retrieves all SAML service providers.

Logs in the client with the given SAML response.

Modifies an existing SAML identity provider.

Modifies an existing SAML service provider.

Sets the SSO server configuration.

Snapshot Management

Commands Description

Creates a new snapshot of the specified application or microservice.

Deletes snapshot from an application.

Retrieves a partial application when a snapshot is created.

Find a snapshot by name.

Retrieves a list of environments deployed in the specified snapshot.

Retrieves all the snapshots in an application.

Modifies an existing snapshot of an application.

Tier Map Management

Commands Description

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

Creates a tier map for an application.

Deletes a tier map from an application.

Deletes a tier mapping from a tier map.

Retrieves all tier maps that are used by an application.

Modifies an existing tier map.

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

User and Group Management

Commands Description

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.

Logs out of the client session.

Adds ones or more specified users to a particular group.

Creates a new local group of users.

Creates a new local user.

Deletes a local group.

Deletes a local user.

Retrieves a group by its name.

Retrieves all groups.

Retrieves a user by name.

Retrieves all users.

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.

Logs out of the client session.

Modifies an existing group.

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

Removes one or more users from a particular group.

Wait Dependencies

Commands Description

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

Creates a new wait dependency.

Deletes an existing wait dependency.

Gets the specified runtime wait dependency.

Gets the specified wait dependency.

Gets all wait dependencies.

Modifies an existing wait dependency.

Webhooks Management

Commands Description

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

Deletes a service account object.

Gets a service account object.

Retrieves all service account objects.

Modifies an existing service account object.

Creates a new webhooks session.

Deletes a webhooks session.

Retrieves webhooks sessions managed by the specified service account name.

Modifies a webhooks session.

Workflow Definition Management

Commands Description

Creates a new state definition for a workflow definition.

Creates a new transition definition for a workflow definition.

Creates a new workflow definition for a project.

Deletes a state definition.

Deletes a transition definition.

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

Finds a state definition by name.

Retrieves all state definitions in a workflow definition.

Finds a transition definition by name.

Retrieves all transition definitions in a workflow definition.

Finds a workflow definition by name.

Retrieves all workflow definitions in a project.

Modifies an existing state definition.

Modifies an existing transition definition.

Modifies an existing workflow definition.

Moves a state definition within a workflow definition.

Moves a transition definition within a workflow definition.

Workflow Management

Commands Description

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

Deletes a workflow, including all states and transitions.

Finds a state by name.

Retrieves all states in a workflow.

Finds a transition by name.

Retrieves all transitions in a workflow.

Finds a workflow by name.

Retrieves all workflow instances in a project.

Runs the specified workflow definition, returns the workflow name.

Manually transition from a workflow active state.

Work Items

Commands Description

Retrieves objects waiting for user interaction.

Workspace Management

Commands Description

Creates a new workspace.

Deletes a workspace.

Retrieves a workspace by name.

Retrieves all workspaces.

Modifies an existing workspace.

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

Miscellaneous

Commands Description

Retrieves the named lock.

Changes the owner of an object.

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

Returns the count of objects specified by the provided filter.

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.

Returns a list of intrinsic properties for an object.

Captures a Java heap dump.

Prints (emits) internal timing statistics.

Evaluates and runs a CloudBees Flow domain-specific language (DSL) script.

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.

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.

Finds several different types of CloudBees Flow objects—It is the underlying mechanism used to implement the CloudBees Flow "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.

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

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

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.

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

Imports data from an XML export file.

Prints (emits) a statistics value to StatsD.

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

Commands Description

Aborts all running jobs.

Aborts a running job.

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

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

Adds resources to a specific resource pool.

Adds ones or more specified users to a particular group.

Attaches a credential to an object.

Attaches a formal parameter to a step.

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

Changes the owner of an object.

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

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

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

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

Completes an externally managed job.

Completes an externally managed job step.

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

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

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.

Creates a new artifact.

Creates a new credential for a project.

Creates a new LDAP directory provider.

Creates a new email configuration.

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

Creates a new formal parameter for a procedure.

Creates a new gateway.

Creates a new local group of users.

Creates an externally managed job.

Creates a job step in an existing job.

Creates a new procedure for an existing project.

Creates a new project.

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

Creates a repository for one or more artifacts.

Creates a new resource.

Creates a pool container for resources.

Creates a new schedule.

Creates a new state definition for a workflow definition.

Creates a new procedure step.

Creates a new transition definition for a workflow definition.

Creates a new local user.

Creates a new workflow definition for a project.

Creates a new workspace.

Creates a new zone.

Deletes an ACE on an object for a given principal.

Deletes an actual parameter.

Deletes an existing artifact element and all artifact versions.

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

Deletes a credential.

Deletes an LDAP directory provider.

Deletes an email configuration.

Deletes an email notifier from a property sheet container.

Deletes a formal parameter.

Deletes a gateway.

Deletes a local group.

Deletes a job from the CloudBees Flow database.

Deletes a license.

This API 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.

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

Deletes a procedure, including all steps.

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

Deletes a property from a property sheet.

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

Deletes a resource.

Deletes a resource pool.

Deletes a schedule.

Deletes a state definition.

Deletes a step from a procedure.

Deletes a transition definition.

Deletes a local user.

Deletes a workflow, including all states and transitions.

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

Deletes a workspace.

Deletes a zone.

Detaches a credential from an object.

Detaches a formal parameter from a step.

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.

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

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.

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 jobstep, registers the step as a retriever for the returned artifact versions. Use the Perl API for the findArtifactVersions command.

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 Flow UI.

This command finds several different types of CloudBees Flow objects—it is the underlying mechanism used to implement the CloudBees Flow "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.

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

Retrieves an ACE on an object for a given principal.

Retrieves an actual parameter by its name.

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

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

Retrieves an artifact by its name.

Retrieves all artifacts in the system.

Retrieves an artifact version by its name.

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

Finds a credential by name.

Retrieves all credentials in a project.

Retrieves the current database configuration.

Retrieves an LDAP directory provider by name.

Retrieves all LDAP directory providers.

Retrieves an email configuration by name.

Retrieves all email configurations.

Retrieves an email notifier from a property sheet container.

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

Retrieves a formal parameter by its name.

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

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

Finds a gateway by name.

Retrieves all gateways.

Retrieves a group by its name.

Retrieves all groups.

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

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

Retrieves the notes property sheet from a job.

Retrieves summary information for a list of jobs.

Retrieves jobs started by a specific schedule.

Retrieves the status of a job.

Retrieves details for a job step.

Retrieves the status of a job step.

Retrieves information for one license.

Retrieves all license data.

Retrieves the current license usage.

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

The getObjects command is used to retrieve 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.

Retrieves an installed plugin.

Retrieves all installed plugins.

Finds a procedure by its name.

Retrieves all procedures in a project.

Finds a project by its name.

Retrieves all projects.

Retrieves all properties associated with an object.

Retrieves the specified property value.

Retrieves all artifact repository objects known to the CloudBees Flow server.

Retrieves an artifact repository by its name.

Retrieves a resource by its name.

Retrieves all resources.

Retrieves a list of resources in a pool.

Retrieves a specified resource pool by name.

Retrieves a list of resource pools.

Retrieves resource usage information.

Retrieves a schedule by its name.

Retrieves all schedules.

Returns the status of the server.

Finds a state by name.

Retrieves all states in a workflow.

Finds a state definition by name.

Retrieves all state definitions in a workflow definition.

Retrieves a step from a procedure.

Retrieves all steps in a procedure.

Finds a transition by name.

Retrieves all transitions in a workflow.

Finds a transition by name.

Retrieves all transition definitions in a workflow definition.

Retrieves a user by name.

Retrieves all users.

Retrieves server version information.

Finds a workflow by name.

Retrieves all workflow instances in a project.

Finds a workflow definition by name.

Retrieves all workflow definitions in a project.

Retrieves a workspace by name.

Retrieves all workspaces.

Finds a zone by name.

Retrieves all zones.

Imports data from an XML export file.

Imports one or more licenses.

Atomically 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.

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

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.

Logs out of the client session.

Modifies an ACE on an object for a given principal.

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.

Modifies an existing artifact.

Modifies an existing artifact version.

Modifies an existing credential.

Modifies an existing LDAP directory provider.

Modifies an existing email configuration.

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

Modifies an existing formal parameter.

Modifies an existing gateway.

Modifies an existing group.

Modifies the status of an externally managed job.

Modifies the status of an externally managed job step.

Modifies an existing plugin.

Modifies an existing procedure.

Modifies an existing project.

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

Modifies an existing artifact repository.

Modifies an existing resource.

Modifies an existing resource pool.

Modifies an existing schedule.

Modifies an existing state definition.

Modifies an existing step.

Modifies an existing transition definition.

Modifies an existing user.

Modifies an existing workflow definition.

Modifies an existing workspace.

Modifies an existing zone.

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

Moves jobs from one project to another project.

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

Moves a state definition within a workflow definition.

Moves a step within a procedure.

Moves a transition definition within a workflow definition.

Pings all resources.

Pings one resources.

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.

Publishes an artifact version to an artifact repository.

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

Removes resources from a specified resource pool.

Removes one or more users from a particular group.

Restores ACL inheritance at the given object.

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

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

Runs the specified workflow definition, returns the workflow name.

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.

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.

Sets the name of a running job.

Sets the value for the specified property.

Shuts down the CloudBees Flow server.

Tests an LDAP directory provider.

Manually transition from the workflow active state.

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