Skip to main content
GET
/
v3
/
chargers
/
{charger}
/
settings
/
socket-lock
Get Socket Lock Status
curl --request GET \
  --url https://app.plugchoice.com/api/v3/chargers/{charger}/settings/socket-lock \
  --header 'Authorization: Bearer <token>'
{
  "enabled": true,
  "interactable": true,
  "error": "<string>"
}
Returns the current socket lock status for the specified charger. When the socket is locked, the charging cable is held in place and cannot be removed.
​
charger
string
required
The UUID of the charger.

​
Response

​
enabled
boolean
Whether the socket is currently locked.
​
interactable
boolean
Whether the socket lock can be toggled right now. This is true when the socket is already locked or when a cable is physically inserted (the connector is in a Preparing, Charging, SuspendedEV, SuspendedEVSE, or Finishing state).
​
error
string
A human-readable error message. Only present when the setting could not be read, for example when the charger is offline. When present, enabled and interactable are returned as false.