Skip to main content
POST
/
entities
/
asset
/
{asset_id}
/
event
/
plug-in
Asset Plug In Event
curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/plug-in \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "intent": {
    "energy_required_kwh": 123,
    "ready_by": "2023-11-07T05:31:56Z",
    "energy_estimated": true,
    "may_charge_peak": false
  },
  "vehicle": {
    "charging_rate_kw": 123
  },
  "tariff": {
    "off_peak_times": "<string>",
    "timezone": "<string>"
  }
}'
"<any>"

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

asset_id
string<uuid>
required

Body

application/json

A minimal plug-in event requires no data. Optionally intent, tariff and vehicle information can be supplied here too.

intent
object

Intent to charge the vehicle.

vehicle
object

Vehicle information.

tariff
object

Tariff information.

Response

Plug-in event successfully processed

The response is of type any.

I