Delete Sensor

Deregister the sensor from SSP

Allows de-registration of a sensor. The appliance must be manually deleted from the infrastructure. This operation is idempotent.

Request

URI

DELETE

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

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

Deletion successful

Operation doesn't return any data structure

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 -X DELETE -H 'Authorization: <value>' https://{api_host}/sensors/appliances/{appliance-id}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Vendor Extension

Sensor Operations

POST

Create Sensor Registration Token

GET

Get All Registration Tokens

GET

Get Registration Token By Id

DELETE

Delete Sensor Registration Token

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