Overview
Force Termination API#
The Force Termination API allows you to terminate the charger connection and make it offline.
API Usage#
See Token Management API for more information on how to create and use the access token.
Force Terminate Connection#
Prepare Request Body#
To prepare a request body, perform the following steps.
- Set charger ID to the request path parameter
chargerId
. - Set
Content-Type
header asapplication/json
as described in Force Termination API Reference.
Example Request#
Note
Use the server URL applicable to your region. See [API Reference](./force_terminate_connection_api_reference.md) for available server URLs applicable to your region.
export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>
export CHARGER_ID = <YOUR_CHARGER_ID>
curl --location --request PUT 'https://api.eu.depot.emobility.io/v1/chargerControl/$CHARGER_ID/forceTerminateConnection' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
Response Body#
Successful response returns 200 HTTP status code with response body as Success
schema. For more information, see Force Termination API Reference.
Example Response#
{
"code": 200,
"message": "Charger Accepted."
}