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

Port

5 minute readReference

createPort

[DEPRECATED] This API is deprecated. Creates a new port for a service, container or ServiceClusterMapping.

Arguments

Argument NameTypeDescription

projectName

String

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

portName

String

Name for the port; must be unique for a container or service or ServiceClusterMapping (Required)

serviceName

String

Name of the service which owns the port or which owns the container which owns the port

applicationEntityRevisionId

String

Revision Id of the versioned object

applicationName

String

Name of the application containing the service which owns the port.

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster to be used to resolve appication service mapping.

containerName

String

Name of the container which owns the port

containerPort

String

Container port for the container

environmentMapName

String

The name of the service environment name. If not provided, will use service name and environment name to resolve it.

environmentName

String

The name of the environment to which tierMap is mapped.

environmentProjectName

String

The name of the environment project to which tierMap is mapped.

listenerPort

String

listener port on the node

protocol

String

protocol

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Revisionid of the versioned object

subcontainer

String

Name of referencing container, when defining port info for a service.

subport

String

Name of container port for which values are being overridden at Service level.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deletePort

[DEPRECATED] This API is deprecated. Deletes a port

Arguments

Argument NameTypeDescription

projectName

String

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

portName

String

Name for the port; must be unique for a container or service or ServiceClusterMapping (Required)

serviceName

String

Name of the service which owns the port or which owns the container which owns the port

applicationName

String

Name of the application containing the service which owns the port.

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster to be used to resolve appication service mapping.

containerName

String

Name of the container which owns the port

environmentMapName

String

The name of the service environment name. If not provided, will use service name and environment name to resolve it.

environmentName

String

The name of the environment to which tierMap is mapped.

environmentProjectName

String

The name of the environment project to which tierMap is mapped.

serviceClusterMappingName

String

The name of the service cluster mapping.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPort

[DEPRECATED] This API is deprecated. Find a port by name.

Arguments

Argument NameTypeDescription

projectName

String

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

portName

String

Name for the port; must be unique for a container or service or ServiceClusterMapping (Required)

serviceName

String

Name of the service which owns the port or which owns the container which owns the port

applicationEntityRevisionId

String

Revision Id of the versioned object

applicationName

String

Name of the application containing the service which owns the port.

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster to be used to resolve appication service mapping.

containerName

String

Name of the container which owns the port

environmentMapName

String

The name of the service environment name. If not provided, will use service name and environment name to resolve it.

environmentName

String

The name of the environment to which tierMap is mapped.

environmentProjectName

String

The name of the environment project to which tierMap is mapped.

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Revisionid of the versioned object

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPorts

[DEPRECATED] This API is deprecated. Retrieve all ports for a container or service.

Arguments

Argument NameTypeDescription

projectName

String

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

serviceName

String

Name of the service which owns the port or which owns the container which owns the port

applicationEntityRevisionId

String

Revision Id of the versioned object

applicationName

String

Name of the application containing the service which owns the port.

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster to be used to resolve appication service mapping.

containerName

String

Name of the container which owns the port

environmentMapName

String

The name of the service environment name. If not provided, will use service name and environment name to resolve it.

environmentName

String

The name of the environment to which tierMap is mapped.

environmentProjectName

String

The name of the environment project to which tierMap is mapped.

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Revisionid of the versioned object

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyPort

[DEPRECATED] This API is deprecated. Modifies an existing port.

Arguments

Argument NameTypeDescription

projectName

String

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

portName

String

Name for the port; must be unique for a container or service or ServiceClusterMapping (Required)

serviceName

String

Name of the service which owns the port or which owns the container which owns the port

applicationEntityRevisionId

String

Revision Id of the versioned object

applicationName

String

Name of the application containing the service which owns the port.

applicationServiceMappingName

String

The name of the application service mapping.

clusterName

String

The name of the environment cluster to be used to resolve appication service mapping.

containerName

String

Name of the container which owns the port

containerPort

String

Container port for the container

environmentMapName

String

The name of the service environment name. If not provided, will use service name and environment name to resolve it.

environmentName

String

The name of the environment to which tierMap is mapped.

environmentProjectName

String

The name of the environment project to which tierMap is mapped.

listenerPort

String

listener port on the node

newName

String

New name for an existing object that is being renamed.

protocol

String

protocol

serviceClusterMappingName

String

The name of the service cluster mapping.

serviceEntityRevisionId

String

Revisionid of the versioned object

subcontainer

String

Name of referencing container, when defining port info for a service.

subport

String

Name of container port for which values are being overridden at Service level.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPort(
                projectName: 'test-projectName',
                portName: 'test-portName'
                /* optional arguments */)
pluginconfiguration
procedure