API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsList all gateway groups

List all gateway groups

GET /api/gateway_groups

GET /api/gateway_groups

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Query Parameters

direction?string

Order to list the resources by. The sorting index follows the configuration of order_by.

Default"desc"

Value in

  • "asc"
  • "desc"
page_size?integer

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
page?integer

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
order_by?string

Index to order resources by.

Default"updated_at"

Value in

  • "created_at"
  • "updated_at"
search?string

Condition to search resources by.

name?string

Gateway group name.

Length1 <= length
labels?string

Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.

Length1 <= length

Response Body

application/json

curl -X GET "$API_BASE_URL/api/gateway_groups?search=version%253Dv2&name=default"

Successfully retrieved the paginated list of gateway groups.

{
  "total": 1,
  "list": [
    {
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "type": "api7_gateway",
      "environment": "production",
      "name": "us-west-rsc",
      "description": "Gateway group description.",
      "labels": {
        "version": "v2",
        "env": "prod"
      },
      "created_at": 1742288232,
      "updated_at": 1742288235,
      "config": {
        "control_plane_key_prefix": "/gateway_groups/us-west-1",
        "control_plane_user": "etcd_user",
        "control_plane_password": "safe_password",
        "image_tag": "latest"
      }
    }
  ]
}
Complete operation details and schema variants

GET /api/gateway_groups

List all gateway groups

IAM Action: gateway:GetGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s

Parameters

  • direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
  • page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • order_by (query, string, optional): Index to order resources by.
  • search (query, string, optional): Condition to search resources by.
  • name (query, string, optional): Gateway group name.
  • labels (query, string, optional): Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.

Responses

  • 200: Successfully retrieved the paginated list of gateway groups.
  • allOf variant 1
  • list (array, optional): An array of resources.
  • total (integer, optional): Total number of objects.
  • allOf variant 2
  • list (array, optional): An array of gateway groups.
  • list[].id (string, optional): The object ID.
  • list[].type (string, optional):
  • list[].environment (string, optional): Which license DP core allowance the gateway group's data plane instances draw from:
  • production: counted against max_dp_cores.
  • non_production: counted against max_non_production_dp_cores.

The two allowances are metered and restricted independently, so a gateway group used for staging or testing does not consume production cores. Creating a gateway group without this field puts it on the production allowance; updating one without it leaves the allowance unchanged.

  • list[].name (string, optional): The object name.
  • list[].description (string, optional): Gateway group description.
  • list[].labels (object, optional): Key-value pairs of labels.
  • list[].created_at (integer, optional): The object created timestamp.
  • list[].updated_at (integer, optional): The object updated timestamp.
  • list[].config (object, optional): Control plane details.
  • list[].config.control_plane_key_prefix (string, optional): The prefix of the key in the control plane (etcd). The pattern is /gateway_groups/{gateway_group_id}.
  • list[].config.control_plane_user (string, optional): The etcd user.
  • list[].config.control_plane_password (string, optional): The etcd password.
  • list[].config.image_tag (string, optional): The API7 gateway version.
  • 400: Invalid arguments. Error details will be provided in the response.

cURL

curl -X GET '$API_BASE_URL/api/gateway_groups'

Token

Previous Page

Create a gateway group

Next Page