Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcontainercredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginpluginconfigurationportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserversettingserversettingcategoryserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Gateway

2 minute readReference

createGateway

Creates a new gateway.

Arguments

Argument NameTypeDescription

gatewayName

String

The gateway name. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

gatewayDisabled

Boolean

True means this artifact repository is disabled.

hostName1

String

The domain name or IP address resourceName2 uses to send messages to resourceName1.

hostName2

String

The domain name or IP address resourceName1 uses to send messages to resourceName2.

port1

Integer

Port number resourceName2 uses to send messages to resourceName1.

port2

Integer

Port number resourceName1 uses to send messages to resourceName2.

resourceName1

String

The name of the first resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName2’s zone.

resourceName2

String

The name of the second resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName1’s zone.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createGateway(
                gatewayName: 'test-gatewayName'
                /* optional arguments */)

deleteGateway

Deletes a gateway.

Arguments

Argument NameTypeDescription

gatewayName

String

The gateway name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteGateway(
                gatewayName: 'test-gatewayName')

getGateway

Find a gateway by name.

Arguments

Argument NameTypeDescription

gatewayName

String

The gateway name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getGateway(
                gatewayName: 'test-gatewayName')

getGateways

Retrieve all gateways.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getGateways()

modifyGateway

Modifies a gateway.

Arguments

Argument NameTypeDescription

gatewayName

String

The gateway name. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

gatewayDisabled

Boolean

True means this artifact repository is disabled.

hostName1

String

The domain name or IP address resourceName2 uses to send messages to resourceName1.

hostName2

String

The domain name or IP address resourceName1 uses to send messages to resourceName2.

newName

String

New name for an existing object that is being renamed.

port1

Integer

Port number resourceName2 uses to send messages to resourceName1.

port2

Integer

Port number resourceName1 uses to send messages to resourceName2.

resourceName1

String

The name of the first resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName2’s zone.

resourceName2

String

The name of the second resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName1’s zone.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyGateway(
                gatewayName: 'test-gatewayName'
                /* optional arguments */)
gate
group