Documentation
Software Delivery Automation
CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform
CloudBees Platform
CloudBees.io CloudBees Feature Management CloudBees Release Orchestration SaaS CloudBees Value Stream 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 Release Orchestration SaaS CloudBees Build Acceleration
AI HelpBeta
Search
Enable dark mode
New to CloudBees or returning.
Sign in / Sign up

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 CloudBees Release Orchestration SaaS CloudBees Value Stream Management

Other CloudBees Products

CloudBees Build Acceleration CloudBees CodeShip CloudBees Jenkins Platform

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)

latest (2024.03.0)2023.12.0 2023.10.0 2023.08.0 2023.06.0 2023.04.0

2023.03.0 (Legacy)2023.02.0 (Legacy)

deleteAccessToken getAccessTokens getUserAccessToken getUserAccessTokens getUserAccessTokenSessions revokeToken

breakAclInheritance checkAccess createAclEntry deleteAclEntry getAccess getAclEntry modifyAclEntry restoreAclInheritance

countApplicationEnvironmentInventoryObjects createApplication deleteApplication getApplication getApplicationEnvironmentInventory getApplications modifyApplication

createApplicationDependency deleteApplicationDependency getApplicationDependencies modifyApplicationDependency

addComponentToApplicationTier createApplicationTier deleteApplicationTier getApplicationTier getApplicationTiers getApplicationTiersInComponent modifyApplicationTier

createArchiveConnector deleteArchiveConnector getArchiveConnector getArchiveConnectors modifyArchiveConnector

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

createCatalog createCatalogItem deleteCatalog deleteCatalogItem deleteCatalogItemRun getCatalog getCatalogItem getCatalogItems getCatalogs modifyCatalog modifyCatalogItem runCatalogItem

getDeploymentHistoryItems getEntityChange getEntityChangeDetails pruneChangeHistory revert searchEntityChange

getCIBuildAuditReport getCIBuildLog

createCIBuildDetail deleteCIBuildDetail getCIBuildDetail getCIBuildDetails modifyCIBuildDetail setCIBuildDetail

createCIConfiguration deleteCIConfiguration getCIConfiguration getCIConfigurations modifyCIConfiguration

getCIEventsSchema

getCIJob getCIJobParameters getCIJobs

createCluster deleteCluster doActionOnRealtimeCluster getCluster getClusters getRealtimeClusterDetails getRealtimeClusterTopology modifyCluster

copyComponent createComponent deleteComponent getComponent getComponents getComponentsInApplicationTier modifyComponent removeComponentFromApplicationTier

addCredentialToPluginConfiguration attachCredential createCredential deleteCredential detachCredential getCredential getCredentials getFullCredential modifyCredential

createCredentialProvider deleteCredentialProvider getCredentialProvider getCredentialProviders modifyCredentialProvider

createSearchFilter deleteSearchFilter getSearchFilter getSearchFilters modifySearchFilter

createDashboard deleteDashboard getDashboard getDashboards modifyDashboard

createDashboardColumn deleteDashboardColumn modifyDashboardColumn

createDataRetentionPolicy deleteDataRetentionPolicy getDataRetentionPolicies getDataRetentionPolicy modifyDataRetentionPolicy

getDatabaseConfiguration setDatabaseConfiguration

createDeployerApplication createDeployerConfiguration getDeployerApplication getDeployerApplications getDeployerConfiguration getDeployerConfigurations getPipelineStageRuntimeDeployerTasks modifyDeployerApplication modifyDeployerConfiguration removeDeployerApplication removeDeployerConfiguration validateDeployer

createDevOpsInsightDataSource deleteDevOpsInsightDataSource getDevOpsInsightDataSource getDevOpsInsightDataSources modifyDevOpsInsightDataSource

createDirectoryProvider deleteDirectoryProvider getDirectoryProvider getDirectoryProviders modifyDirectoryProvider moveDirectoryProvider testDirectoryProvider

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

createEmailConfig deleteEmailConfig getEmailConfig getEmailConfigs modifyEmailConfig

createEmailNotifier createEventSubscription deleteEmailNotifier deleteEventSubscription getEmailNotifier getEmailNotifiers getEventSubscription getEventSubscriptions modifyEmailNotifier modifyEventSubscription sendEmail

