Anypoint API Manager

An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted. To view the API Summary for an API instance, click the API instance name.

For more detail, see Managing API Instances.

The API Summary shows key information about a deployed API instance:

The API Summary page includes a Key Metrics section.

An API alert (different from a Runtime Manager alert) is an alarm that flags one of the following:

API Manager triggers alerts when states change from desirable to undesirable or vice versa. When an alert is triggered, API Manager sends an email notification to you and to anyone else you specify in the configuration.

For details, see Reviewing Alerts Concepts.

Contracts define how client applications consume APIs. A client application requests access in Exchange. Either the owner of the API instance approves the request in API Manager or the approval is automatic, depending on configuration.

Contracts are enforced with either of the following:

For details about enforcement policies, see Client Applications, Contracts, and Credentials.

Policies enable you to enforce regulations to help manage security, control traffic, and improve adaptability of your APIs. For example, a policy can control authentication, access, allotted consumption, and service level access (SLA).

API Manager supports the following types of policies:

For details, see Securing and Governing Flex Gateway APIs.

Service Level Access (SLA) tiers are categories of user access that you define for an API. The tier definition combined with an SLA-based policy determines whether access to the API at a certain level requires your approval. The tier definition also can limit the number of requests an application can make to the API. To enforce SLA tiers, you need to apply a rate-limiting or throttling policy that is SLA-based.

For details, see Reviewing SLA Tiers Concepts.

When adding an API instance, you configure the API instance settings to set parameters such as the runtime and upstream and downstream URIs.

To add an API instance, see Add API Instances.

After you create the API instance, you can edit the configuration settings from Settings.

To edit an API instance, see Editing an API Instance.

API Governance is integrated with API Manager to identify the conformance status of your API instances.

API Governance tests API instances against rulesets to determine conformance issues such as missing policies and missing TLS contexts.

You can view the governance validation report details to get the information you need to fix conformance issues. The validation report is available both in API Manager on the Governance Report page and in API Governance.

To learn more about governing your API instances, see Governing API Instances.

You use client providers to enforce security and regulations in your business organization. Client providers authorize client applications.

For details about using client providers, see Configure Multiple Client Providers for Client Management.

API assets, published by Exchange, are the components that comprise applications. Components include any of the following:

For details about sharing assets via a private Exchange or an Exchange public portal, see Publish Assets.

When you create or edit APIs in API Manager, use Building, Implementing, and Testing a REST API to expose and test your API specification. You can test RAML and OAS APIs when you manage the API as an endpoint with proxy. The console flow is already included and enabled (by default) in the API specification when you download an out-of-the-box proxy for your Mule application.

Starting with Mule 4, you can enable access to API Console and modify the API Console path from API Manager. API Console access from API Manager is disabled by default. For information about how to enable API Console access from API Manager, see Adding a Mule Gateway API Instance.

An API group is a collection of API instances that act as a single unit, so that applications can access them using one client ID. API groups are created in API Manager and published to Exchange.

For details, see API Groups.

Through autodiscovery schemes, API Manager can track the API throughout the life cycle as you modify, version, deploy, govern, and publish it.

A system administrator groups individuals within an organization into business groups. Each group has its own Exchange API assets and its own environments.

For details, see Business Groups.

Anypoint Platform enables you to create and manage separate deployment environments for APIs and applications. These environments are independent from each other and enable you to test your applications under the same conditions as in your production environment.

The support for environments in strategic components of Anypoint Platform eliminates the need to construct version names to reflect an environment. Restricting access to and managing environments is also simplified. Permissions to access APIs are environment-based.

For details, see Environments.