Skip to main content

Clients

Clients represent API consumers in FastGateway, providing identity management for access control through IP addresses and API keys.

What is a Client?

A client is an entity that consumes your APIs, such as:

  • External partner applications
  • Internal microservices
  • Mobile applications
  • Third-party integrations

Client Properties

PropertyDescription
NameHuman-readable identifier
TeamOwning team responsible for the client
IP AddressesAllowed source IPs for IP-based filtering
API KeysSecret keys for API key authentication

Client Credentials

IP Addresses

Allowed IPs:
- 192.168.1.0/24
- 10.0.0.5

API Keys

API Key: fg_live_abc123...
Header: X-API-Key

Client Attachments

Clients connect to routes through attachments, which:

  • Link a client to a specific route
  • Enable client-specific security policies
  • Require approval before activation
┌────────┐         ┌────────────┐         ┌───────┐
│ Client │ ──────▶ │ Attachment │ ──────▶ │ Route │
└────────┘ └────────────┘ └───────┘

Team Ownership

Each client belongs to a team:

  • Team members manage client credentials
  • Cross-team attachments require dual approval
  • Client deletion removes all attachments

Clients provide the foundation for the Client security mode, enabling per-consumer access control.