AXaxle
4. Assets

Create Asset

Changed on

Create a new asset.

The asset must be associated with an existing site. Returns the created asset details including the assigned UUID.

post/entities/asset

Request

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

Request body

external_idstring required

Vendor-specific identifier for the asset

type'charger' | 'battery' | 'heat pump' | 'electric_vehicle' | 'hot water tank' required

Asset types that can be created through the API.

site_idstring uuid required

ID of the site where the asset is located

asset_modelstring

Name of the AssetModel to assign (looked up by name)

installation_datestring date

Date when the asset was installed

serial_numberstring

The serial number of the asset

Response

Successfully created asset

idstring uuid required

Axle's internal UUID for the asset

external_idstring required

Vendor-specific identifier for the asset

type'boundary meter' | 'charger' | 'battery' | 'heat pump' | 'hot water tank' | 'frequency meter' | 'electric_vehicle' | 'pv inverter' required
site_idstring uuid required

ID of the site where the asset is located

needs_reauthorisationboolean

Whether the owner must re-authorise their device connection to keep taking part in events

Changes

  • b0b07b1dbf12Revision changes
    • 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