Summary
Get all service groups
Description
Gets information about all service groups, optionally filtered by cluster_id
Route
GET /gateway_manager/v1/service-groups
Roles
service-group:read
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryParameters |
object |
yes |
The query parameters available for this method (optional). |
Copied to Clipboard
{
"queryParameters": {
"cluster_id": "nisi exercitation aliquip"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryParameters": {
"title": "queryParameters",
"type": "object",
"properties": {
"cluster_id": {
"type": "string",
"description": "The cluster Id for the gateway to pull service groups for (optional)"
}
},
"additionalProperties": false
}
},
"required": [
"queryParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
A list of all service groups that the user has access to |
Copied to Clipboard
{
"state": "Success",
"results": [
{
"_id": "66ff56eb64d3de9f6f930916",
"name": "Default Service Group",
"cluster_id": "cluster_1",
"is_default": false,
"description": "Default service group for the gateway",
"created": "2022-02-13T22:30:31.063Z",
"created_by": "labore aliqua Excepteur sed",
"last_updated": "1980-10-01T09:33:21.127Z",
"last_updated_by": "in ullamco",
"groups": [
"gm-admins",
"gm-admins",
"gm-admins",
"gm-admins",
"gm-admins"
],
"services": [
{
"id": "debe9024-52ee-4b39-8c49-96567ff925e4",
"name": "my-tofu-service"
},
{
"id": "debe9024-52ee-4b39-8c49-96567ff925e4",
"name": "my-tofu-service"
},
{
"id": "debe9024-52ee-4b39-8c49-96567ff925e4",
"name": "my-tofu-service"
},
{
"id": "debe9024-52ee-4b39-8c49-96567ff925e4",
"name": "my-tofu-service"
}
]
}
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The Id of the service group within the database",
"examples": [
"66ff56eb64d3de9f6f930916"
]
},
"name": {
"type": "string",
"examples": [
"Default Service Group"
]
},
"cluster_id": {
"type": "string",
"examples": [
"cluster_1"
]
},
"is_default": {
"type": "boolean"
},
"description": {
"type": "string",
"examples": [
"Default service group for the gateway"
]
},
"created": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
},
"last_updated": {
"type": "string",
"format": "date-time"
},
"last_updated_by": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "string",
"examples": [
"gm-admins"
]
}
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"debe9024-52ee-4b39-8c49-96567ff925e4"
]
},
"name": {
"type": "string",
"examples": [
"my-tofu-service"
]
}
}
}
}
}
}
}
}
}
