API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

DevOps Insight data source

2 minute readReference

createDevOpsInsightDataSource

Creates a new DevOps Insight data source.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

(Required) The name of the release.

devOpsInsightDataSourceName

String

(Required) The DevOps Insight data source name.

description

String

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

pluginKey

String

The plugin key. For example, EC-MyPlugin.

pluginParameters

Map

The plugin parameters to be passed to the plugin for creating the required schedule and polling procedure.

reportObjectTypeName

String

The name of a report object type.

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Usage

ec-perl

$cmdr->createDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {<optionals>});
▼

ectool

ectool createDevOpsInsightDataSource projectName releaseName devOpsInsightDataSourceName [optionals]
▼

deleteDevOpsInsightDataSource

Deletes a DevOps Insight data source.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

(Required) The name of the release.

devOpsInsightDataSourceName

String

(Required) The DevOps Insight data source name.

foreground

Boolean

True to delete the object in the foreground. The default is to delete the object in the background.

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Usage

ec-perl

$cmdr->deleteDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {<optionals>});
▼

ectool

ectool deleteDevOpsInsightDataSource projectName releaseName devOpsInsightDataSourceName [optionals]
▼

getDevOpsInsightDataSource

Retrieves a new DevOps Insight data source.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

(Required) The name of the release.

devOpsInsightDataSourceName

String

(Required) The DevOps Insight data source name.

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Usage

ec-perl

$cmdr->getDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>);
▼

ectool

ectool getDevOpsInsightDataSource projectName releaseName devOpsInsightDataSourceName
▼

getDevOpsInsightDataSources

Retrieves all DevOps Insight data sources.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

(Required) The name of the release.

reportObjectTypeName

String

The name of a report object type.

Positional arguments

projectName, releaseName

Usage

ec-perl

$cmdr->getDevOpsInsightDataSources(<projectName>, <releaseName>, {<optionals>});
▼

ectool

ectool getDevOpsInsightDataSources projectName releaseName [optionals]
▼

modifyDevOpsInsightDataSource

Modifies an existing DevOps Insight data source.

Arguments

Argument Name Type Description

projectName

String

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

releaseName

String

(Required) The name of the release.

devOpsInsightDataSourceName

String

(Required) The DevOps Insight data source name.

description

String

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

newName

String

The new name for an existing object that is being renamed.

pluginParameters

Map

The plugin parameters to be passed to the plugin for creating the required schedule and polling procedure.

Positional arguments

projectName, releaseName, devOpsInsightDataSourceName

Usage

ec-perl

$cmdr->modifyDevOpsInsightDataSource(<projectName>, <releaseName>, <devOpsInsightDataSourceName>, {<optionals>});
▼

ectool

ectool modifyDevOpsInsightDataSource projectName releaseName devOpsInsightDataSourceName [optionals]
▼
Deployer application
Directory provider