Summary
Create an Inventory device
Description
Create an Inventory device
Route
POST /automationgateway/createInventoryDevice
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
integrationType |
enum |
yes |
Allowed values are: [ netmiko, netconf, http_requests, grpc ] - Integration type of the device |
name |
string |
yes |
name for the device to be created |
variables |
object |
yes |
device variables |
Copied to Clipboard
{
"integrationType": "adipisicing sint nostrud ea dolor",
"name": "IOS",
"variables": {
"base_url": "jsonplaceholder.typicode.com",
"port": 443,
"protocol": "https"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"integrationType": {
"title": "integrationType",
"type": "string"
},
"name": {
"title": "name",
"type": "string",
"$ref": "deviceData#/definitions/inventoryName"
},
"variables": {
"title": "variables",
"type": "object",
"properties": {},
"examples": [
{
"base_url": "jsonplaceholder.typicode.com",
"port": 443,
"protocol": "https",
"additionalProp1": {}
}
]
}
},
"required": [
"integrationType",
"name",
"variables"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
A JSON Object containing status, code and the result |
Copied to Clipboard
{
"response": false
}
Copied to Clipboard
{
"type": "object",
"properties": {
"response": {
"type": "boolean"
}
}
}