How to Archive My APIs?

Introduction

Sometimes you have quite a few APIs published in the marketplace. For the sake of better organisation, you may want to archive some of the APIs. This guide would walk you through how to archive your APIs and what it indicates.

Why to Archive the APIs?

1. You may have uploaded quite a few APIs and you may want to differentiate the older ones from the newer ones. However, you would still want to keep the record on the Provider Admin Portal for future reference.
2. Marking API as archived can help with categorising the APIs easily.
3. Reminding developers that the API may not be up-to-date.

How to Archive the APIs?

1. Go to the edit page for the API. For more details of how to edit an API, please refer to "Where to Edit APIs".
2. Under the "API Details" tab, click "Edit".
3. To set an API as archived, select "Archived" from the field "Category".

** To unarchive an API, simply update the category of the API.

What would Happen after Archiving an API?

Users can still see and subscribe to the archived API on the marketplace, current subscriptions to the API would not be affected as well. However, the following takes place:

1. When accessing the API from API Catalogue, the API will be Categorised as "Archived".
2. There would be a tag "Archived" above the API name on the API Card when viewed from the API Catalogue.
3. When the API Details page of the Archived API is visited, a tag stating that the API is archived could be clearly seen above the API Name in the Hero Section.