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 (optional). |
{ "queryParameters": { "cluster_id": "reprehenderit nostrud est" } }
{ "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
Name | Type | Description |
---|---|---|
response | object | A list of all service groups that the user has access to |
{ "state": "Success", "results": [ { "_id": "66ff56eb64d3de9f6f930916", "name": "Default Service Group", "cluster_id": "cluster_1", "is_default": false, "description": "Default service group for the gateway", "created": "2004-03-20T14:19:36.416Z", "created_by": "in et occaecat", "last_updated": "1973-04-15T05:32:46.236Z", "last_updated_by": "ea anim aliqua voluptate velit", "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": "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": "2008-11-29T04:51:14.706Z", "created_by": "et dolor ullamco", "last_updated": "1962-07-29T11:37:24.194Z", "last_updated_by": "magna ipsum", "groups": [ "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" }, { "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": "1976-05-02T06:25:22.861Z", "created_by": "eiusmod aute", "last_updated": "1997-03-15T07:19:21.886Z", "last_updated_by": "labore ipsum occaecat Lorem", "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": "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": "1992-03-05T17:41:39.375Z", "created_by": "sunt exercitation labore reprehenderit veniam", "last_updated": "1963-07-16T17:15:24.033Z", "last_updated_by": "amet pariatur", "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" }, { "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": "1995-04-08T14:57:32.723Z", "created_by": "mollit Lorem voluptate laboris", "last_updated": "1953-09-20T00:14:34.683Z", "last_updated_by": "anim", "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": "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" ] } } } } } } } } }