List all services

GET

http://localhost:3000/gateway_manager/v1/services

GET

/gateway_manager/v1/services

1 curl http://localhost:3000/gateway_manager/v1/services \
2      -u "<username>:<password>"

1 {
2   "state": "Success",
3   "result": [
4     {
5       "_id": "67114d64d97db4ea87998b79",
6       "active": true,
7       "service_metadata": {
8         "location": "cluster_1",
9         "id": "debe9024-52ee-4b39-8c49-96567ff925e4",
10         "key": "gateway/cluster_1/services/v1/opentofu-plan/my-tofu-service",
11         "type": "opentofu-plan",
12         "created": "2024-10-17T17:45:06.544672610Z",
13         "name": "my-tofu-service",
14         "description": "string",
15         "decorator": {},
16         "repository": {
17           "id": "string",
18           "name": "t-scripts",
19           "type": "v1.Repository"
20         },
21         "tags": [
22           "string"
23         ],
24         "working_dir": "plan-dir",
25         "entity": {}
26       },
27       "last_run": 1729187315871,
28       "schedule": {}
29     }
30   ]
31 }

Returns all services across all gateways, optionally filtered by cluster_id.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

cluster_idstringOptional

The cluster Id for the gateway to pull services for (optional)

Response

All of the services that exist across all gateways

statestring

resultlist of objects

Errors

500

Internal Server Error