Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API

Method

Description

Example

blackDuckArtifactoryIntegrationReload

POST

This attempts to reload the properties file, and then initializes the plugin with the new values. Does not apply to CRON expressions. An Artifactory restart is required for changing cron expressions.

curl -X POST -u admin:password "http://ARTIFACTORY_SERVER/artifactory/api/plugins/execute/blackDuckArtifactoryIntegrationReload"

blackDuckSetModuleState

POST

This enables or disables a particular module within the plugin and then reinitializes the plugin. This endpoint requires parameters to be set. Each module has an enabled state of true or false.  The available module names are:

  • ScanModuleScanAsAServiceModule

  • InspectionModule

  • AnalyticsModule

curl -X POST -u admin:password "http://ARTIFACTORY_SERVER/artifactory/api/plugins/execute/blackDuckSetModuleState?params=ScanModuleScanAsAServiceModule=false"

blackDuckTestConfig

GET

This returns a current status of the plugin configuration to verify correct setup.

curl -X GET -u admin:password "http://ARTIFACTORY_SERVER/artifactory/api/plugins/execute/blackDuckTestConfig"

blackDuckDeleteScanPropertiesblackDuckDeleteScanAsAServicePropertiesOnRepos

POST

This searches your Artifactory repositories defined with the blackduck.artifactory.scan.repos property for the filename patterns designated in the blackduck.artifactory.scan.name.patterns property. It removes blackduck properties by the repos parameter passed as part of the command for any files with ScanAsAService properties and removes those properties from the artifact.

curl -X POST -u admin:password "http://ARTIFACTORY_SERVER/artifactory/api/plugins/execute/blackDuckDeleteScanPropertiesblackDuckDeleteScanAsAServicePropertiesOnRepos?params=repos=repoName1[,repoName2…]"

blackDuckSubmitAnalytics

POST

Used for usage analytics, which is intended for developer use only.

curl -X POST -u admin:password "http://ARTIFACTORY_SERVER/artifactory/api/plugins/execute/blackDuckSubmitAnalytics"

...