Managing federated API management resources using administration APIs

Federated API management provides a set of REST APIs that helps to manage multiple runtimes, data planes, and APIs efficiently.

Before you begin

The APIs support operations such as creating runtime heartbeats, collecting metrics, and performing bulk create, update, and delete (CUD) actions on multiple APIs in a single request. You can also use the Search API to run search or count queries and retrieve matching results or object counts across federated API management. Additionally, audit APIs are available to retrieve records of actions performed on assets (APIs, runtimes, and data planes) within a specified time range. For details, see Administration APIs in federated API management.

Make sure you generate the API key for Federated API Management. For more details, see Generating API Keys.

Procedure

  1. Generate a bearer token by sending the following POST request to authenticate Federated API management endpoints. Pass the federated API management API key in the request header.
    The following is the sample request:
    curl --request POST \
      --url https://<FAM_HOST>/api/ingress/v1/token \
      --header 'User-Agent: insomnia/11.5.0' \
      --header 'X-APIKEY: <API_KEY> \
      --header 'X-ClientID: <Clientn ID >'
    The following is the sample response:
    {
    "token_type": "Bearer",
    	"access_token":"eyJra..........................................hg8kg"
    }
    
  2. Authenticate the Federated API management REST endpoints by adding the token to the Authorization header of your API requests by using the Bearer authentication scheme:
    The following is the sample request:
    curl --request GET \
      --url <federated_api_management_URL>/api/assetcatalog/v1/runtimes \
      --header 'Authorization: Bearer eyJraV................hg8kg' \