Update Sensor

Update the information of a sensor

Update the information of a sensor. Currently only 'display_name' and 'description' can be updated.

Request

URI

PUT

https://{api_host}/sensors/appliances/{appliance-id}

COPY

Path Parameters

string

appliance-id

Required

Used to identify a sensor appliance.

Request Body

Information of the sensor.

Sensor of type(s) application/json

Required

This request body class requires all of the following: InlineSensor1

{
    "_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
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

Responses

200

Returns Sensor of type(s) application/json

This response body class contains all of the following: InlineSensor1

"Sensor Object"

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.

Vendor Extension

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

                    platform-sensor-lic

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sensors/appliances/{appliance-id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Vendor Extension

Sensor Operations

POST