REST API for Unified Assurance Core

Get Devices

get

/api/device/Devices

Gets the devices that match the specified parameters. If no parameters are specified, all devices are returned.

Request

Query Parameters

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}

If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by.
Example:
```
100
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object"
}

start: integer(int32)
The page of results to start from.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of devices that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceDevicesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The list of devices that match the specified parameters.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of devices that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceDevicesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of devices that match the specified parameters.

Show Source

Array of: object deviceDevicesRead

{
    "description":"The list of devices that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceDevicesRead"
    }
}

Nested Schema : deviceDevicesRead

Type: object

Show Source

CustomName: string

The custom name.

Example: Custom Nice Name
DeviceGroupName: string

The device group name.

Example: root
DeviceID: integer

The device ID.

Example: 1
DeviceName: string

The device name. This is created automatically in order of precedence based on CustomName, DNSName, SysName, IPv6Address, and IPAddress.

Example: router.example.com
DevicePriorityID: integer

The device priority ID.

Example: 1
DeviceSNMPAccessID: integer

SNMP Access Profile ID

Example: 1
DeviceStateID: integer
The device state ID. Valid values are:
- 0: New
- 1: Non-discoverable
- 2: Verified (Discovered)
- 3: Discovered (Fully)
- 101: Static (Disabled)
- 102: Virtual (Non-device)
Example: 1
DeviceStatus: string

The device status.

Example: new
DeviceStatusIcon: string

Colour value for DeviceStatusID. Possible values: - 0 (New) => 'red' - 1 (Non-discoverable) => 'purple' - 2 (Verified) => 'yellow' - 3 (Discovered) => 'green' - 101 (Static) => 'gray' - 102 (Virtual) => 'blue'

Example: green
DeviceTypeCategoryDiscoveredID: integer

The automatically discovered device type category ID.

Example: 1
DeviceTypeCategoryDiscoveredName: string

The automatically discovered device type category name.

Example: Router
DeviceTypeCategoryID: integer

The manually set device type category ID.

Example: 1
DeviceTypeName: string

The manually set device type category name.

Example: Router
DeviceZoneID: integer

The device zone ID.

Example: 1
DeviceZoneName: string

The device zone name.

Example: Default First Zone
DNSName: string

DNS Name

Example: router1.example.com
FirstFound: string

The timestamp when the device was first discovered, in YYYY-MM-DD HH:MM:SS format.

Example: 2006-01-02 15:04:05
GeoLocation: string

The GeoJSON point of device location (lon, lat).

Example: {"type": "Point", "coordinates": [0, 0]}
IPv4: string

The IPv4 address.

Example: 192.0.2.1
IPv6: string

The IPv6 address in hex notation.

Example: 2001:DB8::1
LastFound: string

The timestamp when the device was last discovered, in YYYY-MM-DD HH:MM:SS format.

Example: 2006-01-02 15:04:05
LastModified: string

The timestamp when the device was last modified, in YYYY-MM-DD HH:MM:SS format.

Example: 2006-01-02 15:04:05
ParentDeviceID: integer

The parent device ID for virtual devices.

Example: 0
SerialNumber: string

Serial Number

Example:
ShardID: integer

The device shard ID.

Example: 1
SysContact: string

SNMP System Contact

Example:
SysDescription: string

SNMP System Description

Example:
SysLocation: string

SNMP System Location

Example:
SysName: string

SNMP System Name

Example: EXAMPLE-ROUTER
SysOID: string

SNMP System Object ID

Example:

{
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceName":{
            "description":"The device name. This is created automatically in order of precedence based on CustomName, DNSName, SysName, IPv6Address, and IPAddress.",
            "type":"string",
            "example":"router.example.com"
        },
        "IPv4":{
            "description":"The IPv4 address.",
            "type":"string",
            "example":"192.0.2.1"
        },
        "IPv6":{
            "description":"The IPv6 address in hex notation.",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "FirstFound":{
            "description":"The timestamp when the device was first discovered, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastModified":{
            "description":"The timestamp when the device was last modified, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastFound":{
            "description":"The timestamp when the device was last discovered, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "DevicePriorityID":{
            "description":"The device priority ID.",
            "type":"integer",
            "example":"1"
        },
        "ParentDeviceID":{
            "description":"The parent device ID for virtual devices.",
            "type":"integer",
            "example":"0"
        },
        "DeviceTypeCategoryID":{
            "description":"The manually set device type category ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeName":{
            "description":"The manually set device type category name.",
            "type":"string",
            "example":"Router"
        },
        "DeviceTypeCategoryDiscoveredID":{
            "description":"The automatically discovered device type category ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeCategoryDiscoveredName":{
            "description":"The automatically discovered device type category name.",
            "type":"string",
            "example":"Router"
        },
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceStateID":{
            "description":"The device state ID. Valid values are:\n<ul>\n<li><b>0</b>: New</li>\n<li><b>1</b>: Non-discoverable</li>\n<li><b>2</b>: Verified (Discovered)</li>\n<li><b>3</b>: Discovered (Fully)</li>\n<li><b>101</b>: Static (Disabled)</li>\n<li><b>102</b>: Virtual (Non-device)</li>\n</ul>",
            "type":"integer",
            "example":"1"
        },
        "DeviceStatus":{
            "description":"The device status.",
            "type":"string",
            "example":"new"
        },
        "DeviceStatusIcon":{
            "description":"Colour value for DeviceStatusID. \nPossible values:\n- 0 (New) => 'red'\n- 1 (Non-discoverable) => 'purple' \n- 2 (Verified) => 'yellow'\n- 3 (Discovered) => 'green'\n- 101 (Static) => 'gray'\n- 102 (Virtual) => 'blue'",
            "type":"string",
            "example":"green"
        },
        "DNSName":{
            "description":"DNS Name",
            "type":"string",
            "example":"router1.example.com"
        },
        "CustomName":{
            "description":"The custom name.",
            "type":"string",
            "example":"Custom Nice Name"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "ShardID":{
            "description":"The device shard ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceGroupName":{
            "description":"The device group name.",
            "type":"string",
            "example":"root"
        },
        "GeoLocation":{
            "description":"The GeoJSON point of device location (lon, lat).",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0, 0]}"
        },
        "DeviceSNMPAccessID":{
            "description":"SNMP Access Profile ID",
            "type":"integer",
            "example":"1"
        },
        "SysOID":{
            "description":"SNMP System Object ID",
            "type":"string",
            "example":""
        },
        "SysName":{
            "description":"SNMP System Name",
            "type":"string",
            "example":"EXAMPLE-ROUTER"
        },
        "SysLocation":{
            "description":"SNMP System Location",
            "type":"string",
            "example":""
        },
        "SysContact":{
            "description":"SNMP System Contact",
            "type":"string",
            "example":""
        },
        "SysDescription":{
            "description":"SNMP System Description",
            "type":"string",
            "example":""
        },
        "SerialNumber":{
            "description":"Serial Number",
            "type":"string",
            "example":""
        }
    },
    "type":"object"
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object