PATCH
/
entities
/
site
/
{site_id}
curl --request PATCH \
  --url http://localhost:8002/entities/site/{site_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "markets": [
    "cm"
  ],
  "tariff": {
    "tariff_cheap_start_time": "<string>",
    "tariff_cheap_end_time": "<string>",
    "tariff_type": "single_rate"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mpan": "<string>",
  "postcode": "<string>",
  "address": "<string>",
  "asset_ids": [],
  "markets": [
    "cm"
  ],
  "tariff": {
    "tariff_type": "single_rate",
    "tariff_cheap_start_time": "<string>",
    "tariff_cheap_end_time": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
site_id
string
required

Body

application/json

Request model for updating site information.

​
markets
enum<string>[]

Markets to update for the site

Market types available for participation.

  • CM: Capacity Market
  • DFS: Dynamic Frequency Service
  • DNO: Distribution Network Operator flexibility services
  • LCM: Local Capacity Market
  • SFFR: Static Firm Frequency Response
  • WHOLESALE: Wholesale energy market
Available options:
cm,
dfs,
dno,
lcm,
sffr,
wholesale
​
tariff
object

Tariff information to update

Response

200
application/json
Successful Response

Response model for site information.

​
id
string
required

Axle's internal UUID for the site

​
mpan
string

Meter Point Administration Number

​
postcode
string

UK postcode for the site

​
address
string

Full address for the site

​
asset_ids
string[]

List of asset IDs associated with this site

​
markets
enum<string>[]

Markets the site is participating in

Market types available for participation.

  • CM: Capacity Market
  • DFS: Dynamic Frequency Service
  • DNO: Distribution Network Operator flexibility services
  • LCM: Local Capacity Market
  • SFFR: Static Firm Frequency Response
  • WHOLESALE: Wholesale energy market
Available options:
cm,
dfs,
dno,
lcm,
sffr,
wholesale
​
tariff
object

Tariff information for the site