Administration APIs

Runtime Management

Federated API management exposes REST APIs to help you create, read, update, and delete multiple runtimes like API Gateway running in different landscapes.

The following table displays the REST APIs and resources to manage runtimes.

Runtime Type Management

Federated API management exposes REST APIs to help you create, read, update, and delete multiple runtime types like WEBMETHODS_DEVELOPER_PORTAL, WEBMETHODS_API_GATEWAY.

Data Plane Management

Data planes in federated API management are a collection of runtimes like API Gateway running in different landscapes.

Federated API management exposes REST APIs to help you create, read, update, and delete data planes.

The following table displays the REST APIs and resources to manage data planes.

API Management

Federated API management exposes REST APIs to help you create, read, update, and delete APIs within runtimes.

The following table displays the REST APIs and resources to manage APIs.

Runtime Metrics

exposes REST APIs to help you create runtime’s heartbeat and metrics in Federated API management.

The following table displays the REST APIs and resources to create runtime’s heartbeat and metrics in Federated API management.

Federated API management Search

With Search API, you can run a search or count query in Federated API management and return the search results that match the search query or the count of objects matching the search query.

Federated API management provides the following REST API resources,

• POST/assetcatalog/v1/search. Runs a search query in Federated API management and returns the search results that match the input query. You can perform searches on different objects, such as API, DATAPLANE, RUNTIME, and AUDITEVENT, but only one object can be searched at a time.

  Specify the following in your REST request to perform a search operation,

  REST request payload section	Description
  type	Objects for which you want to perform the search operation. You can specify one of the following listed objects: API DATAPLANE RUNTIME AUDITEVENT
  query	Consists of a list of conditions that are connected by a logical connector. You can only use the same logical connector between conditions; it must be either AND or OR, not both.
  conditions	Consists of a list of criteria that are connected by a logical connector. You can only use the same logical connector between criterias; it must be either AND or OR, not both.
  criterias	Indicates the actual condition that applies to the field, providing the field's name, value, and any operators that are applied to it. For example, contains.
  from	Indicates the starting point from which records must be fetched. For instance, from = 5 indicates that the sixth object is the starting point. In Opensearch, record indexing starts at 0, meaning that the first object has an index of 0. By default, the from parameter is set to 0. If the value of the from parameter exceeds the total number of records available in Opensearch, the search does not return any results.
  size	Indicates the number of records that must be fetched. For example, for a size of 10, 10 records are returned beginning with the from value. The default is 10000.
  responseFields	Specifies the fields that must be returned in the response. You can specify only the needed fields instead of viewing all the fields in your response. For example, if you want to view only the name and type fields for objects of type API, you can specify name and apiType in your REST request. To fetch all fields, you can use *.
  sortFields	Contains the field names and sort order based on which the search results must be sorted. For example, {"name":"DESC","created":"DESC"}. In this example, the results are sorted by name in descending order, and then by created date in descending order. If you don't specify any sort fields, the system sorts the results by using the lastModified date in descending order.

• POST/assetcatalog/v1/count. Retrieves the total number of records that match the input type and the input query. If you do not specify the query, the system returns the total number of records present for the input type.

  To retrieve the count of records, you can specify the needed type, query, conditions, and criteria similar to the /search query. The count query does not take the from, size, response, and sort fields into consideration.

Audit Logs

Federated API management exposes the following REST API to retrieve the record of events performed on the assets (APIs, runtimes, and data planes) during a specific time period.

{
  "from": "1673352361557",
  "to": "1673355631997",
  "types": [
    "DATAPLANE",
    "RUNTIME",
    "API"
  ]
}

Bulk API Management

Federated API management offers REST APIs that allows to create, update, and delete (CUD) multiple APIs in a single request. The bulk API management capability is essential, as performing CUD operations for multiple APIs individually can result in high network latency, negatively impacting the performance. By using bulk APIs, you can efficiently manage a single operation such as create, update, or delete for multiple APIs in one request, improving performance and reducing latency.

These bulk APIs operate asynchronously. When you send a request to create multiple APIs, the bulk API immediately responds with a Job ID and a URL, where you can check the status of your request. This asynchronous processing means that the bulk API handles the request in the background, which enables you to check the status of your request immediately.

Job status lifecycle

Managing Bulk APIs

The following table describes the REST APIs and resources available for managing Bulk APIs.