Getting Started with the Black Duck API

The Black Duck REST API allows you to programmatically interact with your Black Duck instance—enabling automation, custom integrations, and enhanced visibility into your security, license, and component data.

Whether you're writing scripts, building tools, or connecting Black Duck with other systems, this guide helps you get started with the core API functionality.

Accessing the API documentation

You can explore the available endpoints and try them out in your browser using the built-in API documentation.

To access it:

  • Go to https://<your-black-duck-server>/api-doc/public.html

  • Or, in the top navigation bar, click the Help icon and select REST API Developers Guide.

This interactive documentation shows each supported endpoint, the required parameters, response structure, and supported media types.

Important: Only APIs documented in this guide are supported. Endpoints that begin with /v1 or internal are not supported for external use.