Create a new service group for organizing services on a gateway
Route
POST /gateway_manager/v1/service-groups
Roles
service-group:create
Parameters
DetailsExampleSchema
Name
Type
Required
Description
serviceGroup
object
yes
The parameters for the service group that should be added
Copied to Clipboard
{
"serviceGroup": {
"name": "default-services",
"cluster_id": "cluster_1",
"services": [
"bec60e1b-532c-4293-8263-12f78211518d",
"bec60e1b-532c-4293-8263-12f78211518d"
],
"groups": [
"admins",
"admins",
"admins"
],
"description": "Default service group for gateway"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"serviceGroup": {
"title": "serviceGroup",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name for service group (unique to the gateway)",
"examples": [
"default-services"
]
},
"cluster_id": {
"type": "string",
"description": "The cluster_id for the gateway which services are managed by this service group",
"examples": [
"cluster_1"
]
},
"description": {
"type": "string",
"description": "Description of the service group",
"examples": [
"Default service group for gateway"
]
},
"services": {
"type": "array",
"description": "Array of gateway service IDs to include in the service group",
"items": {
"type": "string",
"examples": [
"bec60e1b-532c-4293-8263-12f78211518d"
]
}
},
"groups": {
"type": "array",
"description": "Array of group names allowed to perform actions on the service group",
"items": {
"type": "string",
"examples": [
"admins"
]
}
}
},
"required": [
"name",
"cluster_id",
"services",
"groups"
],
"additionalProperties": false
}
},
"required": [
"serviceGroup"
],
"additionalProperties": false
}
