Skip to main content
To access the API Proxy list, go to Development → API Proxies from the main menu.

Proxy Name

Unique identifier for each API Proxy

Type

REST, SOAP, WebSocket, gRPC, etc.

Status

Deployed / Not Deployed

Environment

Environment where it is deployed

Last Modified

Last modification timestamp

Actions

Quick action buttons

​
API Proxy Search and Filtering

Basic Filtering

FilterDescription
Name SearchSearch by API Proxy name
Type FilterFilter by API Proxy type
Status FilterFilter by deployment status
Environment FilterFilter by deployment environment
Tag SearchSearch by tags assigned to proxies
Search is performed in real-time as you type, making it easy to find specific proxies in large lists.

​
Advanced Filtering

To perform more detailed searches, use the Advanced Filtering feature. You can access advanced filtering options by clicking the relevant icon next to the filter fields on the list. Advanced Filtering Criteria:
CriterionDescription
API Proxy NameRetrieves API Proxy records containing a specific name. Case-insensitive.
API Proxy DescriptionRetrieves API Proxy records containing a specific description. Case-insensitive.
API TypeFilters by protocol type. Options: SOAP, REST
API Proxy TypeFilters by the type selected during creation. Options: Swagger, WSDL, Open API/Swagger 3.0.x, WADL, Fake API, Reverse Proxy, Mirror API, No-Spec API, DB-2-API, Script-2-API, Mock API, Websocket, gRPC, gRPC Proto
Usage TypeFilters by usage type. Options: All, Producer, Consumer, Producer and Consumer
Sharing TypeFilters by the API Proxy’s sharing type.
CategoryFilters by categories.
API Proxy AddressRetrieves API Proxy records containing a specific address. Case-insensitive.
Method/Endpoint NameRetrieves API Proxy records containing a specific method or endpoint name. Case-insensitive.
Method/Endpoint DescriptionRetrieves API Proxy records containing a specific method or endpoint description. Case-insensitive.
Parameter NameRetrieves API Proxy records containing a specific parameter name. Case-insensitive.
Parameter DescriptionRetrieves API Proxy records containing a specific parameter description. Case-insensitive.
Router AddressRetrieves API Proxy records containing a specific routing address. Case-insensitive.
Deployment StatusFilters by deployment status. Options: All, Deployed, Not Deployed
EnvironmentFilters by environment information.
Trace ModeFilters by trace mode. Options: Active, Inactive
Application Log StatusFilters by application log status. Options: Active, Inactive

​
Sorting and View Options

The API Proxy list supports multiple sorting and view options:
  • Sorting: Name, Type, Status, Last Modified, Environment
  • View Options: List view, Grid view, Compact view

​
API Proxy Group Information

In the API Proxy list, the API Proxy groups that each API Proxy belongs to are displayed. An API Proxy can belong to multiple groups, and group information is shown in the list view.
For detailed information about API Proxy groups, you can refer to the API Proxy Groups page.

​
Tagging and Categorization

​
Tag Usage

By Function

Tagging proxies by business functionspayment authentication inventory

By Team

Tagging proxies by responsible teambackend-team frontend-team

By Status

Tagging proxies by development statusdeprecated beta production-ready

By Domain

Tagging proxies by business domaine-commerce analytics reporting

​
Adding Tags

1

Select Proxy

Select an API Proxy from the list
2

Overview Tab

Go to the Overview tab
3

Tags Section

Find the Tags section
4

Add Tag

Type a tag and press Enter - tags are automatically saved

​
Tag-Based Filtering

  • Click a tag in the tag cloud to filter proxies with that tag
  • Combine multiple tags for more specific filtering
  • Use tag search to find proxies with specific tag combinations

​
Tagging Best Practices

Things to Consider:
  • Consistent Naming: Create a tagging convention and stick to it
  • Number of Tags: Use 3-5 tags per proxy
  • Hierarchical Tags: Use dot notation (e.g., payment.credit-card)
  • Documentation: Maintain a tag dictionary for your team

​
Operations Available from the List

In the API Proxy list, the following operations can be performed for each API Proxy:

Export

You can export the API Proxy for backup or migration. The export operation creates a file in JSON format.

Delete

You can delete the API Proxy from the list. Confirmation is requested before deletion.

Duplicate

You can create a copy of an existing API Proxy. The copy operation includes all configurations.

Reparse

You can perform a reparse operation according to the API Proxy type. This operation re-reads and updates the API Proxy’s spec file.
These operations are performed on individual API Proxies. Bulk operation support is not available.

​
Advanced Management Features

Import/Export

Manage proxies for backup and migration
  • Export: Export proxies individually
  • Import: Import from exported files
  • Format: Supports JSON format

Version History

Track changes in your API Proxies
  • View change history
  • Compare different versions
  • Restore previous versions

Access Control

Control who can manage proxies
  • Assign roles to team members
  • Set permissions at proxy level
  • Use team-based access control

​
Effective Management Tips

Consistent Naming

Create naming conventions for your proxies

Use Tags

Use tags extensively for flexible organization

Regular Cleanup

Periodically review unused proxies

Documentation

Keep documentation up to date for each proxy

Monitor Usage

Use analytics to identify unused proxies