Skip to main content

Request diagnostics information from a charger

POST 

/chargers/:id/actions/get-diagnostics

Sends an OCPP GetDiagnostics command requesting the charger to collect and upload diagnostic logs to a specified location.

Use Cases:

  • Troubleshoot charger errors or unexpected behavior
  • Collect logs for vendor support cases
  • Investigate connectivity or protocol issues
  • Perform root cause analysis for failures
  • Compliance and audit logging

What Gets Uploaded:

  • System logs and error messages
  • OCPP communication logs
  • Hardware diagnostics and status
  • Configuration snapshots
  • Event history and timestamps

Upload Process:

  1. Charger receives GetDiagnostics command
  2. Charger collects diagnostic data (may take several minutes)
  3. Charger uploads diagnostics file to specified FTP/HTTP(S) location
  4. Charger sends DiagnosticsStatusNotification with progress updates
  5. File available for download once upload completes

Parameters:

  • Location: FTP/HTTP(S) URL where charger uploads diagnostics file
  • Start Time (optional): Collect logs from this timestamp onwards
  • Stop Time (optional): Collect logs up to this timestamp
  • Retries (optional): Number of upload retry attempts
  • Retry Interval (optional): Seconds between retry attempts

Important Notes:

  • Diagnostics collection can take 2-10 minutes depending on log size
  • Charger must have network access to upload location
  • Upload location must accept charger's authentication method
  • Large log files may take significant time to upload
  • Monitor DiagnosticsStatusNotification for upload progress

Request

Responses

Standard success response for actions