Create asset

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

Create Asset

cURL

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {
    "power_kw": 1,
    "capacity_kwh": 1
  },
  "asset_model": "<string>",
  "installation_date": "2023-12-25",
  "serial_number": "<string>"
}
'

import requests

url = "https://api-sandbox.axle.energy/entities/asset"

payload = {
    "external_id": "<string>",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
        "power_kw": 1,
        "capacity_kwh": 1
    },
    "asset_model": "<string>",
    "installation_date": "2023-12-25",
    "serial_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: '<string>',
    site_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    properties: {power_kw: 1, capacity_kwh: 1},
    asset_model: '<string>',
    installation_date: '2023-12-25',
    serial_number: '<string>'
  })
};

fetch('https://api-sandbox.axle.energy/entities/asset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/entities/asset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_id' => '<string>',
    'site_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'properties' => [
        'power_kw' => 1,
        'capacity_kwh' => 1
    ],
    'asset_model' => '<string>',
    'installation_date' => '2023-12-25',
    'serial_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/entities/asset"

	payload := strings.NewReader("{\n  \"external_id\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"properties\": {\n    \"power_kw\": 1,\n    \"capacity_kwh\": 1\n  },\n  \"asset_model\": \"<string>\",\n  \"installation_date\": \"2023-12-25\",\n  \"serial_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.axle.energy/entities/asset")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"properties\": {\n    \"power_kw\": 1,\n    \"capacity_kwh\": 1\n  },\n  \"asset_model\": \"<string>\",\n  \"installation_date\": \"2023-12-25\",\n  \"serial_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/asset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"<string>\",\n  \"site_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"properties\": {\n    \"power_kw\": 1,\n    \"capacity_kwh\": 1\n  },\n  \"asset_model\": \"<string>\",\n  \"installation_date\": \"2023-12-25\",\n  \"serial_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {
    "power_kw": 1,
    "capacity_kwh": 1
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model for creating a new asset.

external_id · string · required

Vendor-specific identifier for the asset

type · enum<string> · required

Type of asset being created

Available options: charger, battery, heat pump, electric_vehicle, hot water tank

site_id · string<uuid> · required

ID of the site where the asset is located

properties · Properties · object

Optional asset properties

Show child attributes

asset_model · string

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

installation_date · string<date>

Date when the asset was installed

serial_number · string

The serial number of the asset

Response

200

application/json

Successfully created asset

Response model for asset information.

id · string<uuid> · required

Axle's internal UUID for the asset

external_id · string · required

Vendor-specific identifier for the asset

type · enum<string> · required

Type of asset

Available options: boundary meter, charger, battery, heat pump, hot water tank, frequency meter, electric_vehicle, pv inverter

site_id · string<uuid> · required

ID of the site where the asset is located

properties · Properties · object

Optional asset properties

Show child attributes