Reference Overview

Find API7 Gateway reference documentation for APIs, CLI tools, deployment configuration, security controls, and configuration syntax.

This document provides an index of the technical reference documentation for API7 Gateway components and tools.

Manage API7 Gateway

To compare these management options and their common use cases, see Management Options.

Admin API Reference: Look up API7 Gateway control-plane and gateway management endpoints.
API Declarative CLI (ADC): Manage gateway configuration declaratively from YAML or JSON files.
a7 CLI: Create, inspect, update, and delete gateway groups and gateway resources with CLI commands.
Obtain a Token from the Dashboard: Create a token for API7 Gateway APIs, ADC, and a7.

Configuration Files: Default and custom configuration files for the data plane, including config-default.yaml and config.yaml.
Helm Chart: Helm chart values for Kubernetes deployments, including plugin attributes and static gateway configuration.
Environment Variables: Reserved and custom environment variables for configuring gateway instances.
Shared Memory Sizing: Which lua_shared_dict zones need sizing for your scale, how much each one holds, and how to change the defaults.

Ports and Endpoints: Every port the control plane, data plane, and Developer Portal listen on or connect to, the key that sets it, and the endpoints served on it.

Security Hardening Reference: Reference for understanding where sensitive information is stored and how it is protected.
Permission Policy Actions and Resources: Available actions and resource types for permission policies.
Permission Policy Examples: Example permission policies for common access control scenarios, grouped by use case.

Developer Portal API Reference: Look up endpoints for the standalone Developer Portal backend.

Built-in Variables: Variables available for use in plugin configurations and route matching.
Expressions: Expression syntax for advanced route matching and plugin configuration.
Alert Template: Template configuration for alerts.
Approval Notification Variables and Templates: Variables for customizing API product subscription notification email content and webhook messages.