Send Charger Action

PATCH

/tenant/{tenantId}/charger/{chargerId}

curl --request PATCH \
  --url https://api.exolink.cloud/tenant/example/charger/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "GetConfiguration", "protocol": "ocpp1.6", "data": { "key": [ "example" ] } }'

• Exolink Production

Send an OCPP command to the charger, or disconnect it from the platform.

Reset is refused while a connector is charging. Blocked chargers accept no action.

GetDiagnostics (OCPP 1.6) has the tenant’s broker send a one-time FTP location, valid for an hour; a new request revokes the previous one. The file then shows up under /diagnostics. Without startTime and stopTime it asks for the last 24 hours. The FTP server starts on demand: while it starts the response says preparing, and the request reaches the charger about a minute later.

Authorizations

• bearerToken

Parameters

Path Parameters

tenantId

required

string

Tenant domain prefix

chargerId

required

integer

Request Body^required

Media typeapplication/json

object

action

required

OCPP command, or Disconnect to close the charger’s sessions

string

Allowed values: GetConfiguration ChangeConfiguration GetDiagnostics Reset ChangeAvailability Disconnect

protocol

OCPP version of the command

string

default: ocpp1.6

Allowed values: ocpp1.6 ocpp2.0.1

data

Any of:

GetConfiguration (ocpp1.6)

GetConfiguration (ocpp1.6)

object

key

One of:

Array<string>

Array<string>

<= 100 items

string

string

<= 50 characters

ChangeConfiguration (ocpp1.6)

ChangeConfiguration (ocpp1.6)

Keys that hold credentials, such as AuthorizationKey, are rejected.

object

key

required

string

>= 1 characters <= 50 characters

value

required

Empty clears the key. The charger’s answer arrives on the live OCPP stream; GET the configuration again to see the stored value.

string

<= 500 characters

GetDiagnostics (ocpp1.6)

GetDiagnostics (ocpp1.6)

object

startTime

Start of the requested period, 24 hours before stopTime when left out

string format: date-time

stopTime

End of the requested period, now when left out

string format: date-time

Reset (ocpp1.6)

Reset (ocpp1.6)

object

type

string

default: Soft

Allowed values: Hard Soft

Reset (ocpp2.0.1)

Reset (ocpp2.0.1)

object

type

string

default: OnIdle

Allowed values: Immediate OnIdle

ChangeAvailability (ocpp1.6)

ChangeAvailability (ocpp1.6)

object

connectorId

required

Connector, or 0 for the whole charger

integer

type

required

string

Allowed values: Inoperative Operative

ChangeAvailability (ocpp2.0.1)

ChangeAvailability (ocpp2.0.1)

object

operationalStatus

required

string

Allowed values: Inoperative Operative

evse

Omit to change the whole charging station

object

id

required

integer

>= 1

connectorId

integer

>= 1

Responses

200

Action sent successfully. Disconnect returns an empty object.

Media typeapplication/json

One of:

object

The OCPP message sent to the charger

object

sessionId

string

tenantId

Tenant domain prefix

string

chargerId

Charger identity

string

profileId

integer

timestamp

Milliseconds since the epoch

integer

message

The serialized OCPP CALL

string

meta

object

timestamp

string format: date-time

ip

string

msgFrom

string

object

The answer to a GetDiagnostics action

object

state

Preparing while the FTP server starts; the request is sent once it runs

string

Allowed values: requested preparing

object

Empty object

object

Example

{
  "message": "[2,\"0b7b3d36-...\",\"Reset\",{\"type\":\"Soft\"}]",
  "msgFrom": "exolink"
}

400

Malformed request

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Bad Request",
  "errorCode": "ERR_API_BAD_REQUEST"
}

401

Missing, invalid or expired credentials

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}

404

Resource not found

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Charger '7' not found",
  "errorCode": "ERR_API_RESOURCE_NOT_FOUND"
}

406

Resource is in use

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "CPMS is in use",
  "errorCode": "ERR_API_RESOURCE_IN_USE"
}

417

Validation or verification failed

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Missing parameter: displayName",
  "errorCode": "ERR_API_VALIDATION_FAILED"
}