Retire a Service

What?

A service developer can retire a specific service version, which means that the service will no longer be available in the Trust1Gateway Marketplace catalog any more.

The service will also be removed from the gateway itself: all API Keys pertaining to that service version will be rejected by the gateway.

Because retiring a service can impact the applications which use the service, this can only be done with a service that no longer has any contracts.

If you wish to retire a service, you should notify application developers upfront of your plan to retire a specific service version!

They need to break their existing contracts and/or migrate to a newer service version.

For your information, you find the list of applications which use the service version, on the Overview tab page:

Steps

1. Select a service and pay attention to select the specific version which you want to retire.

2. Expand the Actions drop-down menu and select Retire:

   

3. Ready? Click Retire Service in the newly opened modal:

   

Result

A toast message confirms that the service is retired. The status changes to

.

When you retire a service, the service will be removed from the gateway, and will be kept in the API Engine for archiving purpose.

This action cannot be undone, but in need, the service can be created with a new version in order to republish, this will change the service URL - and thus impact dependent client implementations.