Change Connector Availability​

PUT
/chargers/{chargerId}/connectors/{connectorId}/availability

Requests that a connector become operative or inoperative. If an active transaction delays the change, the response indicates that it was scheduled.

Use cases

  • Make a connector unavailable during maintenance.
  • Restore a connector after maintenance is complete.

Related endpoints

  • GET /chargers/{chargerId} — find connector IDs and review their status.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

chargerId*

UUID returned by POST /chargers or GET /chargers. Use it to target that charger for configuration, connector, or status operations.

Type
string
Required
Example"550e8400-e29b-41d4-a716-446655440000"
Min Length
1
Max Length
40
connectorId*

Connector number from chargers[].connectors[].id. OCPP connector numbers range from 1 to 255.

Type
string
Required
Example"1"
Max Length
3
Pattern
^(?:[1-9]|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])$

Request Body​

application/json

Requested availability change for a charger connector.

Set true to make the connector operative or false to make it inoperative.

Responses​

success.charger.connector.changeavailability

application/json

If true, the requested availabilty change will be executed when in-progress transactions are finished.

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​