Skip to main content

API Overview

This document provides an overview of the different types of APIs available for Harness IDP. These APIs enable programmatic access and management of various entities within Harness IDP.

In Harness IDP there are two types of APIs that are being used

  1. Backstage API
  2. Platform API

Backstage API

The Backstage API includes the Backstage endpoints exposed through the Harness Platform. This API lets you programmatically add/remove entities in the catalog. For detailed documentation on endpoints and other Backstage API reference information, go to the Backstage API reference documentation.

Platform API

The Platform API provides native Harness IDP APIs within the Harness Platform. For detailed documentation on endpoints and other Harness IDP API reference information, go to the Harness API reference documentation.

Catalog Ingestion API

Software Catalog in Harness IDP supports modifying metadata for the services, libraries, websites and any other entities registered in the Catalog using the Catalog Ingestion API.