Summary
Get information about a specific service on a gateway
Description
Get a service
Route
GET /gateway_manager/v1/services/:id
Roles
service:read
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
id |
string |
yes |
The Id of the service on the gateway instance |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Information about the service |
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": "eu elit amet occaecat deserunt",
"repository": {
"id": "eiusmod cillum nisi sed ex",
"name": "t-scripts",
"type": "v1.Repository"
},
"tags": [],
"working_dir": "plan-dir"
},
"last_run": 1729187315871
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"result": {
"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"
}
}
}
}
}