Summary
Run a Gateway service
Description
Run an IAG5 service given its name and any parameters passed to the service itself.
Route
POST /gateway_manager/v1/services/run
Roles
service:run
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| serviceName |
string |
yes |
The name for the service to run |
| clusterId |
string |
yes |
The Id of the cluster that the service exists on |
| params |
object |
yes |
Object with key/value entries for params. Should be output from json form table |
Copied to Clipboard
{
"serviceName": "Example-Service-Name",
"clusterId": "cluster_1",
"params": {
"someKey": "someValue"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"serviceName": {
"title": "serviceName",
"type": "string",
"examples": [
"Example-Service-Name"
]
},
"clusterId": {
"title": "clusterId",
"type": "string",
"examples": [
"cluster_1"
]
},
"params": {
"type": "object",
"properties": {},
"examples": [
{
"someKey": "someValue"
}
]
}
},
"required": [
"serviceName",
"clusterId",
"params"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
An object with an Id to the job running the service |
Copied to Clipboard
{
"state": "Success",
"message": "Running my-tofu-service on cluster_1",
"result": {
"_id": "671289cc62db5c56f3f799b8",
"job_id": "20ae2dd7cf1c43aab817556a",
"data": "debe9024-52ee-4b39-8c49-96567ff925e4"
}
}
Copied to Clipboard
{
"type": "object",
"title": "result",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"message": {
"type": "string",
"examples": [
"Running my-tofu-service on cluster_1"
]
},
"result": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"examples": [
"671289cc62db5c56f3f799b8"
]
},
"job_id": {
"type": "string",
"examples": [
"20ae2dd7cf1c43aab817556a"
]
},
"data": {
"type": "string",
"examples": [
"debe9024-52ee-4b39-8c49-96567ff925e4"
],
"format": "uuid"
}
}
}
}
}
