> For the complete documentation index, see [llms.txt](https://docs.digitalapi.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalapi.ai/api-gateway/reference/glossary.md). # Glossary API Product : A bundle of one or more APIs offered to developers as a single subscribable unit. An API Product carries a name, description, optional quota, and a list of environments where it is published. App : A registered application that calls one or more API Products on behalf of a developer. An app holds the credentials. A client ID and a client secret. That AILIX recognises at the gateway. Authentication configuration : A SAML identity-provider connection that AILIX honours when users sign in to the portal. The configuration carries the IdP entity ID, the X.509 certificate, the service-provider entity ID, and a button label that appears on the login page. Custom report : A saved chart or table built from analytics data. Custom reports run on the same data the dashboard reads but expose their own filter set and grouping. Custom widget : A saved chart on the Observability surface that tracks one metric over time. Widgets are user-defined: pick a metric (request count, error rate, p50/p95/p99 latency), a chart type (KPI number, line, bar), filters, and a title. The widget renders against live gateway data and is editable later. Developer : An external person or team that consumes APIs through AILIX. In the portal sidebar this group is labelled ‘Consumers’; the underlying object and the URL prefix call them ‘developers’. Environment : A named deployment target (for example, staging or production). Services are deployed into environments; an environment has its own gateway hostname, traffic, and metrics. Group : A labelled collection of users used to grant the same set of roles to several users at once. Manager Portal : An adjacent portal surface used to administer one or more AILIX gateway clusters. It is configured separately and is out of scope for this guide; see your operations runbook. Node : One instance of an upstream. Several nodes can sit behind a single upstream and AILIX load-balances across them. Organisation : The multi-tenant container in AILIX. Every user, group, role, service, plugin, and route belongs to one organisation. Permission : The atomic unit of access control. Expressed as `.`; for example, `service.delete`. Plugin : A modular extension that mutates a request, a response, or gateway behaviour. Plugins are attached at service, route, or consumer scope and run in a defined order. Plugin Catalog : The browsable inventory of every plugin AILIX ships. The catalog groups plugins by category and shows the configuration each plugin accepts. You attach plugins from the catalog onto a service, a route, or a consumer. Plugin scope : The level at which a plugin is attached. Global plugins run for every request; service-level plugins run for every route on that service; route-level plugins run only for that route; consumer-level plugins run only when a specific consumer is calling. Quota : The maximum number of requests an app or developer can make against an API Product within a given interval. Quota is set on the API Product. Request trace : The end-to-end record of a single request through the gateway, including timing per plugin and per upstream call. Revision : A snapshot of a service’s configuration. Revisions can be deployed to environments and rolled back. Role : A named bundle of permissions. Each permission is a verb on a resource type (for example, ‘api.create’ or ‘role.update’). Roles are assigned to users or to groups. Route : The match rule that says ‘when an inbound request looks like X, forward it to upstream Y’. Routes match on path, host, method, header, and priority. Service : A logical group of routes and policies that fronts one or more backend APIs. In AILIX, every API you publish is bound to a service. Upstream : A backend (one or more nodes) that AILIX routes traffic to. An upstream is named, has a scheme, a port, a load-balancing strategy, and health-check settings. User : An identity that signs in to the AILIX portal. Distinct from a developer (who consumes APIs) and from a consumer app (which presents credentials at the gateway). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digitalapi.ai/api-gateway/reference/glossary.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.