AXaxle
3. Sites

Onboard Site And Asset

Changed on

Deprecated — prefer /onboard instead.

The new /onboard endpoint supports multiple assets per site in a single call and includes improvements in idempotency, resilience and response details.

Register a site, asset, and dispatch consent in a single call.

Creates the site and asset, grants consent, and enrols in the relevant flex proposition.

This endpoint will:

  1. Create the site
  2. Create the asset associated with the site
  3. Enrol in the relevant flex proposition

Returns the created site and asset, including their IDs. Fails if the site or asset already exists.

post/entities/site/onboard-site-and-asset

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/site/onboard-site-and-asset
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Request body

Example request

{
  "asset": {
    "external_id": "charger-001",
    "asset_model": "axle_charger_v1",
    "installation_date": "2025-06-15"
  }
}

Response

Successfully onboarded site and asset

Changes

  • b0b07b1dbf12Revision changes
    • warning

      added the new price_curve enum value to the /// response property for the response status

    • info

      added the new price_curve enum value to the request property ///

    • info

      added the optional property // to the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status