Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementGet application environment inventoryInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Custom Filters

3 minute readReference

createSearchFilter

Creates a new custom filter for the currently logged in user.

You must specify displayName and objectType.

Arguments Descriptions

displayName

The name of your search filter.

Argument type: String

objectType

The object type. See findObjects on page 1 for the list of possible values.

Argument type: String

description

(Optional) User-defined, plain text description for this filter.

Argument type: String

searchQuery

(Optional) The search query for this filter. If not specified, all objectType objects are included in the filter.

Argument type: String

shared

(Optional) < Boolean flag — 0|1|true|false >

When set to true or 1, this search filter is visible to other users. When set to false or 0, this search filter is visible only to the owner.

Argument type: Boolean

Positional arguments

displayName, objectType

Response

Returns a SearchFilter object.

ec-perl

syntax: $cmdr->createSearchFilter(<displayName>,<objectType>, {<optionals>});

Example

$cmdr->createSearchFilter("testFilter!", "pipeline");
▼

ectool

syntax: ectool createSearchFilter <displayName> <objectType> [optionals]

Example

ectool createSearchFilter SearchFilter_test application --description "This is a test filter" --searchQuery "applicationName equals App1"
▼

deleteSearchFilter

Deletes a search filter.

You must specify displayName and objectType.

Arguments Descriptions

displayName

The name of your search filter.

Argument type: String

objectType

The object type. See findObjects on page 1 for the list of possible values.

Argument type: String

userName

(Optional) Delete filter owned by userName. If not specified, delete filter for the current logged in user, subject to objectType argument

Argument type: String

Positional arguments

displayName, objectType

Response

None or a status OK message.

ec-perl

syntax: $cmdr->deleteSearchFilter(<displayName>,<objectType>, {<optionals>});

Example

$cmdr->deleteSearchFilter("MyFilter","application");
▼

ectool

syntax: ectool deleteSearchFilter <displayName> <objectType> [optionals]

Example

ectool deleteSearchFilter MyApp application
▼

getSearchFilter

Retrieves a search filter by name.

You must specify displayName and objectType.

Arguments Descriptions

displayName

The name of the desired search filter. Use getSearchFilters to retrieve a list of all filters.

Argument type: String

objectType

The object type. See findObjects on page 1 for the list of possible values.

Argument type: String

userName

(Optional) Retrieve the filter owned by userName. If not specified, retrieve the filter for the current logged in user, subject to objectType argument.

Argument type: String

Positional arguments

displayName, objectType

Response

Returns one SearchFilter element.

ec-perl

syntax: $cmdr->getSearchFilter(<displayName>,<objectType>, {<optionals>});

Example

$cmdr->getSearchFilter("MyFilter","pipeline");
▼

ectool

syntax: ectool getSearchFilter <displayName> <objectType> [optionals]

Example

ectool getSearchFilter MyFilter pipeline
▼

getSearchFilters

Retrieves all search filters.

Arguments Descriptions

objectType

(Optional) The object type. See findObjects on page 1 for the list of possible values. If not specified, retrieve all filters, subject to userName argument.

Argument type: String

userName

(Optional) Retrieve filters owned by userName. If not specified, retrieve filters for the current logged in user, subject to objectType argument.

Argument type: String

Positional arguments

None

Response

Returns one or more SearchFilter elements.

ec-perl

syntax: $cmdr->getSearchFilters({<optionals>});

Example

$cmdr->getSearchFilters();
▼

ectool

syntax: ectool getSearchFilters [optionals]

Example

ectool getSearchFilters
▼

modifySearchFilter

Modifies an existing search filter.

You must specify displayName and objectType.

Arguments Descriptions

displayName

The name of your search filter.

Argument type: String

objectType

The object type. See findObjects on page 1 for the list of possible values.

Argument type: String

description

(Optional) User-defined, plain text description for this filter.

Argument type: String

newName

(Optional) New name for an existing object that is being renamed.

Argument type: String

newObjectType

(Optional) The new object type for this filter. See findObjects on page 1 for the list of possible values.

Argument type: String

searchQuery

(Optional) The search query for this filter. If not specified, all objectType objects are included in the filter.

Argument type: String

userName

(Optional) Retrieve the filter owned by userName. If not specified, retrieve the filter for the current logged in user, subject to objectType argument.

Argument type: String

shared

(Optional) < Boolean flag — 0|1|true|false >

When set to true or 1, this search filter is visible to other users. When set to false or 0, this search filter is visible only to the owner.

Argument type: Boolean

Positional arguments

displayName, objectType

Response

Returns the modified SearchFilter element.

ec-perl

syntax: $cmdr->modifySearchFilter(<displayName>,<objectType>, {<optionals>});

Example

$cmdr->modifySearchFilter("MyFilter", "pipeline", ");
▼

ectool

syntax: ectool modifySearchFilter <displayName> <objectType. [optionals]

Example

ectool modifySearchFilter MyFilter pipeline --newName "MyNewName"
▼
Credential management
Database configuration