Create Device ID Element Level Config (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/deviceidconfigs

Create device id element level (source interface) config.

Request

Path Parameters

tenant_id stringrequired

The tenant ID

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

application/json

Body

Details of the Device ID element level config to be created

description

The device id element description.

id string

The device ID.

name stringrequired

Device ID element name.

snmp_discovery_source_interface_id string

The snmp discovery source interface ID.

tags string[]

A information field that can be added to device id element. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The device id element description.

id string

The device ID.

name stringrequired

Device ID element name.

snmp_discovery_source_interface_id string

The snmp discovery source interface ID.

tags string[]

A information field that can be added to device id element. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "snmp_discovery_source_interface_id": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "DEVICEID_INVALID_SOURCE_INTERFACE"
      },
      {
        "code": "DEVICEID_INVALID_INTERFACE"
      },
      {
        "code": "DEVICEID_INVALID_INTERFACE_TYPE"
      }
    ]
  }
}

Loading...