Summary
Update Gateway
Description
Update information about a particular gateway
Route
PUT /gateway_manager/v1/gateways/:id
Roles
gateway:update
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
the Id for the gateway to update |
| payload |
object |
yes |
payload with the updated values for the gateway |
Copied to Clipboard
{
"payload": {
"gateway_name": "my-gateway",
"cluster_id": "cluster_1",
"readonly": false,
"description": "et amet elit",
"groups": [
"admins",
"admins"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"payload": {
"title": "payload",
"type": "object",
"properties": {
"gateway_name": {
"type": "string",
"examples": [
"my-gateway"
]
},
"cluster_id": {
"type": "string",
"examples": [
"cluster_1"
]
},
"readonly": {
"type": "boolean"
},
"description": {
"type": "string",
"example": "A basic description for the gateway"
},
"groups": {
"type": "array",
"items": {
"type": "string",
"examples": [
"admins"
]
}
}
}
}
},
"required": [
"payload"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
string |
Result of updating the gateway |
Copied to Clipboard
{
"state": "Success",
"result": {
"value": {
"_id": "670ff8b58f5f0fc89bb2d29c",
"gateway_name": "my-gateway",
"cluster_id": "cluster_1",
"description": "updated description",
"enabled": false,
"readonly": true,
"groups": [
"admins"
],
"certificates": [
"66ff56c9fcbec46997145abd",
"66ff56c9fcbec46997145abd",
"66ff56c9fcbec46997145abd",
"66ff56c9fcbec46997145abd"
]
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"default": "Success",
"examples": [
"Success"
]
},
"result": {
"type": "object",
"description": "The values for the gateway that was just updated as it exists within the database",
"properties": {
"value": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"examples": [
"670ff8b58f5f0fc89bb2d29c"
]
},
"gateway_name": {
"type": "string",
"examples": [
"my-gateway"
]
},
"cluster_id": {
"type": "string",
"examples": [
"cluster_1"
]
},
"description": {
"type": "string",
"examples": [
"updated description"
]
},
"enabled": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"type": "string",
"examples": [
"admins"
]
}
},
"certificates": {
"type": "array",
"items": {
"type": "string",
"examples": [
"66ff56c9fcbec46997145abd"
]
}
}
}
}
}
}
}
}
