Using the Perl API
Perl API response and element glossary
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory 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
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

Repository

2 minute readReference

createRepository

Creates a new artifact repository.

Arguments

Argument Name Type Description

repositoryName

String

The repository name. (Required)

description

String

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

repositoryDisabled

Boolean

Whether or not to disable the repository.

url

String

The url for contacting the repository.

zoneName

String

The zone name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createRepository(
                repositoryName: 'test-repositoryName'
                /* optional arguments */)

deleteRepository

Deletes an artifact repository.

Arguments

Argument Name Type Description

repositoryName

String

The repository name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteRepository(
                repositoryName: 'test-repositoryName')

getRepositories

Retrieve all artifact repositories.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getRepositories()

getRepository

Retrieve an artifact repository by name.

Arguments

Argument Name Type Description

repositoryName

String

The repository name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getRepository(
                repositoryName: 'test-repositoryName')

modifyRepository

Modifies an existing artifact repository.

Arguments

Argument Name Type Description

repositoryName

String

The repository name. (Required)

description

String

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

newName

String

New name for an existing object that is being renamed.

repositoryDisabled

Boolean

Whether or not to disable the repository.

url

String

The url for contacting the repository.

zoneName

String

The zone name.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyRepository(
                repositoryName: 'test-repositoryName'
                /* optional arguments */)

moveRepository

Move an artifact repository in front of another, specified repository or at the end of the list.

Arguments

Argument Name Type Description

repositoryName

String

The repository name. (Required)

beforeRepositoryName

String

Used when reordering the artifact repositories: the repository is moved to a position just before this repository. Blank means move the repository to the end of the artifact repository list.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.moveRepository(
                repositoryName: 'test-repositoryName'
                /* optional arguments */)
reportobjecttype
reservation