HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Delete a device

delete
https://clearpass-hostname/api/onboard/device/

Delete a device.

Details about this operation
Certificates issued to the device by Onboard will be revoked.
The device will be disconnected from the network, if disconnect_active_sessions is true.
If this device has been provisioned with certificates signed by an external source, you must revoke these certificates manually. Otherwise the device will still be able to access the network until these certificates expire.
If this device has not been provisioned with certificates signed by an external source, the device will be blocked from accessing the network.
The device will be allowed to enroll with Onboard again.
Path Params
string
required

Numeric ID of the device

Query Params
string

true: Disconnects the device from the network (default)
false: No action is taken

string

true: Optional Disconnect — failure to disconnect will be ignored and the device will be forcibly deleted

false: Require Disconnect (Recommended) — failure to disconnect will stop the device from being deleted (default)

When false (‘Require Disconnect’), the device will only be deleted if all other sessions can be disconnected,
which ensures that the device does not retain access to the network through a currently active session.
You should only select true (‘Optional Disconnect’) if necessary.

This parameter is ignored if disconnect_active_sessions is false.

Responses

Updated over 4 years ago

Language
Updated over 4 years ago