Documentation
Software Delivery Automation
CloudBees Software Delivery Automation
CloudBees CI
CloudBees CD/RO
CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
CloudBees Platform
CloudBees.io
CloudBees Feature Management
Resources
Account management
cbsupport CLI
Legal and policies
Training
Support
Plugins
CloudBees CI Plugins
CloudBees CD/RO Plugins
Lexicon
CloudBees CI
CloudBees CD/RO
CloudBees Feature Management
CloudBees Build Acceleration
AI Help
Beta
Search
Enable dark mode
New to CloudBees or returning.
Sign in / Sign up
CloudBees CD/RO
Resources
Account management
cbsupport CLI
Legal and policies
Software Delivery Automation
CloudBees Software Delivery Automation
CloudBees CI
CloudBees CD/RO
CloudBees Previews
CloudBees Platform
CloudBees.io
CloudBees Feature Management
Other CloudBees Products
CloudBees Build Acceleration
CloudBees CodeShip
Perl API reference
Documentation
DSL API reference
ectool API reference
Groovy API reference
Perl API reference
REST API reference
Plugin developer kit
Plugin documentation
Technical evaluation
Lexicon
Release notes
Knowledge Base
Automation Platform (Legacy)
API reference (Legacy)
2023.03.0 (Legacy)
latest (2024.06.0)
2024.03.0
2023.12.0
2023.10.0
Legacy Versions
2023.08.0 (Legacy)
2023.06.0 (Legacy)
2023.04.0 (Legacy)
2023.03.0 (Legacy)
2023.02.0 (Legacy)
Introduction
CloudBees CD/RO Perl API commands (Preview)
Index
Commands
Access token
deleteAccessToken
getAccessTokens
getUserAccessToken
getUserAccessTokens
getUserAccessTokenSessions
revokeToken
ACL
breakAclInheritance
checkAccess
createAclEntry
deleteAclEntry
getAccess
getAclEntry
modifyAclEntry
restoreAclInheritance
Application
countApplicationEnvironmentInventoryObjects
createApplication
deleteApplication
getApplication
getApplicationEnvironmentInventory
getApplications
modifyApplication
Application dependency
createApplicationDependency
deleteApplicationDependency
getApplicationDependencies
modifyApplicationDependency
Application tier
addComponentToApplicationTier
createApplicationTier
deleteApplicationTier
getApplicationTier
getApplicationTiers
getApplicationTiersInComponent
modifyApplicationTier
Archive connector
createArchiveConnector
deleteArchiveConnector
getArchiveConnector
getArchiveConnectors
modifyArchiveConnector
Artifact
addDependentsToArtifactVersion
cleanupArtifactCache
cleanupRepository
createArtifact
createArtifactVersion
createRepository
deleteArtifact
deleteArtifactVersion
deleteRepository
findArtifactVersions
getArtifact
getArtifacts
getArtifactVersion
getArtifactVersions
getManifest
getRepositories
getRepository
getRetrievedArtifacts
modifyArtifact
modifyArtifactVersion
modifyRepository
moveRepository
publishArtifactVersion
removeDependentsFromArtifactVersion
retrieveArtifactVersions
updateArtifactVersion
Catalog
createCatalog
createCatalogItem
deleteCatalog
deleteCatalogItem
deleteCatalogItemRun
getCatalog
getCatalogItem
getCatalogItems
getCatalogs
modifyCatalog
modifyCatalogItem
runCatalogItem
Change history
getDeploymentHistoryItems
getEntityChange
getEntityChangeDetails
pruneChangeHistory
revert
searchEntityChange
CI build
getCIBuildAuditReport
getCIBuildLog
CI build detail
createCIBuildDetail
deleteCIBuildDetail
getCIBuildDetail
getCIBuildDetails
modifyCIBuildDetail
setCIBuildDetail
CI configuration
createCIConfiguration
deleteCIConfiguration
getCIConfiguration
getCIConfigurations
modifyCIConfiguration
CI event
getCIEventsSchema
CI job
getCIJob
getCIJobParameters
getCIJobs
Cluster
createCluster
deleteCluster
doActionOnRealtimeCluster
getCluster
getClusters
getRealtimeClusterDetails
getRealtimeClusterTopology
modifyCluster
Components
copyComponent
createComponent
deleteComponent
getComponent
getComponents
getComponentsInApplicationTier
modifyComponent
removeComponentFromApplicationTier
Credential
addCredentialToPluginConfiguration
attachCredential
createCredential
deleteCredential
detachCredential
getCredential
getCredentials
getFullCredential
modifyCredential
Credential provider
createCredentialProvider
deleteCredentialProvider
getCredentialProvider
getCredentialProviders
modifyCredentialProvider
Custom filter
createSearchFilter
deleteSearchFilter
getSearchFilter
getSearchFilters
modifySearchFilter
Dashboard
createDashboard
deleteDashboard
getDashboard
getDashboards
modifyDashboard
Dashboard column
createDashboardColumn
deleteDashboardColumn
modifyDashboardColumn
Data retention policy
createDataRetentionPolicy
deleteDataRetentionPolicy
getDataRetentionPolicies
getDataRetentionPolicy
modifyDataRetentionPolicy
Database configuration
getDatabaseConfiguration
setDatabaseConfiguration
Deployer application
createDeployerApplication
createDeployerConfiguration
getDeployerApplication
getDeployerApplications
getDeployerConfiguration
getDeployerConfigurations
getPipelineStageRuntimeDeployerTasks
modifyDeployerApplication
modifyDeployerConfiguration
removeDeployerApplication
removeDeployerConfiguration
validateDeployer
DevOps Insight data source
createDevOpsInsightDataSource
deleteDevOpsInsightDataSource
getDevOpsInsightDataSource
getDevOpsInsightDataSources
modifyDevOpsInsightDataSource
Directory provider
createDirectoryProvider
deleteDirectoryProvider
getDirectoryProvider
getDirectoryProviders
modifyDirectoryProvider
moveDirectoryProvider
testDirectoryProvider
Dynamic environment
addResourcePoolToEnvironmentTier
addResourceTemplateToEnvironmentTemplateTier
addResourceToEnvironmentTemplateTier
createEnvironmentTemplate
createEnvironmentTemplateTier
createEnvironmentTemplateTierMap
createHook
createResourceTemplate
deleteEnvironmentTemplate
deleteEnvironmentTemplateTier
deleteEnvironmentTemplateTierMap
deleteEnvironmentTemplateTierMapping
deleteHook
deleteResourceTemplate
getAvailableResourcesForEnvironment
getEnvironmentTemplate
getEnvironmentTemplates
getEnvironmentTemplateTier
getEnvironmentTemplateTierMaps
getEnvironmentTemplateTiers
getHook
getHooks
getProvisionedEnvironments
getResourcePoolsInEnvironmentTier
getResourcesInEnvironmentTemplateTier
getResourceTemplate
getResourceTemplates
getResourceTemplatesInEnvironmentTemplateTier
modifyEnvironmentTemplate
modifyEnvironmentTemplateTier
modifyEnvironmentTemplateTierMap
modifyEnvTemplTierResourceTemplMapping
modifyHook
modifyResourceTemplate
provisionEnvironment
provisionResourcePool
removeResourceFromEnvironmentTemplateTier
removeResourcePoolFromEnvironmentTier
removeResourceTemplateFromEnvironmentTemplateTier
Email configuration
createEmailConfig
deleteEmailConfig
getEmailConfig
getEmailConfigs
modifyEmailConfig
Email notifier
createEmailNotifier
createEventSubscription
deleteEmailNotifier
deleteEventSubscription
getEmailNotifier
getEmailNotifiers
getEventSubscription
getEventSubscriptions
modifyEmailNotifier
modifyEventSubscription
sendEmail
Environment
createEnvironment
createEnvironmentInventoryItem
createReservation
deleteEnvironment
deleteEnvironmentInventoryItem
deleteReservation
getEnvironment
getEnvironmentApplications
getEnvironmentDeployments
getEnvironmentInventory
getEnvironmentInventoryItem
getEnvironmentInventoryItems
getEnvironments
getReservation
getReservations
getRunSchedules
modifyEnvironment
modifyEnvironmentInventoryItem
modifyReservation
seedEnvironmentInventory
tearDownEnvironment
Environment tier
addResourcesToEnvironmentTier
createEnvironmentTier
deleteEnvironmentTier
getEnvironmentTier
getEnvironmentTiers
modifyEnvironmentTier
removeResourcesFromEnvironmentTier
Gateway
createGateway
deleteGateway
getGateway
getGateways
modifyGateway
Group
addUsersToGroup
assignPersonaToGroup
createGroup
deleteGroup
getGroup
getGroups
getPersonaGroups
modifyGroup
removeUsersFromGroup
unassignPersonaFromGroup
Job
abortAllJobs
abortJob
abortJobStep
completeJob
completeJobStep
countJobSteps
createJob
createJobStep
deleteJob
findJobSteps
getJobDetails
getJobInfo
getJobNotes
getJobs
getJobsForSchedule
getJobStatus
getJobStepDetails
getJobStepStatus
getJobSummaries
getJobSummary
modifyJob
modifyJobStep
moveJobs
provisionCluster
runProcedure
setJobName
waitForJob
Kerberos keytab
createKerberosKeytab
createKerberosKeytabEntry
deleteKerberosKeytab
deleteKerberosKeytabEntry
getKerberosKeytab
getKerberosKeytabs
modifyKerberosKeytab
Microservice
createMicroservice
deleteMicroservice
getMicroservice
getMicroservices
modifyMicroservice
Microservice mapping
createMicroserviceMapping
deleteMicroserviceMapping
modifyMicroserviceMapping
Miscellaneous
changeOwner
clone
evalDsl
evalScript
export
generateDsl
import
logStatistic
Object
countObjects
deleteObjects
describeObject
describeObjectTypeDslStructure
findObjects
getEntityPath
getObjectDslStructure
getObjects
getPathToProperty
getPropertyHierarchy
Object tag
createTag
deleteTag
getTag
getTags
modifyTag
tagObject
untagObject
Parameter
attachParameter
createActualParameter
createFormalOutputParameter
createFormalParameter
deleteActualParameter
deleteFormalOutputParameter
deleteFormalParameter
detachParameter
getActualParameter
getActualParameters
getFormalOutputParameter
getFormalOutputParameters
getFormalParameter
getFormalParameters
getOutputParameter
getOutputParameters
modifyActualParameter
modifyFormalOutputParameter
modifyFormalParameter
setOutputParameter
Persona
addPageToPersonaCategory
addPersonaDetail
addPersonaSubpage
assignPersonaToUser
createPersona
createPersonaCategory
createPersonaPage
deletePersona
deletePersonaCategory
deletePersonaPage
getPersona
getPersonaCategories
getPersonaCategory
getPersonaPage
getPersonaPages
getPersonas
getPersonaUsers
modifyPersona
modifyPersonaCategory
modifyPersonaPage
removePersonaDetail
removePersonaSubpage
unassignPersonaFromUser
Pipeline
abortAllPipelineRuns
abortPipelineRun
attachPipelineRun
completeManualTask
createGate
createNote
createPipeline
createStage
createTask
createTaskGroup
deleteGate
deleteNote
deletePipeline
deletePipelineRun
deleteStage
deleteTask
detachPipelineRun
getAllWaitingTasks
getAttachedPipelineRuns
getGate
getNote
getNotes
getPipeline
getPipelineRunAuditReport
getPipelineRuntimeDetails
getPipelineRuntimes
getPipelines
getPipelineStageRuntimeTasks
getReleaseInventory
getRunHierarchy
getStage
getStages
getTask
getTasks
getWaitingTasks
modifyGate
modifyNote
modifyPipeline
modifyStage
modifyTask
pausePipelineRun
removeTaskGroup
restartPipelineRun
resumePipelineRun
retryTask
runFutureTask
runPipeline
setPipelineRunName
waitForFlowRuntime
Plugin
deletePlugin
exportPlugin
getPlugin
getPlugins
installPlugin
modifyPlugin
promotePlugin
uninstallPlugin
Plugin catalog
getPluginCatalog
Plugin configuration
createPluginConfiguration
deletePluginConfiguration
getPluginConfiguration
getPluginConfigurations
modifyPluginConfiguration
Procedure
createProcedure
createStep
deleteProcedure
deleteStep
getProcedure
getProcedures
getStep
getSteps
modifyProcedure
modifyStep
moveStep
Process
createProcess
deleteProcess
getProcess
getProcesses
modifyProcess
runProcess
Process dependency
createProcessDependency
deleteProcessDependency
getProcessDependencies
modifyProcessDependency
Process step
completeManualProcessStep
createProcessStep
deleteProcessStep
getProcessStep
getProcessSteps
modifyProcessStep
retryProcessStep
Project
createProject
deleteProject
getProject
getProjects
modifyProject
Property
createProperty
deleteProperty
expandString
findProperties
getProperties
getProperty
incrementProperty
modifyProperty
setProperty
Release
addSubrelease
completeRelease
createRelease
deleteRelease
getRelease
getReleases
getReleaseTimelineDetails
getSubrelease
getSubreleases
modifyRelease
removeSubrelease
startRelease
Report
createReport
deleteReport
getReport
getReports
modifyReport
runLicenseReport
runReport
runUserReport
sendReportingData
Report object association
createReportObjectAssociation
deleteReportObjectAssociation
getReportObjectAssociation
getReportObjectAssociations
modifyReportObjectAssociation
Report object attribute
createReportObjectAttribute
deleteReportObjectAttribute
getReportObjectAttribute
getReportObjectAttributes
getReportObjectAttributeValues
modifyReportObjectAttribute
Report object type
createReportObjectType
deleteReportObjectType
getReportObjectType
getReportObjectTypes
modifyReportObjectType
Reporting filter
createReportingFilter
deleteReportingFilter
getReportingFilter
getReportingFilters
modifyReportingFilter
Resource
addResourcesToPool
addResourceToEnvironmentTier
createResource
createResourcePool
deleteResource
deleteResourcePool
getResource
getResourcePool
getResourcePools
getResources
getResourcesInEnvironmentTier
getResourcesInPool
getResourceUsage
modifyResource
modifyResourcePool
pingAllResources
pingResource
removeResourceFromEnvironmentTier
removeResourcesFromPool
runDiscovery
tearDownResource
tearDownResourcePool
Rolling deploy
createRollingDeployPhase
deleteRollingDeployPhase
getRollingDeployPhase
getRollingDeployPhases
modifyRollingDeployPhase
setTierResourcePhase
Schedule
createSchedule
deleteSchedule
getSchedule
getSchedules
modifySchedule
SCM sync
createScmSync
deleteScmSync
getScmSync
getScmSyncs
modifyScmSync
runScmSync
Server
createApplicationFromDeploymentPackage
deleteLicense
getAdminLicense
getDashboardVisualizations
getDevOpsInsightServerConfiguration
getLicense
getLicenseDetails
getLicenses
getLicenseUsage
getServerConfiguration
getServerInfo
getServerPublicKey
getServerSettings
getServerStatus
getSsoConfiguration
getStatsdConfiguration
getVersions
importLicenseData
setCIEventsSchemaConfiguration
setDevOpsInsightServerConfiguration
setSsoConfiguration
setStatsdConfiguration
shutdownServer
Server settings category
getServerSettingsCategories
Service accounts for webhooks
createServiceAccount
deleteServiceAccount
getServiceAccount
getServiceAccounts
modifyServiceAccount
Session
createSession
createUserAccessToken
deleteSession
getSessions
loginSso
modifySession
modifyUserAccessToken
revokeUserAccessToken
revokeUserAccessTokens
Single sign-on for OpenID Connect
createOpenIDConnectConfiguration
deleteOpenIDConnectConfiguration
getOpenIDConnectConfiguration
getOpenIDConnectConfigurations
modifyOpenIDConnectConfiguration
Single sign-on for SAML
createSamlIdentityProvider
createSamlServiceProvider
deleteSamlIdentityProvider
deleteSamlServiceProvider
getSamlIdentityProvider
getSamlIdentityProviders
getSamlServiceProvider
getSamlServiceProviderMetadata
getSamlServiceProviders
modifySamlIdentityProvider
modifySamlServiceProvider
Snapshot
createSnapshot
deleteSnapshot
getPartialApplicationRevision
getSnapshot
getSnapshotEnvironments
getSnapshots
modifySnapshot
Tier map
createEnvironmentTemplateTierMapping
createTierMap
createTierMapping
deleteTierMap
deleteTierMapping
getTierMaps
modifyEnvironmentTemplateTierMapping
modifyTierMap
modifyTierMapping
Trigger
createTrigger
createTriggerErrorDetail
deleteTrigger
deleteTriggerErrorDetail
getTrigger
getTriggerErrorDetails
getTriggers
modifyTrigger
runTrigger
setupWebhook
User
createUser
deleteUser
getUser
getUsers
login
logout
modifyUser
User email
createUserEmail
deleteUserEmail
getUserEmail
getUserEmails
modifyUserEmail
verifyUserEmail
Utility resource
createUtilityResource
deleteUtilityResource
getUtilityResource
getUtilityResources
modifyUtilityResource
Wait dependency
completeRuntimeWaitDependency
createWaitDependency
deleteWaitDependency
getRuntimeWaitDependencies
getWaitDependencies
getWaitDependency
modifyWaitDependency
Webhook result
processWebhookTrigger
Widget
createWidget
deleteWidget
getWidget
getWidgets
modifyWidget
moveWidget
Widget filter override
createWidgetFilterOverride
deleteWidgetFilterOverride
getWidgetFilterOverride
getWidgetFilterOverrides
modifyWidgetFilterOverride
Work item
getWorkItems
Workflow
completeWorkflow
deleteWorkflow
getState
getStates
getTransition
getTransitions
getWorkflow
getWorkflows
runWorkflow
transitionWorkflow
Workflow definition
createStateDefinition
createTransitionDefinition
createWorkflowDefinition
deleteStateDefinition
deleteTransitionDefinition
deleteWorkflowDefinition
getStateDefinition
getStateDefinitions
getTransitionDefinition
getTransitionDefinitions
getWorkflowDefinition
getWorkflowDefinitions
modifyStateDefinition
modifyTransitionDefinition
modifyWorkflowDefinition
moveStateDefinition
moveTransitionDefinition
Workspace
createWorkspace
deleteWorkspace
getWorkspace
getWorkspaces
modifyWorkspace
Zone
createZone
deleteZone
getZone
getZones
modifyZone
getZones
On this page
Summary
Usage
Back to index
Summary
Retrieves all zones.
Usage
Perl
$cmdr->getZones();
▼
ectool
ectool getZones
▼
Submit Feedback