Get a gateway group

GET /api/gateway_groups/{gateway_group_id}

Get a gateway group

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

Parameters

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

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.

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.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 GET '$API_BASE_URL/api/gateway_groups/{gateway_group_id}'