Getting Started

Welcome to the integration for the Backstage Data-Source API. This API deals with CRUD operations for entities managed by the Backstage ecosystem.

What do you need

In order to interact with the Data-Source API you'll need the following things:

Service ID
The service ID is the unique ID for your service and will make sure you can only operate on data for that particular service.

Consumer Key
The consumer key is tied to your service and provides you access to the API. Without this key you will not be able to use any of the endpoints.

You can generate a key through the Developer Portal in the CMS.

caution

You should NEVER use the API key where it could be exposed to the public. It gives access to all data within your service.