Developer resources
Developer tools

List where a test session's charger may connect

get/v1/sessions/targets
Requires an API key

409 bench_unavailable where this environment has no bench. The global endpoint, and with tenant_id that project's own options: its per-project charger URL, each of its custom OCPP domains (available once ready) and custom_url (signed-in members with stations:write; a third-party system). Pass one id as target.id when starting a session. Requires stations:read on the project.

Query parameters

  • tenant_idinteger | null
    Greater than 0

Returns · 200

  • dataarray of TargetOptionRequired
    Child attributes
    • idstringRequired
    • kindenumRequired
      One of global, project_url, domain, custom_url
    • labelstringRequired
    • tenant_idinteger | nullRequired
    • domain_idstring | nullRequired
    • hostnamestring | nullRequired
    • urlstring | nullRequired
      The address the charger connects at; null for custom_url (typed by the caller).
    • availablebooleanRequired
    • reasonstring | nullRequired
      Why the target is not available to you now.
  • custom_url_noticestringRequired
    Shown before a custom URL is used.
  • custom_url_ws_warningstringRequired
    Shown when a typed custom URL starts with ws://.
GET /v1/sessions/targets
curl --fail-with-body "https://api.ivoracharge.com/v1/sessions/targets" \
  -H "Authorization: Bearer $IVORA_API_KEY"
Response · 200
{
  "data": [
    {
      "id": "id_0123456789abcdef",
      "kind": "global",
      "label": "string",
      "tenant_id": 1042,
      "domain_id": "domain_0123456789abcdef",
      "hostname": "ocpp.example.com",
      "url": "https://app.example.com/ivora/webhooks",
      "available": false,
      "reason": "string"
    }
  ],
  "custom_url_notice": "string",
  "custom_url_ws_warning": "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.