Summary
Create a new gateway
Description
Create a new gateway within the database
Route
POST /gateway_manager/v1/gateways
Roles
gateway:create
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
gateway |
object |
yes |
The parameters for the gateway that should be added |
Copied to Clipboard
{
"gateway": {
"gateway_name": "my-gateway",
"cluster_id": "cluster_1",
"description": "basic description",
"enabled": true,
"readonly": true,
"certificates": [
"66ff56c9fcbec46997145abd"
],
"groups": [
"group_1",
"group_1"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"gateway": {
"title": "gateway",
"type": "object",
"properties": {
"gateway_name": {
"type": "string",
"examples": [
"my-gateway"
]
},
"cluster_id": {
"type": "string",
"examples": [
"cluster_1"
]
},
"description": {
"type": "string",
"examples": [
"basic description"
]
},
"enabled": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
},
"certificates": {
"type": "array",
"items": {
"type": "string",
"examples": [
"66ff56c9fcbec46997145abd"
]
}
},
"groups": {
"type": "array",
"description": "An array of the names of the groups that will be associated with this gateway. Any group that is associated with this gateway will be able to actions on this gateway per the roles associated with that particular group",
"items": {
"type": "string",
"default": "group_1",
"examples": [
"group_1"
]
}
}
},
"required": [
"gateway_name",
"cluster_id",
"description",
"enabled",
"readonly"
],
"additionalProperties": false
}
},
"required": [
"gateway"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
string |
result of adding gateway |
Copied to Clipboard
{
"state": "Success",
"message": "Gateway added: 6710049eda530d444d141565",
"id": "6710049eda530d444d141565"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"message": {
"type": "string",
"examples": [
"Gateway added: 6710049eda530d444d141565"
]
},
"id": {
"type": "string",
"examples": [
"6710049eda530d444d141565"
]
}
}
}