The APIM console has a main menu on the left and a submenu for each section. When opened, it shows Dashboard, APIs, Applications, Audit, Analytics, and Settings. Use the Environment selector above the menu to switch environments. This article is for API publishers and administrators who manage APIs in the console, and briefly explains the console and each section. Learn more about API management features.
Navigate to → to access the console.
Note: The sections shown when you open an API depend on its API definition version. v4 APIs show the current layout described in this article. v2 APIs show the legacy layout, described in the v2 API sections of this article. Learn more about API definitions.
Dashboard and Analytics
You can view analytics from three areas: the console Dashboard, the Analytics tab, and each API's API Traffic section. You can use the out-of-the-box analytics or customize them to fit your needs.
Dashboard
Use the Dashboard in the main menu to monitor your APIs from four tabs:
- Overview – A summary of your total APIs and applications, API lifecycle and state charts, API response status, top APIs, request and response time statistics, and recent API events. Use the Show data for list to change the time range.
- API Health Check – Each API is monitored by a periodic HTTP request to its health check endpoint. The API backend receives the request and responds, and the health check service determines whether the response is as expected. Use Filter to APIs with Health Check enabled to hide APIs without health checks.
- My Tasks – Items that need your attention, such as pending subscription requests. Select Validate to act on a task.
- Broadcasts – Send a one-way message to every user or member in the API management system, or narrow it to a subset of recipients. You can't send an individual message to one person. Messages are limited to 250 characters. To message only a specific API's consumers, use that API's Consumers → Broadcasts tab instead.
Analytics
The Analytics tab in the main menu gives you a deep dive into your API usage information, allowing you to filter by Global, Geo, or Users properties. From this page, you can also view Platform logs and see information on Top Applications being used by your API consumers.
API-specific analytics
To view analytics for a single v4 API, open the API and select API Traffic (see the API Traffic section of this article). For v2 APIs, choose the API and scroll to Analytics in the submenu. Use logging with caution and only for development purposes. It requires more space for analytics storage and can impact API performance.
Learn more about configuring your analytics and dashboard.
APIs
API consumers call or subscribe to APIs to retrieve data or invoke functionality. Your APIs are the data source or functionality you want to expose to your consumers. You can view a list of all your APIs or search for a specific API and configure its settings, including policies, plans, subscriptions, and documentation.
When you open an API, its name, version, and status chips (such as Started and Published) appear above the submenu. The submenu sections depend on the API definition version.
Configuration (v4)
Manage general settings, user permissions, properties, and resources, and track changes to your API from six tabs.
- General – Edit the API's name, version, description, labels, categories, and API picture and background. You can also see the owner, creation date, and last connection, and use the Export, Import, Duplicate, and Promote actions. The Danger Zone at the bottom contains lifecycle actions: Stop the API, Unpublish the API, Make Private, Deprecate, and Delete. A running or published API cannot be deleted.
- User Permissions – Manage who can interact with your API through the console. Add members, manage groups, or transfer ownership. Toggle Notify members when they are added to the API as needed.
- Properties – Define key-value pairs at the API level. Properties are automatically injected into the Expression Language context, and are read-only during the Gateway's execution of an API transaction. You can add properties manually, import them, or manage them dynamically.
- Resources – Configure resources to support your API. Resources are linked to the API lifecycle: they are initialized when the API starts and released when it stops, and are used by API policies.
- Notifications – Enable event notifications for this API, such as subscriptions, API key expirations, and API lifecycle events, using a Portal, Email, or Webhook notifier.
- Audit Logs – Review audit logs at the API level. These are audit logs for your API management service, not for logging your API events — they cover management events like expired API keys, updated API configurations, and subscription and plan updates. Filter by event or date range. To log API events instead, see the API Traffic section of this article.
Entrypoints (v4)
Define the protocol and configuration settings by which API consumers access the Gateway API.
-
Entrypoints – Configure the entrypoint context-paths that determine how users access your API. For example, in a NASA API, your context path would be
/nasa. If you push your API through integrator.io, this is set automatically. You can add context-paths or enable virtual hosts. - CORS – The most important configuration in this section. You must enable CORS to use the Try it feature, which allows consumers to test your API before subscribing to it. Configure the allowed origins, methods, and headers, and whether to allow credentials and run policies for preflight requests.
Endpoints (v4)
Define the protocol and configuration settings by which the Gateway API fetches data from, or posts data to, the backend API.
- Endpoints – View and manage the endpoint groups associated with your API, such as the Default HTTP proxy group. Each group shows its load-balancing type (for example, round robin). Add endpoints to a group or add new endpoint groups.
- Failover – Redirect incoming traffic to a secondary server or backup system if the primary server fails, ensuring high availability.
- Health-check – Select Edit for an endpoint group and open the Health-check tab to monitor the availability and health of your endpoints or API Gateways. The API must be deployed for health checks to run. Results appear at Dashboard → API Health Check.
Load-balancing is a technique used to distribute incoming traffic across multiple backend servers. The goal of load-balancing is to optimize resource utilization, maximize throughput, minimize response time, and avoid overloading any single server. The Gateway comes with a built-in load balancer, which you can enable and configure for your API endpoints according to your requirements.
Learn more about Health check.
Policies (v4)
Policies let you customize and enhance your API behavior and functionality. The Policies section is a no-code tool for designing "flows" — policy enforcement sequences that protect, transform, or alter how your API is consumed. To learn more about a specific policy, see the APIM Policy Reference Guide.
Important:
- An APIM flow relates to the different phases of creating, managing, publishing, and subscribing to an API in APIM. This is not the same as a Celigo integrator.io flow.
- You do not have to create a flow to add a policy to the API. However, adding a flow allows you to better control what phases a policy is added to.
Flows are grouped by plan (for example, an API key plan) and as Common flows that apply at the API level. Select a flow to see its details, including the path, path operator, and HTTP methods it applies to, and add policies to each phase:
- Request phase – Policies are applied during the connection establishment, before a client can access the API they are trying to call.
- Response phase – Policies are applied during the connection termination, after the request is allowed but before the response is returned to the client.
- Publish phase (message APIs) – Policies are applied to messages sent to the endpoint.
- Subscribe phase (message APIs) – Policies are applied to messages received by the entrypoint.
You can add multiple policies to a single flow, each with a different configuration and phase. Select Save to apply your changes, then redeploy the API.
Consumers (v4)
Manage how your API is consumed from three tabs.
- Plans – Create and manage the plans consumers subscribe to. Plans move through Staging, Published, Deprecated, and Closed states. Select Add new plan to create one. Learn more about creating and managing plans.
- Subscriptions – Manage subscriptions to your plans. Filter by plan, application, status, or API key; export the list as a CSV; or create a subscription on a consumer's behalf. This is where you approve pending subscriptions if your plan uses manual validation.
- Broadcasts – Send a one-way message to your API's consumers, useful for general alerts or updates about the API. Choose the channel and recipients, then enter a title and message (250-character limit).
Documentation (v4)
Documentation pages appear in the Developer Portal and inform API consumers how to use your API. The section has three tabs: Main Pages, Documentation Pages, and Metadata. Your OpenAPI spec (OpenAPISpec.yaml) is generated automatically in most cases, but you must still validate and publish it before it's viewable — use the cloud icon to publish. You can add pages and folders, and select Open API in Developer Portal to preview the result. Learn more about configuring and publishing APIM documentation.
Deployment (v4)
Manage sharding tags and track every change of your API.
- Configuration – Assign sharding tags to control where the API is deployed. Sharding tags are configured at the organization level.
- Deployment History – View all API deployment changes, including which version is in use. Select a version to view it, or select two to compare.
API Traffic (v4)
Gain insights into API performance with real-time metrics, logs, and notifications from three tabs.
- Analytics – An overview of your entrypoint traffic: total requests, average connection duration, and response status breakdown.
- Runtime Logs – Review the runtime logs associated with calls to your API. Filter by period, entrypoint, HTTP method, or plan.
- Settings – Configure logging modes for this API. Use logging with caution and only for development purposes. It requires more space for analytics storage and can impact API performance.
v2 API definitions
If your API uses a v2 API definition, the API submenu shows the following sections instead.
Policy Studio
The Policy Studio is a no-code tool for creating and managing your API. You can configure policies to determine how users will interact with the API, including what features of the API they can access and what governance policy configurations are enforced. The studio is laid out in a simple drag-and-drop format so that you can start quickly. To learn more about a specific policy, see the APIM Policy Reference Guide.
The Policy Studio allows you to design "flows" or policy enforcement sequences that protect, transform, or alter how APIs are consumed. It's a no-code tool for creating and managing your API.
Important:
- An APIM flow relates to the different phases of creating, managing, publishing, and subscribing to an API in APIM. This is not the same as a Celigo integrator.io flow.
- You do not have to create a flow to add a policy to the API. However, adding a flow allows you to better control what phases a policy is added to.
The Policy Studio's purpose and functionality are broken into the following sections:
- Design – Manage all flows associated with your Gateway API
- Configuration – Modify settings around flow execution
- Properties – Define key-value pairs at the API level. These properties are read-only during the Gateway's execution of an API transaction.
- Resources – Configure global resources to support your Gateway API's flows
You can create a flow in the Policy Studio and add one or more policies to the Request, Response, Publish, or Subscribe phases. To learn more about a specific policy, see the APIM Policy Reference Guide. When a policy is applied and how it is enforced depends on the phase:
- Request phase – A policy is applied during the connection establishment. The Gateway enforces the policy at the time of the request before a client can access the API they are trying to call.
- Response phase – A policy is applied to the response from the initial connection. The Gateway enforces the policy after the request is allowed, but before the response is returned to the client.
- Publish phase – A policy is applied to messages sent to the endpoint. The Gateway enforces the policy when messages are published before clients can access the API they are trying to call.
- Subscribe phase – A policy is applied to messages received by the entrypoint. The Gateway enforces the policy after messages are subscribed to, but before the response is returned to the client.
You can create multiple policies for a single flow, each with a different configuration and applied to a different API phase. Flows can also be associated with specific plans or as common flows at the API level.
Learn more about the Policy Studio.
(API-specific) Messages
Send messages to your API consumers. This can be particularly useful for general alerts or updates about an API. You can send messages to all subscribers or just a subset based on account ownership.
General
Use this section to configure plans, documentation, or internal user access. You can categorize APIs in the Info section, start or stop an API, deploy the API, or even add labels. This is also where you can manage your Plans and subscriptions. You'll need to use these features regularly to restrict access to your APIs. Finally, use the Documentation option to create and publish OpenAPI specs. While integrator.io will automatically generate a spec in most cases, you'll still need to validate and publish it before it's viewable.
Proxy
The Proxy section handles anything related to your API entrypoints, determining how users access your API. For example, in a NASA API, your context path would be /nasa. If you push your API through integrator.io, this will be set automatically. The most important configuration in this section is CORS. You'll need to enable CORS to get access to the Try it feature, which allows consumers to test your API before subscribing to it. Learn more about Configuring proxy settings.
Backend services
Use this section to view all the endpoints associated with your API.
Load-balancing is a technique used to distribute incoming traffic across multiple backend servers. The goal of load-balancing is to optimize resource utilization, maximize throughput, minimize response time, and avoid overloading any single server. The Gateway comes with a built-in load balancer, which you can enable and configure for your API endpoints according to your requirements.
Failover is a mechanism to ensure high availability and reliability of APIs by redirecting incoming traffic to a secondary server or backup system in the event of a primary server failure. Celigo's API management includes built-in failover mechanisms and capabilities.
Enable Health check to monitor the availability and health of your endpoints or API Gateways. Celigo recommends enabling Health check for every API. Navigate to Backend services → Health-check to enable it, and review results in the Health-check dashboard.
Learn more about Health check.
(API-specific) Audit
This section allows you to check logs at the API level. These are audit logs for your API management service, not for logging your API events. Instead, these audit logs focus on management events, like expired API keys, updated API configurations, and subscription and plan updates.
See this article's Dashboard and Analytics section to learn about logging API events.
Notifications
Use this section to enable event notifications. These notifications are related to events in your API, like subscriptions, API key expirations, and API lifecycle events.
Applications
This tab displays all applications, including any you've created and applications created by your API consumers. Select an application to open its submenu:
- Global settings – Edit the application's name, description, domain, and picture, and view its owner, type, and API key mode. This is also where you configure the OAuth2 client ID and TLS client certificate, and where you can subscribe the application to APIs.
- User and group access – Manage the application's members and groups, or transfer ownership.
- Metadata – Create application metadata to retrieve custom information about your API.
- Subscriptions – View and manage all of the application's subscriptions, filter by API, status, or API key, and create a subscription. This is also where you can approve a pending subscription to an API.
- Analytics – Review application-level dashboards, including top paths, status breakdowns, and top, failed, and slow APIs.
- Logs – Review the application's request logs. Filter by request or transaction ID, method, path, response time, HTTP status, or API, and export results as a CSV.
- Notification settings – Configure notifications for this application using a Portal, Email, or Webhook notifier.
Note: While you can create an application and subscribe to an API here, you should become familiar with the Developer Portal, where your API consumers can create their own applications.
Audit
Use the Audit tab to review audit logs across your API management environment. These logs are not specific to a particular API. Filter by event, type (such as API or environment), or date range. Each entry shows the user, event, and target, and you can view the patch for details.
Settings
You can configure various settings in this tab. The submenu is organized into four groups: Portal, Gateway, User Management, and Notifications.
Portal
Various settings allow you to configure your Developer Portal and the APIM console.
Analytics
Configure Platform, API, and Application dashboards. Learn more about configuring your analytics and dashboard.
API Portal Information
Allows you to add extra information about your APIs in the Developer Portal. You can also configure the information shown for each API and a promotion banner.
API Quality
The Celigo Quality feature enables API governance by allowing you to create and automatically assign customizable scores based on certain variables determined to impact API quality. If API Quality is enabled, APIs that you create in Celigo will automatically be assigned an API quality score.
Authentication
Control how users sign in to the Developer Portal. You can force authentication to access the portal and show or hide the login form.
Categories
Switch on to enable Category mode, which automatically replaces the API gallery with a Category gallery. Switch off to disable this option.
Client Registration
Configure the default application type and the application types users can create (Browser, Web, Native, Backend-to-Backend). Client registration providers allow you to plug in any authorization server that is compliant with OpenID Connect Dynamic Client Registration. By defining a DCR provider, you can automatically associate an OAuth client with an application and apply security best practices according to the application type.
Documentation
Site-wide documentation creates a direct line of communication with your developer community. Administrators can use site-wide documentation to communicate best practices, configure pages, or as a reference via custom navigation. Published documentation is accessible from the Developer Portal's Documentation page.
Metadata
Create Global metadata to retrieve custom information about your API.
Settings
Configure settings for both the APIM console and the Developer Portal.
Console – Set your company name, choose which security plan types are available (Keyless, API key, OAuth2, JWT, and — for v4 APIs only — Push and mTLS plans), and configure whether custom API keys are allowed and whether an API key can be shared across an application. You can also maintain an API labels dictionary, toggle the Dashboard's API status panel, and set the API primary owner mode (Hybrid, User, or Group).
Portal – Configure the API key header shown in portal cURL examples (x-celigo-api-key), the portal URL, tile mode, support settings, ratings, and user registration. You can determine how users view your OpenAPI documentation (Swagger-UI or Redoc) and set scheduler and documentation URL options. Do not configure site-wide CORS settings here. If you want to use CORS, enable it directly in your API's Entrypoints → CORS settings (v4) or your API's settings (v2) instead.
New Developer Portal – A tech preview of the redesigned Developer Portal. Enable it to try the new experience; it may change as Celigo gathers feedback.
Theme
Here, you can update your Developer Portal themes.
Top APIs
View your top APIs.
Gateway
Celigo's API Management feature only allows you to configure dictionaries.
Dictionaries
While API Publishers can create properties for their own APIs, dictionaries provide a way to manage properties independent of individual APIs, making it possible to apply them across APIs and maintain them globally by a different user profile, such as an administrator.
Dictionary properties are based on key-value pairs. You can create two types of dictionaries:
- Manual dictionaries, with static properties defined manually at dictionary creation time
- Dynamic dictionaries, with properties updated continually, based on a schedule and source URL defined at dictionary creation time
You can use dictionaries anywhere in APIM where Expression Language is supported, such as when defining policies for API flows. You can access dictionary properties with the Expression Language statement #dictionaries.
Dictionaries need to be deployed to the API Gateway before you can use them. You can see the date and time the dictionary was last deployed in the dictionary list.
User Management
Groups
Create groups of users and choose whether each group is automatically associated with new APIs and new applications.
Notification settings
Configure your own Developer Portal notifications using a Portal, Email, or Webhook notifier.