UtilitiesWAN
clearSiteDeviceSession
Clear session
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
site_id*string
Format
uuiddevice_id*string
Format
uuidRequest Body
application/json
To use five tuples to lookup the session to be cleared, all must be provided
node?ha_cluster_node_enum
HA cluster node on which to clear sessions. enum: node0, node1.
Value in
- "node0"
- "node1"
service_name?string
Service name, only supported in SSR
session_ids?array<>
Session identifiers to clear
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/clear_session" \ -H "Content-Type: application/json" \ -d '{ "port_id": "ge-0/0/1.10" }'Empty