Each environment can support different capabilities. For a description of the capabilities see below.

API Discovery

Environments that support API discovery can be scanned and a list of all deployed APIs can be retrieved from the environment. If possible and available this includes all versions an API has as well as any spec files for this API, that are available.

Component Discovery

Components include applications, plans and existing subscriptions (API Keys). These elements are read from the environments and are associated with the respective APIs. If the same plan exists in multiple environments they are merged and only imported once to the Control Plane.

Component Deployment

Component Deployment means that the Control Plane is able to write applications, plans and subscriptions (API Keys) to the respective environments. APIs running on environments that do not support component deployment cannot be subscribed to in the Control Plane.

Access Permission Regeneration

In case a consumer has lost its API key or secret or it was compromised the secrets (access permissions) are can be regenerated withing the API Control Plane for environments that have this ability. Environments that do not have this ability need to unsubscribe and resubscribe in order to generate a new API key.

API Metrics

This capability includes the retrieval of per API metrics like hits or response times.

Application Metrics

In contrast to the API metrics the application metrics capability retrieve the metrics on a per application (API Key) basis, so you can get detailed analysis on which application made the calls or causes a lot of errors.

API Import / Export

API import and export describe the capability of working with a runtime using its own, proprietary format. The API Control Plane is capable of exporting an API from a runtime to code (in its native format) and pushing it to a git repository. Likewise the Control Plane can also retrieve an API as code from a git repository and put it into a runtime.

OpenProxy Specification

The OpenProxy Specification is used to describe the publishing of an API in a vendor agnostic way. Environments sporting this capability are able to transform this vendor agnostic spec into the format used by the runtime and deploy it on the runtime. This can be used to create and update API proxies in a unified way across multiple runtimes.

Custom Field Discovery

Environments that support custom field discovery can import existing custom fields into the Control Plane. They will show up in the Control Plane as if they were created therein.

OAuth Config

Authenticate your application with OAuth against the subscribed API.

Table of Content