Updates information about a specific service group
Route
PATCH /gateway_manager/v1/service-groups/:id
Roles
service-group:update
Parameters
DetailsExampleSchema
Name
Type
Required
Description
id
string
yes
The ID of the service group to update
patches
object
yes
Patches to apply to the service group
Copied to Clipboard
{
"patches": {
"name": "Updated Service Group",
"description": "Updated description for the service group",
"services": [
"debe9024-52ee-4b39-8c49-96567ff925e4",
"debe9024-52ee-4b39-8c49-96567ff925e4"
],
"groups": [
"admins"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"patches": {
"title": "patches",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name for the service group",
"examples": [
"Updated Service Group"
]
},
"description": {
"type": "string",
"description": "Updated description for the service group",
"examples": [
"Updated description for the service group"
]
},
"services": {
"type": "array",
"description": "Updated list of service IDs in the service group",
"items": {
"type": "string",
"examples": [
"debe9024-52ee-4b39-8c49-96567ff925e4"
]
}
},
"groups": {
"type": "array",
"description": "Updated list of group names allowed to access the service group",
"items": {
"type": "string",
"examples": [
"admins"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"patches"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
response
object
Result of updating the service group
Copied to Clipboard
{
"state": "Success",
"message": "Service group updated: 66ff56eb64d3de9f6f930916"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"message": {
"type": "string",
"examples": [
"Service group updated: 66ff56eb64d3de9f6f930916"
]
},
"result": {
"type": "object",
"description": "The result of the database update operation",
"properties": {}
}
}
}