PIpishock
Shockers
Shockers

Allows the operation of a PiShock Shocker from an API Key.

Changed on

The ShockerId is specified as a path parameter, whereas the rest is in the body.
The parameter "AgentName" will be removed in a future version however is still present for now -- Expect this to be replaced by the name of the actioning API Key in future.

post/Shockers/OperateById/{ShockerId}

Request

  • Base URL
    https://api.pishock.com
  • Auth
    • API key in header X-PiShock-Token
    • or API key in header X-PiShock-UserId
    • or API key in header X-PiShock-Server-Key
    • or API key in header X-PiShock-Api-Key

Path parameters

ShockerIdinteger required

Request body

AgentNamestring
Operation0 | 1 | 2
Durationinteger
Intensityinteger
MinimumDurationinteger nullable
MinimumIntensityinteger nullable
IntensityAsPercentageboolean

Response

Command has been sent to the device.

Changes