Update an API Using a CRD

Because APIs constantly change, Anypoint Service Mesh allows you to update the specification of your API within the same major version (only minor and patch bumps allowed). You can update an API using Anypoint Platform or Anypoint Service Mesh:

  • Update an API using Anypoint Service Mesh

    If your API resource exists in the cluster, you can update it to trigger changes in Anypoint Platform, such as creating or modifying asset versions and API instances.

  • Update an API using Anypoint Platform

    After a new version of an API is published to Anypoint Exchange (Exchange), you can update the API instances associated with it to use this new version of the asset.

    You can update the asset tags from Exchange and the API instance tags in API Manager.

Update an API Using Anypoint Service Mesh

If you configured the API using the Anypoint Service Mesh autocreate feature, you can update the API from the cluster when required. The update reuses the environment details and credentials introduced when provisioning the API.

However, with the CRD approach, the operation is be performed with the modified credentials in the resource.

To update the API using CRD:

  1. Edit the original YAML manifest to update the API resource:

    kubectl apply -f test-api-edited.yaml

  2. Optionally, you can directly edit the resource through the command-line editor:

    kubectl edit serviceinstance/<name> -n <namespace>

  3. Verify that the API was successfully created:

    asmctl api list

  4. Optionally, verify the asset changes in Exchange and the API instance changes in API Manager.

Update an API using Anypoint Platform

When updating an API from Anypoint Platform, you can update the asset from Exchange or update the API instance from API Manager.

Update the API Asset in Exchange

To update an existing asset or create a new version using Anypoint Platform, perform the following steps:

  1. Go to Anypoint Platform > Exchange and select the asset that you want to modify.

  2. Based on what you want to changes, perform the following actions:

    1. If you want to upload a new version, from the right-side table, click Add new version.

    2. If you want to change the tags of a version, from the right-side panel, click Tags.

Update API Instances in API Manager

To update an existing API instance, perform the following steps:

  1. Go to Anypoint Platform > API Manager

  2. Search for and select your API instance from the results table.

  3. In the API Configuration section, update the tags for your API instance.

  4. Update the asset version:

    Display asset update

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!