API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

DeployerConfiguration

5 minute readReference

createDeployerConfiguration

Adds the deployer configuration to the deployer application.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

applicationName

String

The name of the application.

actualParameters

ActualParameter array

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step to inject after each phase or batch.

processName

String

The name of the application process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

String array

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

skipDeploy

Boolean

True to skip deployment to an environment.

snapshotName

String

The name of the snapshot.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createDeployerConfiguration(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

getDeployerConfiguration

Retrieves a deployer configuration.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

applicationName

String

The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeployerConfiguration(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

getDeployerConfigurations

Retrieves all configurations in the deployer.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

applicationName

String

The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeployerConfigurations(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

modifyDeployerConfiguration

Modifies a deployer configuration associated with a deployer application.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

applicationName

String

The name of the application.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

actualParameters

ActualParameter array

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

clearActualParameters

Boolean

True if the task should remove all actual parameters.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step to inject after each phase or batch.

newName

String

The new name for an existing object that is being renamed.

processName

String

The name of the application process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

String array

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

skipDeploy

Boolean

True to skip deployment to an environment.

snapshotName

String

The name of the snapshot.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDeployerConfiguration(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

removeDeployerConfiguration

Removes a deployer configuration associated with a deployer application.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

applicationName

String

The name of the application.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.removeDeployerConfiguration(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

validateDeployer

Validates the deployer configuration.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects.(Required)

releaseName

String

The name of the release.

stageName

String

The name of the stage of a pipeline attached to a release if specified.

applicationName

String

The name of the application.

actualParameters

ActualParameter array

Actual parameters.

applicationProjectName

String

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

deployerConfigurationName

String

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

String

The name of the deployer task defined in the provided stage.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Boolean

True to indicate a manual step to inject after each phase or batch.

processName

String

The name of the application process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

String array

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

snapshotName

String

The name of the snapshot.

validationType

String

The type of validation to perform (APPROVER for approver, PARAM for parameter, ENV for environment, ALL for all validations). Defaults to ALL.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.validateDeployer(
                projectName: 'test-projectName',
                /* optional arguments */)
▼
deployerapplication
deploymenthistoryitem