You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/api-instance-landing-page.adoc
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,25 @@ include::_attributes.adoc[]
4
4
endif::[]
5
5
:keywords: api, instance, manager
6
6
7
-
An API instance is the instantiation of an API definition. It is an object that is used to share data between gateways and the control plane. An API Instance can either be a proxy of an API that serves the upstream or a Mule application endpoint.
7
+
An API instance is the instantiation of an API definition. It is an object that is used to share data between gateways and the control plane. An API instance can either be a proxy of an API that serves the upstream or a Mule application endpoint.
8
8
9
9
You can create, import, and deprecate API instances using API Manager. You can use instances of an API in multiple environments. You can also have multiple instances of an API in the same environment.
10
10
11
11
You can create one instance of an API version that serves as a proxy and create another to directly manage it as an endpoint. You can apply policies to the API based on how the API is configured--proxy or endpoint. For example, you can apply caching policies to the proxy, and throttling policies and security policies to the endpoint. Additionally, you can promote an API to another environment.
12
12
13
-
To manage API Instances in API Manager:
13
+
To manage API instances in API Manager:
14
14
15
15
. xref:create-instance-task.adoc[Add an API Instance] - API instances are managed by API Manager after you add them and remain under management until you delete them.
16
-
. xref:configure-api-task.adoc[Configure an API Instance] - You can customize your API Instance to fit your specific situation with many optional settings. Not all options are available depending on the runtime as well as the API.
17
-
. View an API Instance's settings for information about the instance or to export it.
16
+
. xref:configure-api-task.adoc[Configure an API Instance] - You can customize your API instance to fit your specific situation with many optional settings. Not all options are available depending on the runtime as well as the API.
17
+
. View an API instance's API Summary for information about the instance or to export it:
18
18
** xref:find-api-id-task.adoc[Obtain API Instance ID] - API Manager generates the apiId of new APIs managed by API Manager for use with Mule 4.
19
19
** xref:export-api-latest-task.adoc[Export an API Instance] - After creating an API instance, you can export it. This exports the API instance endpoint configuration and Exchange asset relationship. You can then import it into another environment in the same business group to create a new API instance.
20
20
** xref:access-developer-portal-task.adoc[Access the Developer Portal] - As an administrator, you can view the resources and methods of an API, and access other details, such as publish date and mocking service, from Anypoint Exchange (Exchange). You can view the API in an asset portal (private) or a public portal.
21
-
. Modify an API Instance when you no longer need the instance or when you need to update it to the latest version.
21
+
. Modify an API instance when you no longer need the instance or when you need to update it:
22
+
** xref:edit-api-endpoint-task.adoc[Edit an API Instance Endpoint] - Edit the API instance's endpoint to update its base path, port, TLS context, and more.
22
23
** xref:deprecate-api-latest-task.adoc[Deprecate an API Instance] - While transitioning consumers of your API to an updated instance, you can prevent developers from signing up for access to your old API instance.
23
24
** xref:delete-api-task.adoc[Delete an API Instance] - You can delete an API instance and its version if you no longer need to manage it from API Manager.
24
25
** xref:manage-versions-instances-concept.adoc[Manage API Versions] - After you create an API in Anypoint Platform, you configure the version details for the API and then publish it to Anypoint Exchange (Exchange). The API version resides in Exchange, and not in API Manager. However, you then manage this API version from API Manager.
25
-
. Explore advanced use cases for API Instances.
26
+
. Explore advanced use cases for API instances:
26
27
+
27
28
xref:configure-multiple-credential-providers.adoc[Configure Multiple Client Providers] - You can use multiple client providers, such as OpenAM and PingFederate, to help you enforce security and regulations in your business organization. These client providers enable you to secure your operational data, including client credentials and access tokens.
The `281324` suffix in this case is API Instance ID of your API Proxy.
94
+
The `281324` suffix in this case is API instance ID of your API Proxy.
95
95
96
96
If you inspect your API Proxy's XML, you can see these properties being used in your trustore/keystore configurations:
97
97
@@ -107,11 +107,8 @@ To deploy your API Proxy to a standalone server, provide secured properties for
107
107
. Download the API Proxy.
108
108
.. In API Manager, select the version of the API proxy you want to download.
109
109
.. Click the *Actions* button in the top-right corner of your screen and select *Download Proxy*.
110
-
. Take note of your API Instance ID under *API Instance*.
111
-
+
112
-
image::building-https-proxy-541ec.png["The Download Proxy form with the API Instance ID highlighted by a rectangle."]
113
-
+
114
-
. When running your standalone Mule instance, you need to provide the keystore and key passphrases as -D arguments, along with your API Proxy's API Instance ID. +
110
+
. Take note of your API instance ID under *API Instance ID*.
111
+
. When running your standalone Mule instance, you need to provide the keystore and key passphrases as -D arguments, along with your API Proxy's API instance ID. +
115
112
For example, if your API instance ID is 15464957, you need to pass the arguments:
Anypoint API Manager (API Manager) is a component of Anypoint Platform that enables you to manage, govern, and secure APIs. It leverages the runtime capabilities of Anypoint Flex Gateway, Anypoint Mule Gateway and Anypoint Service Mesh, all of which enforce policies, collect and track analytics data, manage proxies, provide encryption and authentication, and manage applications.
8
+
Anypoint API Manager (API Manager) is a component of Anypoint Platform that enables you to manage, govern, and secure APIs. It provides an interface to configure the runtime capabilities of Anypoint Flex Gateway, Anypoint Mule Gateway, and Anypoint Service Mesh. With API Manager you can:
9
+
10
+
* Enforce policies
11
+
* Collect and track analytics data
12
+
* Manage proxies and applications
13
+
* Provide encryption and authentication
9
14
10
15
API Manager is tightly integrated with the following tools:
11
16
@@ -18,13 +23,13 @@ Before using API Manager, familiarize yourself with the user interface and the t
18
23
19
24
== What API Manager Looks Like
20
25
21
-
To access API Manager, log in to Anypoint Platform and select *API Manager* from the main menu:
26
+
To access API Manager, log in to Anypoint Platform and select *API Manager*:
22
27
23
28
image::api-manager-ui-overview.png["API Manager page navigation shown with callouts.",97%,97%]
24
29
25
30
[calloutlist]
26
31
. The environment selector. Anypoint Platform enables you to create and manage separate deployment environments for APIs and applications. API Manager displays all environments except design environments. For details, see xref:switch-environment-task.adoc[Switching Environments].
27
-
. Navigation menu:
32
+
. Sidebar:
28
33
* *API Groups*
29
34
+
30
35
An _API group_ is an API asset that enables organizations to publish a group of API instances as a single unit. For details, see xref:api-groups-landing-page.adoc[API Groups].
@@ -39,7 +44,7 @@ _Applications_ are external services that consume APIs. For details about applic
39
44
_Custom policies_ are policies that anyone can develop and apply to their APIs, with the intention of extending existing functionality or defining new functionality. For details, see xref:policies::policies-custom-overview.adoc[Custom Policies].
40
45
* *DataGraph Administration*
41
46
+
42
-
Anypoint DataGraph enables you to unify all the data within your application network in a unified schema. For details, see xref:datagraph::index.adoc[Anypoint DataGraph Overview].
47
+
Anypoint DataGraph enables you to unify all the data within your application network in a unified schema. For details, see xref:datagraph::index.adoc[Anypoint DataGraph Overview]. *DataGraph Administration* is only visible after you configure a Datagraph unified schema.
43
48
* *Analytics*
44
49
+
45
50
API analytics provide insight into how your APIs are being used and how they are performing. For details, see xref:viewing-api-analytics.adoc[Reviewing Analytics Usage].
@@ -163,9 +168,9 @@ For details, see xref:api-groups-landing-page.adoc[API Groups].
163
168
164
169
An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Service Mesh. API instances are managed by API Manager after they are created using add, promote, or import options. API instances remain under management until they are deleted.
165
170
166
-
The API Manager dashboard shows key information about a deployed API instance:
171
+
The API Summary shows key information about a deployed API instance:
167
172
168
-
image::dashboard-legend.png[]
173
+
image::api-instance-summary.png[API Summary page]
169
174
170
175
For details, see xref:api-instance-landing-page.adoc[API Instance].
0 commit comments