Plan a batch of chargers to move

Path parameters

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

Headers

• idempotency-keystringRequired

Request body

• namestringRequired
  A label, such as "Depot, night 1".
  1–120 characters
• station_idsarray of integer | null
  The chargers to move.
• location_idsarray of integer | null
  Or every migration charger at these sites (500 at most).
• pacingPacingInput
  Child attributes

  • wave_sizeinteger
    Chargers moved at a time: one wave's move requests go out together.
    Default 5 · Minimum 1 · Maximum 50
  • interval_secondsinteger
    Seconds after a wave settled (every charger moved, refused or failed) before the next one starts.
    Default 60 · Minimum 0 · Maximum 86400
  • canaryinteger
    The first wave's size; the batch then pauses itself until someone resumes it. 0: no canary wave.
    Default 2 · Minimum 0 · Maximum 50
  • max_failure_rationumber
    After a wave, the batch pauses itself when more than this share of the chargers it tried failed.
    Default 0.2 · Minimum 0 · Maximum 1
  • idle_timeout_minutesinteger
    A charger the proxy refused because it is charging is retried in a later wave (5 minutes later at the earliest), until this long after its first attempt; then it is blocked (not_idle), never forced.
    Default 60 · Minimum 1 · Maximum 1440
  • move_timeout_minutesinteger
    A move request the proxy has not answered this long after it was sent expires and counts as a failed charger of its wave.
    Default 30 · Minimum 1 · Maximum 1440

Returns · 201

• idstringRequired
  bat_...
• migration_idstringRequired
• namestringRequired
• statusenumRequired
  draft, submitted (waiting for the client's approval), approved, running, paused, completed, cancelled (moved chargers stay on Ivora) or rolled_back (a rollback of the batch was asked).
  One of draft, submitted, approved, running, paused, completed, cancelled, rolled_back
• pacingPacingRequired
  Child attributes

  • wave_sizeintegerRequired
  • interval_secondsintegerRequired
  • canaryintegerRequired
  • max_failure_rationumberRequired
  • idle_timeout_minutesintegerRequired
  • move_timeout_minutesintegerRequired
• countsobjectRequired
  Chargers per step, and total (of the caller's sites when narrowed).
• waveintegerRequired
  Waves started.
• wave_openbooleanRequired
  A wave's moves are out and not all answered.
• next_wave_atstring | nullRequired
  When the next wave may start (running, between waves).
• paused_reasonenum | nullRequired
  Why a paused batch paused: manual, canary (after its first wave), failure_ratio, rollback_requested (a rollback anywhere in the migration), runner_unhealthy or migration_paused (the migration was paused).
  One of manual, canary, failure_ratio, rollback_requested, runner_unhealthy, migration_paused
• paused_atstring | nullRequired
• job_idstringRequired
  The job of its moves (GET .../jobs/{job_id}).
• created_bystringRequired
• created_atstringRequired
• updated_atstringRequired
• submitted_bystring | nullRequired
• submitted_atstring | nullRequired
• approvalobject | nullRequired
  The client's approval; null until approved, and again after an edit.
  Child attributes

  • bystringRequired
  • roleenumRequired
    One of client, support, partner, observer
  • team_idstring | nullRequired
  • atstringRequired
  • chargersintegerRequired
    Chargers in the batch when it was approved.
  • digeststringRequired
    SHA-256 of the approved charger set and pacing; any edit revokes the approval.
• started_bystring | nullRequired
  Who started it, or resumed it last: its moves are asked in their name.
• started_atstring | nullRequired
• finished_atstring | nullRequired
• duration_snumber | nullRequired
  Seconds from its start to its end (or now while it runs).
• rollbacksarray of BatchRollbackRequired
  Rollback jobs of its chargers, with their timings.
  Child attributes

  • job_idstringRequired
    The rollback job (GET .../jobs/{job_id}).
  • requested_atstringRequired
  • requested_bystringRequired
  • reasonstringRequired
  • chargersintegerRequired
    Chargers it rolls back (skipped ones left out).
  • appliedintegerRequired
    Chargers switched back by the proxy.
  • statusenumRequired
    One of running, succeeded, failed
  • last_applied_atstring | nullRequired
    When the proxy switched the last of them back.
  • switch_snumber | nullRequired
    Seconds from the request to the last switch back.
• chargersarray of BatchCharger | nullRequired
  Each charger's step; null in a list.
  Child attributes

  • station_idintegerRequired
  • charger_keystringRequired
  • location_idinteger | nullRequired
  • stepenumRequired
    pending: waiting for its wave (detail busy: refused while charging, retried at retry_at). moving: its move request is out. moved: on Ivora. blocked: not moved (detail not_idle, not_proxied, shadow, rollback_pending). failed: the proxy failed or refused it, or did not answer in time (detail refused_parity, failed, expired). superseded: a rollback took over. skipped: the batch was cancelled or rolled back first, or the charger left the migration (detail).
    One of pending, moving, moved, blocked, failed, superseded, skipped
  • detailstring | nullRequired
  • waveinteger | nullRequired
    The wave of its latest move request.
  • attemptsintegerRequired
    Move requests sent for it (a busy charger is retried).
  • request_idstring | nullRequired
    Its latest move request (rr_...).
  • requested_atstring | nullRequired
  • retry_atstring | nullRequired
    A busy charger's next attempt at the earliest.
  • settled_atstring | nullRequired
  • move_snumber | nullRequired
    Seconds from its move request to the proxy's report that it moved.

Errors