Reference Overview

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

Configuration

• 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.

CLI Tool

• API Declarative CLI (ADC): Declarative configuration CLI for API7 Gateway, with conceptual guidance and a link to the ADC documentation.

Security

• Admin API Reference: OpenAPI reference for API7 Gateway and API7 Enterprise management endpoints exposed through the generated Admin API page.
• Developer Portal API Reference: OpenAPI reference for the standalone Developer Portal backend.
• Obtain a Token from the Dashboard: Create a Dashboard token for API7 Enterprise Admin API and ADC authentication.
• 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.

Other

• 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.