Summary
Get all services
Description
Get all services across all gateways, optionally filtered by cluster_id
Route
GET /gateway_manager/v1/services
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| queryParameters | object | yes | The query parameters available for this method (optional). |
{ "queryParameters": { "cluster_id": "velit" } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "cluster_id": { "type": "string", "description": "The cluster Id for the gateway to pull services for (optional)" } }, "additionalProperties": false } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| result | object | All of the services that exist across all gateways |
{ "state": "Success", "result": [ { "_id": "67114d64d97db4ea87998b79", "active": false, "service_metadata": { "location": "cluster_1", "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service", "type": "opentofu-plan", "created": "2024-10-17T17:45:06.544Z", "name": "my-tofu-service", "description": "ipsum reprehenderit ut in", "repository": { "id": "dolore ipsum commodo", "name": "t-scripts", "type": "v1.Repository" }, "tags": [], "working_dir": "plan-dir" }, "last_run": 1729187315871 }, { "_id": "67114d64d97db4ea87998b79", "active": false, "service_metadata": { "location": "cluster_1", "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service", "type": "opentofu-plan", "created": "2024-10-17T17:45:06.544Z", "name": "my-tofu-service", "description": "magna pariatur proident sed", "repository": { "id": "dolore ex aute", "name": "t-scripts", "type": "v1.Repository" }, "tags": [], "working_dir": "plan-dir" }, "last_run": 1729187315871 }, { "_id": "67114d64d97db4ea87998b79", "active": true, "service_metadata": { "location": "cluster_1", "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service", "type": "opentofu-plan", "created": "2024-10-17T17:45:06.544Z", "name": "my-tofu-service", "description": "ut ea ipsum tempor", "repository": { "id": "esse amet proident", "name": "t-scripts", "type": "v1.Repository" }, "tags": [], "working_dir": "plan-dir" }, "last_run": 1729187315871 }, { "_id": "67114d64d97db4ea87998b79", "active": true, "service_metadata": { "location": "cluster_1", "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service", "type": "opentofu-plan", "created": "2024-10-17T17:45:06.544Z", "name": "my-tofu-service", "description": "commodo", "repository": { "id": "anim", "name": "t-scripts", "type": "v1.Repository" }, "tags": [], "working_dir": "plan-dir" }, "last_run": 1729187315871 }, { "_id": "67114d64d97db4ea87998b79", "active": true, "service_metadata": { "location": "cluster_1", "id": "debe9024-52ee-4b39-8c49-96567ff925e4", "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service", "type": "opentofu-plan", "created": "2024-10-17T17:45:06.544Z", "name": "my-tofu-service", "description": "aliquip nostrud", "repository": { "id": "exercitation commodo", "name": "t-scripts", "type": "v1.Repository" }, "tags": [], "working_dir": "plan-dir" }, "last_run": 1729187315871 } ] }
{ "type": "object", "properties": { "state": { "type": "string", "examples": [ "Success" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "examples": [ "67114d64d97db4ea87998b79" ] }, "active": { "type": "boolean" }, "service_metadata": { "type": "object", "properties": { "location": { "type": "string", "examples": [ "cluster_1" ] }, "id": { "type": "string", "examples": [ "debe9024-52ee-4b39-8c49-96567ff925e4" ], "format": "uuid" }, "key": { "type": "string", "examples": [ "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service" ] }, "type": { "type": "string", "examples": [ "opentofu-plan" ] }, "created": { "type": "string", "examples": [ "2024-10-17T17:45:06.544672610Z" ], "format": "date-time" }, "name": { "type": "string", "examples": [ "my-tofu-service" ] }, "description": { "type": "string" }, "decorator": { "type": "object", "properties": {} }, "repository": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "examples": [ "t-scripts" ] }, "type": { "type": "string", "examples": [ "v1.Repository" ] } } }, "tags": { "type": "array" }, "working_dir": { "type": "string", "examples": [ "plan-dir" ] }, "entity": { "type": "object", "properties": {} } } }, "last_run": { "type": "integer", "examples": [ 1729187315871 ] }, "schedule": { "type": "object" } } } } } }