Read API proxy

The Client Registry is a repository of organizations, API consumers, and client applications that consume the APIs registered in API Manager. The Client Registry also contains the authentication credentials of the client applications, and authorization and quota policies defined at the organization and application level. The Client Registry is stored in a Key Property Store (KPS) backed by an Apache Cassandra database.

Policy Studio includes API Management filters that provide read-only access to the Client Registry. These enable policy developers to develop policies in Policy Studio that leverage the information in the Client Registry.

You can use the Read API Proxy filter to get information from the client registry about an API proxy.

This filter stores the information in a message attribute (for example, apimgmt.apiproxy). You can use this filter within an alert handling policy (or any other policy) to get information about an API proxy easily.

General settings

Configure the following fields:


Enter an appropriate name for the filter.

API Proxy ID selector:

Enter a selector expression with the name of the message attribute that contains the API proxy ID. ID is the key to the API proxy record in the KPS. The value of the selector is expanded at runtime. The default is ${}.

Name of attribute to set:

Enter the name of the message attribute to set. The default is apimgmt.apiproxy.

Further information

For more details on configuring policies, see the API Gateway Policy Developer Guide.

Related Links