createEnvironment createEnvironmentInventoryItem createReservation deleteEnvironment deleteEnvironmentInventoryItem deleteReservation getEnvironment getEnvironmentApplications getEnvironmentDeployments getEnvironmentInventory getEnvironmentInventoryItem getEnvironmentInventoryItems getEnvironments getReservation getReservations getRunSchedules modifyEnvironment modifyEnvironmentInventoryItem modifyReservation seedEnvironmentInventory tearDownEnvironment

addResourcesToEnvironmentTier createEnvironmentTier deleteEnvironmentTier getEnvironmentTier getEnvironmentTiers modifyEnvironmentTier removeResourcesFromEnvironmentTier

createGateway deleteGateway getGateway getGateways modifyGateway

addUsersToGroup assignPersonaToGroup createGroup deleteGroup getGroup getGroups getPersonaGroups modifyGroup removeUsersFromGroup unassignPersonaFromGroup

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

createKerberosKeytab createKerberosKeytabEntry deleteKerberosKeytab deleteKerberosKeytabEntry getKerberosKeytab getKerberosKeytabs modifyKerberosKeytab

createMicroservice deleteMicroservice getMicroservice getMicroservices modifyMicroservice

createMicroserviceMapping deleteMicroserviceMapping modifyMicroserviceMapping

changeOwner clone evalDsl evalScript export generateDsl import logStatistic

countObjects deleteObjects describeObject describeObjectTypeDslStructure findObjects getEntityPath getObjectDslStructure getObjects getPathToProperty getPropertyHierarchy

createTag deleteTag getTag getTags modifyTag tagObject untagObject

attachParameter createActualParameter createFormalOutputParameter createFormalParameter deleteActualParameter deleteFormalOutputParameter deleteFormalParameter detachParameter getActualParameter getActualParameters getFormalOutputParameter getFormalOutputParameters getFormalParameter getFormalParameters getOutputParameter getOutputParameters modifyActualParameter modifyFormalOutputParameter modifyFormalParameter setOutputParameter

addPageToPersonaCategory addPersonaDetail addPersonaSubpage assignPersonaToUser createPersona createPersonaCategory createPersonaPage deletePersona deletePersonaCategory deletePersonaPage getPersona getPersonaCategories getPersonaCategory getPersonaPage getPersonaPages getPersonas getPersonaUsers modifyPersona modifyPersonaCategory modifyPersonaPage removePersonaDetail removePersonaSubpage unassignPersonaFromUser

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

deletePlugin exportPlugin getPlugin getPlugins installPlugin modifyPlugin promotePlugin uninstallPlugin

getPluginCatalog

createPluginConfiguration deletePluginConfiguration getPluginConfiguration getPluginConfigurations modifyPluginConfiguration

createProcedure createStep deleteProcedure deleteStep getProcedure getProcedures getStep getSteps modifyProcedure modifyStep moveStep

createProcess deleteProcess getProcess getProcesses modifyProcess runProcess

createProcessDependency deleteProcessDependency getProcessDependencies modifyProcessDependency

completeManualProcessStep createProcessStep deleteProcessStep getProcessStep getProcessSteps modifyProcessStep retryProcessStep

createProject deleteProject getProject getProjects modifyProject

createProperty deleteProperty expandString findProperties getProperties getProperty incrementProperty modifyProperty setProperty

addSubrelease completeRelease createRelease deleteRelease getRelease getReleases getReleaseTimelineDetails getSubrelease getSubreleases modifyRelease removeSubrelease startRelease

createReport deleteReport getReport getReports modifyReport runLicenseReport runReport runUserReport sendReportingData

createReportObjectAssociation deleteReportObjectAssociation getReportObjectAssociation getReportObjectAssociations modifyReportObjectAssociation

createReportObjectAttribute deleteReportObjectAttribute getReportObjectAttribute getReportObjectAttributes getReportObjectAttributeValues modifyReportObjectAttribute

createReportObjectType deleteReportObjectType getReportObjectType getReportObjectTypes modifyReportObjectType

createReportingFilter deleteReportingFilter getReportingFilter getReportingFilters modifyReportingFilter

