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.

appliance-id example

8c147e21-7410-4f77-a3a6-e7aa6034992f

Request Body

Information of the sensor.

Sensor of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineSensor1

{
    "description": "Token for ndr sensor",
    "display_name": "sensor",
    "id": "8c147e21-7410-4f77-a3a6-e7aa6034992f"
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

Returns Sensor of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineSensor1

{
    "_create_time": 1777886290727,
    "_create_user": "ndr-sensor",
    "_last_modified_time": 1778669344807,
    "_last_modified_user": "admin",
    "_revision": 2,
    "algorithm": "RSA",
    "certificate": "xxxxxx",
    "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"
}

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-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