Version: latest

Manage Gateway Groups

Gateway groups allow you to organize data plane instances into logical groups, enabling environment isolation (dev/staging/production), team-based separation, or geographic grouping. Each gateway group has its own configuration scope and can run different versions of the data plane.

This guide shows how to create, inspect, and update gateway groups with the enterprise API.

Prerequisites

An API7 Enterprise instance is running.
A token from the Dashboard.

Create a Gateway Group

You can create a new gateway group to logically group your gateway instances.

curl -k "https://localhost:7443/api/gateway_groups" -X POST \
  -H "X-API-KEY: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "docs-temp-group",
    "description": "Docs validation gateway group",
    "type": "api7_gateway",
    "labels": {
      "env": "docs-test"
    }
  }'

List Gateway Groups

Listing gateway groups helps you view all existing logical groups and their configurations.

curl -k "https://localhost:7443/api/gateway_groups" \
  -H "X-API-KEY: ${API_KEY}"

Generate an Instance Token

Data plane instances need a token to register with a gateway group. Each gateway group can generate its own unique token.

curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}/instance_token" -X POST \
  -H "X-API-KEY: ${API_KEY}"

Update a Gateway Group

You can update the name, description, and labels of an existing gateway group.

curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}" -X PUT \
  -H "X-API-KEY: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "docs-temp-group-updated",
    "description": "Updated docs validation group",
    "labels": {
      "env": "docs-test",
      "team": "docs"
    }
  }'

Validate the Configuration

Verify the configuration by retrieving the details of a specific gateway group.

curl -k "https://localhost:7443/api/gateway_groups/{gateway_group_id}" \
  -H "X-API-KEY: ${API_KEY}"

Next Steps

Understand Gateway Groups — learn the architecture concepts.
Configure Secret Management — manage secrets within gateway groups.

Prerequisites​

Create a Gateway Group​

List Gateway Groups​

Generate an Instance Token​

Update a Gateway Group​

Validate the Configuration​

Next Steps​