Catalog import | Backstage | Page 1

errant estuary Jun 21, 2023, 2:56 PM

#

Hi Team,
Is it possible to import component using API call.
Somewhat like POST xxxxxxx.com/api/catalog-import

steady mortar Jun 21, 2023, 3:29 PM

#

backstage/plugins/catalog-backend/src/schema/openapi.yaml

I grabbed the YAML from the Backstage source and then tweaked it back to the 2.x version that Swagger editor / viewer could display in the site.

Looks like you can do a post to the locations endpoint and based on the response looks like it'd return back the entities it was able to view / import.

Not 100% on this as I haven't tried it personally, but looks like something to explore.

Screenshot_2023-06-21_at_10.27.46_AM.png

#

The default local host version of backstage is configured to launch at the following endpoint:

http://localhost:7007/api/catalog

So the endpoint would be /api/catalog/locations.

#

Oh, please note if you get any issues with the import you'll want to verify the default permissions for the catalog so that you're enabled to import the specific "kind" of entities from the remote location you want to import. ex. Domain, System, Group, User, Location, Component, API, Resource, or ... whatever else.

errant estuary Jun 21, 2023, 3:35 PM

#

Thanks @steady mortar I will try this

steady mortar Jun 21, 2023, 3:36 PM

#

I believe the "dry run" is what the catalog import uses to preview what would be imported. Running without should do a real import. Assuming everything was valid and permissions / allowed type creation was setup.

jagged fiber Jun 22, 2023, 8:15 AM

#

yep but that can only point to URLs that get pulled

#Catalog import