addResourcesToPool addResourceToEnvironmentTier createResource createResourcePool deleteResource deleteResourcePool getResource getResourcePool getResourcePools getResources getResourcesInEnvironmentTier getResourcesInPool getResourceUsage modifyResource modifyResourcePool pingAllResources pingResource removeResourceFromEnvironmentTier removeResourcesFromPool runDiscovery tearDownResource tearDownResourcePool

createRollingDeployPhase deleteRollingDeployPhase getRollingDeployPhase getRollingDeployPhases modifyRollingDeployPhase setTierResourcePhase

createSchedule deleteSchedule getSchedule getSchedules modifySchedule

createScmSync deleteScmSync getScmSync getScmSyncs modifyScmSync runScmSync

createApplicationFromDeploymentPackage deleteLicense getAdminLicense getDashboardVisualizations getDevOpsInsightServerConfiguration getLicense getLicenseDetails getLicenses getLicenseUsage getServerConfiguration getServerInfo getServerPublicKey getServerSettings getServerStatus getSsoConfiguration getStatsdConfiguration getVersions importLicenseData setCIEventsSchemaConfiguration setDevOpsInsightServerConfiguration setSsoConfiguration setStatsdConfiguration shutdownServer

getServerSettingsCategories

createServiceAccount deleteServiceAccount getServiceAccount getServiceAccounts modifyServiceAccount

createSession createUserAccessToken deleteSession getSessions loginSso modifySession modifyUserAccessToken revokeUserAccessToken revokeUserAccessTokens

createOpenIDConnectConfiguration deleteOpenIDConnectConfiguration getOpenIDConnectConfiguration getOpenIDConnectConfigurations modifyOpenIDConnectConfiguration

createSamlIdentityProvider createSamlServiceProvider deleteSamlIdentityProvider deleteSamlServiceProvider getSamlIdentityProvider getSamlIdentityProviders getSamlServiceProvider getSamlServiceProviderMetadata getSamlServiceProviders modifySamlIdentityProvider modifySamlServiceProvider

createSnapshot deleteSnapshot getPartialApplicationRevision getSnapshot getSnapshotEnvironments getSnapshots modifySnapshot

createEnvironmentTemplateTierMapping createTierMap createTierMapping deleteTierMap deleteTierMapping getTierMaps modifyEnvironmentTemplateTierMapping modifyTierMap modifyTierMapping

createTrigger createTriggerErrorDetail deleteTrigger deleteTriggerErrorDetail getTrigger getTriggerErrorDetails getTriggers modifyTrigger runTrigger setupWebhook

createUser deleteUser getUser getUsers login logout modifyUser

createUserEmail deleteUserEmail getUserEmail getUserEmails modifyUserEmail verifyUserEmail

createUtilityResource deleteUtilityResource getUtilityResource getUtilityResources modifyUtilityResource

completeRuntimeWaitDependency createWaitDependency deleteWaitDependency getRuntimeWaitDependencies getWaitDependencies getWaitDependency modifyWaitDependency

processWebhookTrigger

createWidget deleteWidget getWidget getWidgets modifyWidget moveWidget

createWidgetFilterOverride deleteWidgetFilterOverride getWidgetFilterOverride getWidgetFilterOverrides modifyWidgetFilterOverride

completeWorkflow deleteWorkflow getState getStates getTransition getTransitions getWorkflow getWorkflows runWorkflow transitionWorkflow

createStateDefinition createTransitionDefinition createWorkflowDefinition deleteStateDefinition deleteTransitionDefinition deleteWorkflowDefinition getStateDefinition getStateDefinitions getTransitionDefinition getTransitionDefinitions getWorkflowDefinition getWorkflowDefinitions modifyStateDefinition modifyTransitionDefinition modifyWorkflowDefinition moveStateDefinition moveTransitionDefinition

createWorkspace deleteWorkspace getWorkspace getWorkspaces modifyWorkspace

createZone deleteZone getZone getZones modifyZone

getGateways

On this page

Summary
Usage

Summary

Retrieves all gateways.

Usage

Perl

$cmdr->getGateways();▼

ectool

ectool getGateways▼

© CloudBees, Inc. 2010 - 2024

Privacy Policy|Legal Notices|Security