CloudBees CD/RO Perl API commands

Commands

Artifact

Catalog

createCatalog

createCatalogItem

createTemplateCatalogItem

Change history

getDeploymentHistoryItems

getEntityChange

getEntityChangeDetails

pruneChangeHistory

revert

searchEntityChange

CI build

getCIBuildAuditReport

getCIBuildLog

CI build detail

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

getComponentsInApplicationTier

modifyComponent

removeComponentFromApplicationTier

Credential

addCredentialToPluginConfiguration

Credential provider

createCredentialProvider

deleteCredentialProvider

getCredentialProvider

getCredentialProviders

modifyCredentialProvider

Custom filter

Dashboard

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

Email notifier

createEmailNotifier

createEventSubscription

deleteEmailNotifier

deleteEventSubscription

getEmailNotifier

getEmailNotifiers

getEventSubscription

getEventSubscriptions

modifyEmailNotifier

modifyEventSubscription

sendEmail

Environment

Environment tier

addResourcesToEnvironmentTier

createEnvironmentTier

deleteEnvironmentTier

getEnvironmentTier

getEnvironmentTiers

modifyEnvironmentTier

removeResourcesFromEnvironmentTier

Gateway

Group

unassignPersonaFromGroup

Job

Microservice

Microservice mapping

createMicroserviceMapping

deleteMicroserviceMapping

modifyMicroserviceMapping

Miscellaneous

Not Defined

cleanupStalledJob

Object

countObjects

deleteObjects

describeObject

describeObjectTypeDslStructure

findObjects

getEntityPath

getObjectDslStructure

getObjects

getPathToProperty

getPropertyHierarchy

Object tag

Parameter

Persona

Pipeline

Plugin

Plugin catalog

getPluginCatalog

Plugin configuration

createPluginConfiguration

deletePluginConfiguration

getPluginConfiguration

getPluginConfigurations

modifyPluginConfiguration

Procedure

Process

Process dependency

createProcessDependency

deleteProcessDependency

getProcessDependencies

modifyProcessDependency

Process step

completeManualProcessStep

Project

Property

Release

getReleaseTimelineDetails

Report

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

Rolling deploy

createRollingDeployPhase

deleteRollingDeployPhase

getRollingDeployPhase

getRollingDeployPhases

modifyRollingDeployPhase

setTierResourcePhase

Schedule

SCM sync

Server

Server settings category

getServerSettingsCategories

Service accounts for webhooks

Session

createSession

createUserAccessToken

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

modifyEnvironmentTemplateTierMapping

modifyTierMap

modifyTierMapping

Trigger

createTrigger

createTriggerErrorDetail

deleteTrigger

deleteTriggerErrorDetail

getTrigger

getTriggerErrorDetails

User

User email

Utility resource

createUtilityResource

deleteUtilityResource

getUtilityResource

getUtilityResources

modifyUtilityResource

Wait dependency

completeRuntimeWaitDependency

createWaitDependency

deleteWaitDependency

getRuntimeWaitDependencies

getWaitDependencies

getWaitDependency

modifyWaitDependency

Webhook result

processWebhookTrigger

Widget

Widget filter override

createWidgetFilterOverride

deleteWidgetFilterOverride

getWidgetFilterOverride

getWidgetFilterOverrides

modifyWidgetFilterOverride

Work item

getWorkItems

Workflow

Workflow definition

createStateDefinition

createTransitionDefinition

createWorkflowDefinition

deleteStateDefinition

deleteTransitionDefinition

deleteWorkflowDefinition

getStateDefinition

getStateDefinitions

getTransitionDefinition

getTransitionDefinitions

getWorkflowDefinition

getWorkflowDefinitions

modifyStateDefinition

modifyTransitionDefinition

modifyWorkflowDefinition

moveStateDefinition

moveTransitionDefinition

Workspace

Zone

CloudBees CD/RO Perl API commands

Commands

Access token

ACL

Application

Application dependency

Application tier

Archive connector

Artifact

Catalog

Change history

CI build

CI build detail

CI configuration

CI event

CI job

Cluster

Components

Credential

Credential provider

Custom filter

Dashboard

Dashboard column

Data retention policy

Database configuration

Deployer application

DevOps Insight data source

Directory provider

Dynamic environment

Email configuration

Email notifier

Environment

Environment tier

Gateway

Group

Job

Microservice

Microservice mapping

Miscellaneous

Not Defined

Object

Object tag

Parameter

Persona

Pipeline

Plugin

Plugin catalog

Plugin configuration

Procedure

Process

Process dependency

Process step

Project

Property

Release

Report

Report object association

Report object attribute

Report object type

Reporting filter

Resource

Rolling deploy

Schedule

SCM sync

Server

Server settings category

Service accounts for webhooks

Session

Single sign-on for OpenID Connect

Single sign-on for SAML

Snapshot

Tier map

Trigger

User

User email

Utility resource

Wait dependency

Webhook result

Widget

Widget filter override