List Sensors

List Sensors
List all the sensors in the system

Get a list of all the registered sensors.

Request
URI
GET
https://{api_host}/sensors/appliances
COPY
Query Parameters
integer
offset
Optional
Constraints: default: 0

Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the limit and the page_size options to request a particular set or page of items.

integer
page_size
Optional
Constraints: default: 1000

Number of records to be returned in the API request from the provided offset

boolean,null
sort_ascending
Optional
Constraints: default: false

True, if the list of records returned need to be sorted in ascending order, false otherwise.

string
sort_by
Optional

The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.

string
display_name
Optional

Use this request param to filter by display name.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SensorList of type(s) application/json
This response body class contains all of the following: InlineSensorList0 , InlineSensorList1
{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_create_user": "string",
            "_create_time": 0,
            "_last_modified_user": "string",
            "_last_modified_time": 0,
            "_revision": 0,
            "_resource_type": "string",
            "_system_owned": false,
            "id": "string",
            "display_name": "string",
            "description": "string",
            "site_ids": [
                "string"
            ],
            "token_id": "string",
            "certificate": "string",
            "pem_encoded": "string",
            "algorithm": "string",
            "key_size": 0
        }
    ]
}

default

Error

Returns Error of type(s) application/json
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sensors/appliances