Update a gateway group

PUT /api/gateway_groups/{gateway_group_id}

Interactive request editor loads with JavaScript.

Path Parameters

gateway_group_id*string

Gateway group ID.

Length1 <= length

Request Body

application/json

environment?string

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.

Value in

"production"
"non_production"

name*string

The object name.

Length1 <= length <= 100

description*string

Gateway group description.

labels?

Key-value pairs of labels.

Response Body

`application/json`

curl -X PUT "$API_BASE_URL/api/gateway_groups/86fb9981-d9d2-4555-9df8-91ae92129335" \  -H "Content-Type: application/json" \  -d '{    "name": "us-west-rsc",    "description": "Gateway group description."  }'

Successfully retrieved or modified the gateway group.

{
  "value": {
    "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

PUT /api/gateway_groups/{gateway_group_id}

Update a gateway group

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

Parameters

gateway_group_id (path, string, required): Gateway group ID.

Request body

Content type: application/json

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.

name (string, required): The object name.
description (string, required): Gateway group description.
labels (object, optional): Key-value pairs of labels.

Responses

200: Successfully retrieved or modified the gateway group.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
value.id (string, optional): The object ID.
value.type (string, optional):
value.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.

value.name (string, optional): The object name.
value.description (string, optional): Gateway group description.
value.labels (object, optional): Key-value pairs of labels.
value.created_at (integer, optional): The object created timestamp.
value.updated_at (integer, optional): The object updated timestamp.
value.config (object, optional): Control plane details.
value.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}.
value.config.control_plane_user (string, optional): The etcd user.
value.config.control_plane_password (string, optional): The etcd password.
value.config.image_tag (string, optional): The API7 gateway version.
400: Invalid arguments. Error details will be provided in the response.

cURL

curl -X PUT '$API_BASE_URL/api/gateway_groups/{gateway_group_id}'

Update a gateway group

200application/json

400

`application/json`