Summary
Get all services
Description
Get all services across all gateways, optionally filtered by cluster_id
Route
GET /gateway_manager/v1/services
Roles
gateway:read
service:run
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
queryParameters |
object |
yes |
The query parameters available for this method. |
Copied to Clipboard
{
"queryParameters": null
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryParameters": {
"description": "The query parameters available for this method.",
"type": "object",
"properties": {},
"required": [
"queryParameters"
],
"additionalProperties": false
}
},
"required": [
"queryParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
All of the services that exist across all gateways |
Copied to Clipboard
{
"state": "Success",
"result": [
{
"_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": "incididunt",
"repository": {
"id": "et",
"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": "sit et veniam quis",
"repository": {
"id": "Ut",
"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": "aute et ullamco ut",
"repository": {
"id": "aliquip fugiat non dolore",
"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": "occaecat commodo dolor",
"repository": {
"id": "exercitation irure Duis incididunt laboris",
"name": "t-scripts",
"type": "v1.Repository"
},
"tags": [],
"working_dir": "plan-dir"
},
"last_run": 1729187315871
}
]
}
Copied to Clipboard
{
"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"
}
}
}
}
}
}