Update Proxy Servers

PUT /v3/chargers/{charger}/proxy

Update Proxy Servers

cURL

curl --request PUT \
  --url https://app.plugchoice.com/api/v3/chargers/{charger}/proxy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_role": "<string>",
  "servers": [
    {
      "servers[].websocket": "<string>",
      "servers[].role": "<string>",
      "servers[].password": {}
    }
  ]
}
'

200

{
  "data": [
    {
      "websocket_url": "<string>",
      "role": "<string>",
      "has_password": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Updates the proxy server configuration for the specified charger. There must be exactly one leader across the vendor role and all server entries.

charger · string · required

The UUID of the charger.

vendor_role · string · required

The role of the vendor (Plugchoice) connection. Either ROLE_LEADER or ROLE_FOLLOWER.

servers · object[]

An array of proxy server configurations.

Show server

servers[].websocket · string · required

The WebSocket URL of the proxy server. Must use ws:// or wss:// protocol.

servers[].role · string · required

The role of this server. Either ROLE_LEADER or ROLE_FOLLOWER.

servers[].password · string | null

Optional credential the charger uses to authenticate to this server. Stored encrypted at rest and never returned by the API.

Three-state semantics:

• Omit the field to preserve the password currently stored for this server (matched by websocket).
• Pass a non-empty string to set or replace the password.
• Pass null (or an empty string) to clear the stored password.

This means partial updates from a UI that does not know existing passwords (e.g. only changing a role) will not wipe credentials.

Response

data · object[]

The updated list of proxy server entries.

Show proxy server

websocket_url · string

The WebSocket URL of the proxy server.

role · string

The role of this server.

has_password · boolean

Whether a password is currently stored for this server. The password value itself is never returned.

created_at · string

ISO 8601 timestamp of when the proxy entry was created.

updated_at · string

ISO 8601 timestamp of when the proxy entry was last updated.