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/latest-overview-concept.adoc
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,28 +35,28 @@ To access API Manager, log in to Anypoint Platform and select *API Manager*:
35
35
image::api-manager-ui-overview.png["API Manager page navigation shown with callouts.",97%,97%]
36
36
37
37
[calloutlist]
38
-
. 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].
38
+
. 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[].
39
39
. Sidebar:
40
40
* *API Groups*
41
41
+
42
-
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].
42
+
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[].
43
43
* *Automated Policies*
44
44
+
45
-
Policy automation enables security architects and administrators to secure and govern every API running in an environment. For details, see xref:policies::policies-automated-overview.adoc[Automated Policies].
45
+
Policy automation enables security architects and administrators to secure and govern every API running in an environment. For details, see xref:policies::policies-automated-overview.adoc[].
46
46
* *Client Applications*
47
47
+
48
-
_Applications_ are external services that consume APIs. For details about applications and their related contracts, see xref:view-api-contracts.adoc[View API Instance Contracts].
48
+
_Applications_ are external services that consume APIs. For details about applications and their related contracts, see xref:view-api-contracts.adoc[].
49
49
* *Custom Policies*
50
50
+
51
-
_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].
51
+
_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[].
52
52
* *DataGraph Administration*
53
53
+
54
-
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.
54
+
Anypoint DataGraph enables you to unify all the data within your application network in a unified schema. For details, see xref:datagraph::index.adoc[]. *DataGraph Administration* is only visible after you configure a DataGraph unified schema.
55
55
* *Mule API Analytics*
56
56
+
57
-
Mule API Analytics provide insight into how your Mule APIs are being used and how they are performing. For details, see xref:viewing-api-analytics.adoc[Reviewing Mule API Analytics Usage].
57
+
Mule API Analytics provide insight into how your Mule APIs are being used and how they are performing. For details, see xref:viewing-api-analytics.adoc[].
58
58
59
-
. The *Add API* button. Enables you to add a new API instance, to promote an API from any environment to the current environment, or to import a configuration ZIP file that was exported from API Manager. For details, see xref:getting-started-proxy.adoc[Getting Started with Managing an API].
59
+
. The *Add API* button. Enables you to add a new API instance, to promote an API from any environment to the current environment, or to import a configuration ZIP file that was exported from API Manager. For details, see xref:getting-started-proxy.adoc[].
60
60
61
61
. The *Environment information* button, available only to administrator users. Enables administrators to display a dialog with information about the current environment, such as environment credentials. Use environment credentials to provision the Anypoint Service Mesh adapter or to configure Studio to sync with your environment.
62
62
@@ -79,10 +79,10 @@ For details, see xref:api-instance-landing-page.adoc[].
79
79
For details, see xref:using-api-alerts.adoc[].
80
80
** *Contracts*
81
81
+
82
-
For details, see xref:api-contracts-landing-page.adoc[Client Applications and Contracts].
82
+
For details, see xref:api-contracts-landing-page.adoc[].
83
83
** *Policies*
84
84
+
85
-
For details, see xref:policies-landing-page.adoc[Policies].
85
+
For details, see xref:policies-landing-page.adoc[].
86
86
** *SLA Tiers*
87
87
+
88
88
For details, see xref:defining-sla-tiers.adoc[].
@@ -95,14 +95,14 @@ For details, see xref:govern-api-instances.adoc[].
95
95
96
96
. The percentage of API requests that resulted in errors (in the past 24 hours).
97
97
+
98
-
If "No Data" is displayed, automatic monitoring has not been enabled for the API. For details, see xref:monitoring::quick-start.adoc[Anypoint Monitoring Quick Start].
98
+
If "No Data" is displayed, automatic monitoring has not been enabled for the API. For details, see xref:monitoring::quick-start.adoc[].
99
99
100
100
. The total number of API requests (in the past 24 hours).
101
101
+
102
-
If "No Data" is displayed, automatic monitoring has not been enabled for the API. For details, see xref:monitoring::quick-start.adoc[Anypoint Monitoring Quick Start].
102
+
If "No Data" is displayed, automatic monitoring has not been enabled for the API. For details, see xref:monitoring::quick-start.adoc[].
103
103
104
104
. The number of contracted client applications for each API. For details,
105
-
see xref:api-contracts-landing-page.adoc[Client Applications and Contracts].
105
+
see xref:api-contracts-landing-page.adoc[].
106
106
107
107
108
108
== API Manager Components, Concepts, and Features
@@ -115,7 +115,7 @@ The API Summary shows key information about a deployed API instance:
115
115
116
116
image::api-instance-summary.png[API Summary page]
117
117
118
-
For details, see xref:api-instance-landing-page.adoc[API Instance].
118
+
For details, see xref:api-instance-landing-page.adoc[].
119
119
120
120
=== API Alerts
121
121
@@ -128,7 +128,7 @@ An _API alert_ (different from a Runtime Manager alert) is an alarm that flags o
128
128
129
129
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.
130
130
131
-
For details, see xref:using-api-alerts.adoc[Reviewing Alerts Concepts].
131
+
For details, see xref:using-api-alerts.adoc[].
132
132
133
133
=== Contracts
134
134
@@ -139,7 +139,7 @@ Contracts are enforced with either of the following:
139
139
* SLA enforcement policies
140
140
* Client enforcement policies
141
141
142
-
For details about enforcement policies, see xref:api-contracts-landing-page.adoc[Client Applications and Contracts].
142
+
For details about enforcement policies, see xref:api-contracts-landing-page.adoc[].
143
143
144
144
=== Policies
145
145
@@ -150,13 +150,13 @@ API Manager supports the following types of policies:
150
150
* Default policies
151
151
* Custom policies
152
152
153
-
For details, see xref:policies-landing-page.adoc[Policies].
153
+
For details, see xref:policies-landing-page.adoc[].
154
154
155
155
=== SLA Tiers
156
156
157
157
_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.
158
158
159
-
For details, see xref:defining-sla-tiers.adoc[Reviewing SLA Tiers Concepts].
159
+
For details, see xref:defining-sla-tiers.adoc[].
160
160
161
161
=== Settings
162
162
@@ -166,7 +166,7 @@ To add an API instance, see xref:add-api-instances.adoc[].
166
166
167
167
After you create the API instance, you can edit the configuration settings from Settings.
168
168
169
-
To edit an API instance, see xref:edit-api-endpoint-task.adoc[Edit an API Instance].
169
+
To edit an API instance, see xref:edit-api-endpoint-task.adoc[].
170
170
171
171
=== Governance Report
172
172
@@ -176,14 +176,14 @@ API Governance tests API instances against rulesets to determine conformance iss
176
176
177
177
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.
178
178
179
-
To learn more about governing your API instances, see xref:govern-api-instances.adoc[Govern API Instances].
179
+
To learn more about governing your API instances, see xref:govern-api-instances.adoc[].
180
180
181
181
182
182
=== Client Providers (Identity Providers)
183
183
184
184
You use client providers to enforce security and regulations in your business organization. Client providers authorize client applications.
185
185
186
-
For details about using client providers, see xref:configure-multiple-credential-providers.adoc[Configure Multiple Client Providers for Client Management].
186
+
For details about using client providers, see xref:configure-multiple-credential-providers.adoc[].
187
187
188
188
=== API Assets
189
189
@@ -197,20 +197,20 @@ API assets, published by Exchange, are the components that comprise applications
197
197
* Modules
198
198
* Connectors
199
199
200
-
For details about sharing assets via a private Exchange or an Exchange public portal, see xref:exchange::about-sharing-assets.adoc[Share Assets].
200
+
For details about sharing assets via a private Exchange or an Exchange public portal, see xref:exchange::about-sharing-assets.adoc[].
201
201
202
202
=== API Console
203
203
204
-
When you create or edit APIs in API Manager, use xref:apikit::apikit-simulate.adoc[API Console] 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.
204
+
When you create or edit APIs in API Manager, use xref:apikit::apikit-simulate.adoc[] 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.
205
205
206
-
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 xref:manage-exchange-api-task.adoc[Creating an API Instance by Importing from Exchange].
206
+
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 xref:manage-exchange-api-task.adoc[].
207
207
208
208
209
209
=== API Groups
210
210
211
211
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.
212
212
213
-
For details, see xref:api-groups-landing-page.adoc[API Groups].
213
+
For details, see xref:api-groups-landing-page.adoc[].
214
214
215
215
=== Autodiscovery Schemes
216
216
@@ -220,18 +220,18 @@ Through autodiscovery schemes, API Manager can track the API throughout the life
220
220
221
221
A system administrator groups individuals within an organization into business groups. Each group has its own Exchange API assets and its own environments.
222
222
223
-
For details, see xref:access-management::business-groups.adoc[Business Groups].
223
+
For details, see xref:access-management::business-groups.adoc[].
224
224
225
225
=== Environments
226
226
227
227
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.
228
228
229
229
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.
230
230
231
-
For details, see xref:access-management::environments.adoc[Environments].
231
+
For details, see xref:access-management::environments.adoc[].
232
232
233
233
== See Also
234
234
235
-
* xref:general::api-led-overview.adoc[Tutorial: Build an API from Start to Finish]
236
-
* xref:getting-started-proxy.adoc[Get Started with Managing an API]
0 commit comments