Log inTalk to us
Developer tools

Read a migration charger's OCPP message log

get/v1/migrations/{migration_id}/chargers/{station_id}/ocpp-messages
Requires an API key

The OCPP messages the charging core exchanged with one charger of this migration, newest first, redacted as on the project's own log: passwords, keys and secret configuration values read [redacted], credentials in URLs and HTTP headers are masked, ID tokens show their last 4 characters and certificates are cut. since and until are ISO 8601 (until defaults to now, since to 24 hours before it; at most 7 days); action (repeatable) keeps those OCPP actions. Needs the client, partner or support role (a key needs stations:diagnostics); a narrowed team reads the chargers at its sites only. Errors: 404 migration_charger_not_in_migration, 404 migration_not_found, 422 time_range_invalid. See Errors and statuses.

Path parameters

  • station_idintegerRequired
    Greater than 0
  • migration_idstringRequired
    Pattern ^mig_[0-9a-f]{32}$

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/migrations/{migration_id}/chargers/{station_id}/ocpp-messages
curl --fail-with-body "https://api.ivoracharge.com/v1/migrations/mig_0123456789abcdef0123456789abcdef/chargers/1/ocpp-messages" \
  -H "Authorization: Bearer $IVORA_API_KEY"
Response · 200JSON
{
  "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"
}
Requires an approved production API keyProduction access starts with a request, a short meeting with Ivora and a card on file, after which Ivora staff grant your account access. How to request access
Try itproduction · api.ivoracharge.com

Paste a production api key (iv_live_…). Create keys in Developer tools. The key stays in this page's memory, is sent only to https://api.ivoracharge.com and clears when you reload. Test keys are refused.