Developer resources
Developer tools

Read a station's OCPP message log

get/v1/tenants/{tenant_id}/stations/{station_id}/ocpp-messages
Requires an API key

The OCPP messages the charging core exchanged with the charger, newest first, for troubleshooting: direction, message type, action, message ID, timestamp and the redacted payload. since and until are ISO 8601; until defaults to now and since to 24 hours before until, and one request covers at most 7 days (422 time_range_invalid). action (repeatable, up to 20) keeps only those OCPP actions; a reply carries its request's action. Page with cursor=next_cursor and the same filters. Payloads are redacted before they leave the API: passwords, keys and secret configuration values read [redacted], HTTP Basic and URL credentials and query strings are masked, ID tokens show their last 4 characters, and certificates are cut to 32 characters. Requires stations:diagnostics, which team owners, admins and developers and Ivora support hold, and operators, viewers and billing members never do.

Path parameters

  • tenant_idintegerRequired
  • station_idintegerRequired

Query parameters

  • sincestring | null
    Up to 40 characters
  • untilstring | null
    Up to 40 characters
  • actionarray of string | null
    OCPP action, for example StatusNotification; repeat for more
  • cursorstring | null
    next_cursor of the previous page
    Up to 20 characters
  • limitinteger
    Default 100 · Minimum 1 · Maximum 500

Returns · 200

  • station_idintegerRequired
  • sincestringRequired
    The start of the requested period (inclusive).
  • untilstringRequired
    The end of the requested period (exclusive).
  • dataarray of OcppMessageRecordRequired
    Newest first.
    Child attributes
    • idintegerRequired
      The message's journal ID in the charging core; newer messages have higher IDs.
    • station_idintegerRequired
    • directionenum | nullRequired
      from_charger: the charger sent it. to_charger: the charging core sent it to the charger.
      One of from_charger, to_charger
    • message_typeenum | nullRequired
      OCPP-J frame: call (a request), call_result (its reply) or call_error (a refusal).
      One of call, call_result, call_error
    • actionstring | nullRequired
      The OCPP action, for example BootNotification. A reply carries its request's action when the core recorded it.
    • message_idstring | nullRequired
      The OCPP-J message ID that pairs a call with its call_result or call_error.
    • timestampstring | nullRequired
      When the charging core recorded the message.
    • protocolstring | nullRequired
      ocpp1.6, ocpp2.0.1 or ocpp2.1.
    • payloadobject | array of any | string | integer | number | boolean | nullRequired
      The OCPP payload with secrets redacted: passwords, keys and secret configuration values read [redacted], HTTP Basic credentials and URL credentials and query strings are masked, ID tokens show their last 4 characters behind ****, and certificates, CSRs and signatures keep their first 32 characters and their length. null when truncated. Energy values are the charger's own: OCPP 1.6 meter registers are Wh.
    • redactedbooleanRequired
      True when redaction changed the payload.
    • truncatedbooleanRequired
      The redacted payload exceeded 32,768 characters, or could not be read, and is omitted (payload null).
    • payload_sizeintegerRequired
      Characters of the redacted payload as JSON.
    • errorobject | nullRequired
      call_error only.
      Child attributes
      • codestring | nullRequired
        The CALLERROR errorCode, for example NotImplemented or InternalError.
      • descriptionstring | nullRequired
        The CALLERROR errorDescription, with credentials masked.
  • next_cursorstring | nullRequired
    Pass as cursor with the same since, until and action to read older messages; null on the last page.
GET /v1/tenants/{tenant_id}/stations/{station_id}/ocpp-messages
curl --fail-with-body "https://api.ivoracharge.com/v1/tenants/1042/stations/1/ocpp-messages" \
  -H "Authorization: Bearer $IVORA_API_KEY"
Response · 200
{
  "station_id": 1,
  "since": "string",
  "until": "string",
  "data": [
    {
      "id": 1,
      "station_id": 1,
      "direction": "from_charger",
      "message_type": "call",
      "action": "string",
      "message_id": "message_0123456789abcdef",
      "timestamp": "string",
      "protocol": "string",
      "payload": {},
      "redacted": false,
      "truncated": false,
      "payload_size": 1,
      "error": {
        "code": "string",
        "description": "string"
      }
    }
  ],
  "next_cursor": "string"
}
Try it is not available here yetRequests from this page are off until the production API at https://api.ivoracharge.com is public. Use the code samples from your application server; Ivora grants production access. Keys are created in Developer tools.