Luxor Documentation Hub Logo
Mining Pool/API Documentation/V2/Workspaces

Update site

Updates an existing site with energy information associated to a Workspace. Returns site details organized by product (energy, pool) based on user permissions.

PATCH
/v2/workspace/sites/{site_id}

Authorization

authorization<token>

Use your API key here.

In: header

Request Body

application/jsonOptional
namestring
Minimum length: 1Maximum length: 100
countrystring
Value in: "USA" | "CA" | "OTHER"
energyobject

Path Parameters

site_idRequiredstring
Format: "uuid"
curl -X PATCH "https://app.luxor.tech/api/v2/workspace/sites/b0a5fad8-0e09-4f10-ac20-ccd80fb2d138" \
  -H "authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Site",
    "country": "USA",
    "energy": {
      "base_load_kw": 100,
      "max_load_kw": 1000,
      "settlement_point_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  }'

Default Response

{
  "id": "b0a5fad8-0e09-4f10-ac20-ccd80fb2d138",
  "name": "My Site",
  "country": "USA",
  "energy": {
    "base_load_kw": 100,
    "max_load_kw": 1000,
    "min_load_kw": 0,
    "settlement_point_id": "123e4567-e89b-12d3-a456-426614174000",
    "settlement_point_name": "LZ_NORTH",
    "power_market": "ERCOT"
  },
  "pool": {
    "subaccounts": [
      {
        "id": 0,
        "name": "my_subaccount"
      }
    ]
  }
}

Previous

Create site

Next

Delete site