Create a customized interface attribute

Method

URL

Required authentication

POST

/V1/CMDB/Interfaces/Attributes

Yes

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

Request*required
(body)

The body contains the following parameters:

▪attributeName*(string): the name of the interface attribute to be created.

▪attributeDisplayName (string): the display name of the attribute in the Device Details pane of NetBrain system.

▪deviceTypeNames*(string): specify the device types that the created attribute applies to. If set to null, it will apply to all device types. See Device Type Name and ID for the available device types.

▪interfaceType*(string): the interface type that the created attribute applies to, such as intfs (Layer 2 topology type interfaces), ipIntfs (IPv4 L3 topology type interfaces), and ip6Intfs (IPv6 L3 topology type interfaces).

▪dataType*(string): the supported data types of the attribute, such as string.

▪subDataType (string): this parameter is only available to the attribute in list or table type.

▪isFullSearch*(boolean): set whether to use the property as an index in full scope search, including extended search and default search.

Example:

{
  "InterfaceType": "ipIntfs ",
  "attributeName": "newAttribute",
  "attributeDisplayName": "New Attribute",
  "deviceTypeNames": "null",
  "dataType": "string",
  "subDataType": "null",
  "isFullSearch": true
}

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success"
}

statusDescription

string

The explanation of the status code.