Administration APIs

REST APIs

Runtime Management

API Control Plane allows you to manage multiple runtimes running in different landscapes.

API Control Plane exposes REST APIs to help you create, read, update, and delete (CRUD) runtimes.

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

For details on the REST API, see Runtime Management.yaml.

Runtime Type Management

API Control Plane allows you to manage multiple runtime types like webMethods.io Developer Portal, webMethods.io API Gateway, and third-party gateways. API Control Plane exposes REST APIs to help you create, read, update, and delete runtime types.

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

For details on the REST API, see Runtime Type.yaml.

Data plane Management

Data planes in API Control Plane are a collection of runtimes running in different landscapes.

API Control Plane exposes REST APIs to help you create, read, update, and delete (CRUD) data planes.

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

For details on the REST API, see Data plane Management.yaml.

API Management

API Control Plane exposes REST APIs to help you create, read, update, and delete (CRUD) APIs within runtimes.

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

For details on the REST API, see API Management.yaml.

Runtime Metrics

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

The following table displays the REST APIs and resources to create runtime’s heartbeat and metrics in API Control Plane:

For details on the REST API, see Runtime Metrics.yaml.

User Management

The user management API allows you to manage the following entities:

• Users
• User groups

The following table displays the REST APIs and resources to manage users:

API Control Plane Search

The API Control Plane search API allows you to run a search query or a count query in API Control Plane and return the search results that match the search query or the count of objects matching the search query.

API Control Plane provides the following REST API resources:

• POST/assetcatalog/v1/search. Runs a search query in API Control Plane 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.

  To perform a search operation, specify the following in your REST request:

  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 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 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 may be applied to it. For example, contains. For more information about supported operators, see Search API.
  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 Elasticsearch, record indexing starts at 0, meaning 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 Elasticsearch, 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 required 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 this section of 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 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 required 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.

  For details about the REST API, see Search.yaml.

Audit Logs

API Control Plane 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.

To retrieve audit logs, specify the following in the request body:

A sample request body is as follows:

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