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
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | The query parameters available for this method. |
{ "queryParameters": null }
{ "type": "object", "properties": { "queryParameters": { "description": "The query parameters available for this method.", "type": "object", "properties": {}, "required": [ "queryParameters" ], "additionalProperties": false } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
response | object | - |
{ "state": "Success", "results": [ { "_id": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": false, "description": "Default service group for the gateway", "created": "2012-12-03T13:25:48.741Z", "created_by": "officia quis elit", "last_updated": "2016-08-26T14:07:40.661Z", "last_updated_by": "sunt enim", "groups": [ "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" } ] }, { "_id": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": true, "description": "Default service group for the gateway", "created": "2016-12-15T03:30:52.824Z", "created_by": "aliqua ipsum ullamco sunt nostrud", "last_updated": "1968-09-25T19:43:45.597Z", "last_updated_by": "sed", "groups": [ "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": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": true, "description": "Default service group for the gateway", "created": "1994-02-10T23:40:25.752Z", "created_by": "deserunt irure cupidatat sed", "last_updated": "2023-03-23T06:31:42.745Z", "last_updated_by": "non officia ea enim in", "groups": [ "gm-admins", "gm-admins", "gm-admins" ], "services": [ { "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "name": "my-tofu-service" } ] }, { "_id": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": true, "description": "Default service group for the gateway", "created": "2007-07-28T14:07:30.842Z", "created_by": "et nostrud ut Duis", "last_updated": "1953-09-02T08:10:40.955Z", "last_updated_by": "non culpa velit cupidatat ex", "groups": [ "gm-admins" ], "services": [ { "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "name": "my-tofu-service" }, { "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "name": "my-tofu-service" } ] }, { "_id": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": false, "description": "Default service group for the gateway", "created": "2013-03-21T01:03:31.891Z", "created_by": "exercitation quis Lorem eu dolore", "last_updated": "1962-05-17T04:51:45.273Z", "last_updated_by": "fugiat veniam", "groups": [ "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" } ] } ] }
{ "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" ] } } } } } } } } }