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: minimum: 0 default: 0

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

integer
page_size
Optional
Constraints: minimum: 0 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 parameter to filter by display name.

display_name example
sensor
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: ListResult , InlineSensorList1 
{
    "number_of_results": 1,
    "offset": -1,
    "results": [
        {
            "_create_time": 1777886290727,
            "_create_user": "ndr-sensor",
            "_last_modified_time": 1777886291403,
            "_revision": 1,
            "algorithm": "RSA",
            "certificate": "-----BEGIN CERTIFICATE----- xxxxx -----END CERTIFICATE-----",
            "description": "Token for ndr sensor",
            "display_name": "sensor",
            "id": "8c147e21-7410-4f77-a3a6-e7aa6034992f",
            "key_size": 3072,
            "pem_encoded": "xxxxx",
            "token_id": "793a8565-0ff9-4340-a154-a9eecddbdd2e"
        }
    ],
    "total_pages": 1,
    "total_result_count": 1
}

400

Bad Request

Returns BadRequest 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.


401

Unauthorized

Returns Unauthorized 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.


403

Forbidden

Returns Forbidden 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.


412

Precondition Failed

Returns PreconditionFailed 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.


428

Precondition Required

Returns PreconditionRequired 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.


429

Too Many Requests

Returns TooManyRequests 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.


default

Error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "sensor",
    "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.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    ["platform-sensor-all"]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sensors/appliances
On This Page
Sensor Operations
POST
Create Sensor Registration Token
GET
Get All Registration Tokens
GET
Get Registration Token By Id
DELETE
Delete Sensor Registration Token
GET
List Sensors
GET
Get Sensor By Id
PUT
Update Sensor
DELETE
Delete Sensor
GET
Get Sensor Status
GET
Get Sensor Appliance Ids Signature Bundle
GET
Get Sensor Feature Config
POST
Update Sensor Ids Feature Config
POST
Update Sensor Flow Feature Config
POST
Update Sensor Mps Feature Config
GET
List Sensor Details
GET
Get Sensor Global Config Mps
PUT
Update Sensor Global Config Mps
GET
Get Sensor Version Summary