Migrate API specs in Catalog to APIs

Uses: Catalog
Related Documentation
Incompatible with
on-prem

APIs can be associated with Catalog services, which replaces the legacy API spec linking. We recommend migrating API specs that are associated with a Catalog service to APIs because this allows API consumers and service owners to see which APIs and services are associated with each other.

Note: After an API spec is migrated to an API, the API spec is unlinked from the integration and will instead be stored as a snapshot by Kong. Since APIs take a snapshot of the API spec when it’s linked, they do not update automatically. For example, if you update your ingested spec in AWS, it doesn’t automatically pull changes in to the API, you must re-upload the spec manually.

Prerequisites

To migrate API specs to an API in Catalog, you need the following Konnect roles at a minimum for the services and APIs:

Action

Required roles

List available APIs to link to a service
  • API viewer
  • Service viewer
Create or delete API and service links
  • API viewer
  • Service admin
Migrate legacy APIs to new APIs
  • API creator
  • Service admin
List linked services on the API overview page
  • API viewer
  • Service viewer
Perform all the above actions
  • API admin and creator
  • Service admin

Migrate API specs to APIs

  1. In the Konnect sidebar, click Catalog.
  2. In the Catalog sidebar, click Services.
  3. Click a Catalog service that has API specs associated with it.
  4. Click the API specs (legacy) tab.
  5. Click the action menu next to the API spec, and select “Migrate to API catalog”.
  6. Click Start migration.

You will now see the API with your API spec linked to the Catalog service. Users who view APIs will also be able to see any linked Catalog services.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!