Skip to content

Commit fbd9e16

Browse files
Merge branch 'v2.x' into W-13734629-apig-apim-internal-doc-br-bsj
2 parents f88e91b + 27b674b commit fbd9e16

2 files changed

Lines changed: 9 additions & 15 deletions

File tree

modules/ROOT/pages/_partials/task-promote-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[promote-api]]
2-
== Promote API from Environment
2+
== Promote an API Instance from Another Environment
33

44
. Navigate to *Anypoint Platform* > *API Manager*.
55
. In *API Administration*, click **Add API** and select **Promote API from environment**.

modules/ROOT/pages/promote-api-task.adoc

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,19 @@ ifndef::env-site,env-github[]
33
include::_attributes.adoc[]
44
endif::[]
55

6-
A tight integration of Anypoint Platform components extends the use of environments to API management. In this procedure, you change the environment of an API.
6+
Before promoting an API instance to another environment, ensure that you have the `Manage APIs Configuration` permission.
77

8-
You must have `Manage APIs Configuration` permission to promote an API and `Access Management` permission to set permissions for viewing and managing an entity. You can only promote an entity (Policies, Alerts, and so forth) if you have permission to view the source and permission to manage the destination over each entity. Typical view permissions are `View API Configuration` and `View Policies`, as explained in xref:environment-permission-task.adoc[To Grant Permission to Access Environments]. Set the permissions as needed before proceeding.
8+
You can only promote an entity, such as policies or alerts, if you have both the permissions to view the entity and to manage its destination. For example, you must have the `View Policies` and `Manage Policies` permissions to promote a policy.
99

10-
. Navigate to *Anypoint Platform* > *API Manager*.
11-
. In *API Administration*lick *Add API* and select *Promote API from environment*.
12-
. For *Source Environment*, select the environment of the API to promote.
13-
. For *API*, enter the name of the API and then select it from the APIs in the source environment.
14-
. For *API Version*, select the version of the API.
15-
. Optionally, for *API instance label*, select the API instance name if you created any instances.
16-
. Select or deselect entities to include in the promotion: Policies, SLAs, Alerts, and API Configuration.
17-
. Optionally, if your external client provider differs in the environment to which your are promoting the API, select the provider in the *Client provider* list.
18-
. Click *Promote*.
10+
To promote an API instance:
1911

20-
Promoting an API affects only the API definition, not the existing deployed applications subscribed to the API. After promoting an API, the API Name remains the same, but the API ID changes.
12+
include::partial$task-promote-api.adoc[]
2113

22-
For existing applications that need to subscribe to a promoted API, you need to make the following changes:
14+
Promoting an API instance affects only the API definition, not the existing deployed applications subscribed to the instance. After promoting an API, the *API Label* remains the same, but the *API Instance ID* changes.
2315

24-
. Update the API ID.
16+
For existing applications that must subscribe to a promoted API instance:
17+
18+
. Update the *API Instance ID* within the application.
2519
. Because each environment has a different client ID and secret, update the application's client ID and secret.
2620

2721
== See Also

0 commit comments

Comments
 (0)