---
title: Boost Settings
slug: dev/boost-settings
createdAt: 2024-07-26T09:33:12.650Z
---

:::ApiMethodV2
```json
{
  "name": "Get Boost Settings",
  "method": "GET",
  "url": "https://cloud.clemap.com:3032/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings",
  "description": "This method allows to retrieve the currently valid boost settings with a timestamp until which the settings are valid. If there are no currently valid settings, the response values are null.",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "iAn48i6nrr0BIgs3VhdqQ",
        "language": "curl",
        "code": "curl --location --globoff '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings' \\\n--header 'evsetoken: string'",
        "customLabel": ""
      },
      {
        "id": "IlUfpq9ORRjVZK-Zo9vXL",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'GET',\n   'url': '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings',\n   'headers': {\n      'evsetoken': 'string'\n   }\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "VTdsjuVvH1TIbPHRksn9d",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"evsetoken\", \"string\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "z_SWGcEJN7Ot21JZZXYC4",
        "language": "python",
        "code": "import requests\n\nurl = \"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\"\n\npayload = {}\nheaders = {\n   'evsetoken': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "pp5noNrvH2Ghy8aWBVehZ",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"evsetoken\"] = \"string\"\n\nresponse = http.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "iAn48i6nrr0BIgs3VhdqQ"
  },
  "results": {
    "languages": [
      {
        "id": "Nd4NttKjFHtHJTSI-2WGc",
        "language": "200",
        "customLabel": "",
        "code": "{\n  \"valid_until\": \"2024-05-30T09:14:47.244362+00:00\" | null\n}"
      }
    ],
    "selectedLanguageId": "Nd4NttKjFHtHJTSI-2WGc"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "evsetoken",
        "kind": "required",
        "type": "string",
        "description": "EVSE authentication token for the specific charging station.",
        "children": []
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "autoGeneratedAnchorSlug": "get-boost-settings",
  "legacyHash": "yLNhxE9n7cf_FTux_N6W4"
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Set Boost Settings",
  "method": "POST",
  "url": "https://cloud.clemap.com:3032/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings",
  "description": "Allows to set a so-called boost period, where the charging station has a higher\npriority for a certain duration (in seconds). During such a period, the charging\nstation is allocated the maximum power with high priority, thus allowing to\ncharge faster for a period of time.",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "O-LG2KwNZ5FohATCWFLxD",
        "language": "curl",
        "code": "curl --location --globoff '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings' \\\n--header 'evsetoken: string' \\\n--data '{\"duration\":\"Integer\"}'",
        "customLabel": ""
      },
      {
        "id": "BKHD5ORQvatGwgTdokvNg",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'POST',\n   'url': '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings',\n   'headers': {\n      'evsetoken': 'string'\n   },\n   body: '{\"duration\":\"Integer\"}'\n\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "PrnAD1WGwJo54z6QQ9q6t",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"evsetoken\", \"string\");\n\nvar raw = \"{\\\"duration\\\":\\\"Integer\\\"}\";\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "QONIC8u3PAtWbSdXUtdq6",
        "language": "python",
        "code": "import requests\n\nurl = \"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\"\n\npayload = \"{\\\"duration\\\":\\\"Integer\\\"}\"\nheaders = {\n   'evsetoken': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "_k_7FaP14pD3GOqzMUDFX",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"evsetoken\"] = \"string\"\nrequest.body = \"{\\\"duration\\\":\\\"Integer\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "O-LG2KwNZ5FohATCWFLxD"
  },
  "results": {
    "languages": [
      {
        "id": "dEZ6_ipaI8Apy9ztlHPZi",
        "language": "201",
        "customLabel": "",
        "code": "{\n  \"state\": \"received\",\n  \"duration\": 3600\n}"
      }
    ],
    "selectedLanguageId": "dEZ6_ipaI8Apy9ztlHPZi"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "evsetoken",
        "kind": "required",
        "type": "string",
        "description": "EVSE authentication token for the specific charging station.",
        "children": []
      }
    ],
    "bodyDataParameters": [
      {
        "name": "duration",
        "kind": "required",
        "type": "Integer",
        "description": "Duration in seconds",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "autoGeneratedAnchorSlug": "set-boost-settings",
  "legacyHash": "KpXJsUC8eABhTuXBr2C8H"
}
```
:::

:::ApiMethodV2
```json
{
  "name": "Reset Boost Settings",
  "method": "DELETE",
  "url": "https://cloud.clemap.com:3032/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings",
  "description": "This method allows to reset the boost settings. The previous settings\nare returned.",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "X4KXXfHFeuCxRhE_gY3BH",
        "language": "curl",
        "code": "curl --location --globoff --request DELETE '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings' \\\n--header 'evsetoken: string'",
        "customLabel": ""
      },
      {
        "id": "O9_Qec_sI7wSRhSYBT9EJ",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'DELETE',\n   'url': '/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings',\n   'headers': {\n      'evsetoken': 'string'\n   }\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "fWZDGnfiUzNuMjy-G4IQY",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"evsetoken\", \"string\");\n\nvar requestOptions = {\n   method: 'DELETE',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "0bnLrvZ9GV5_eg5PKgHI_",
        "language": "python",
        "code": "import requests\n\nurl = \"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\"\n\npayload = {}\nheaders = {\n   'evsetoken': 'string'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "qn-wxc4Xc1aT7z-8mH_zU",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"/edgeDevices/{edge_device_id}/evses/{uuid}/boostSettings\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"evsetoken\"] = \"string\"\n\nresponse = http.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "X4KXXfHFeuCxRhE_gY3BH"
  },
  "results": {
    "languages": [
      {
        "id": "0OHBB8VD6dlcvCgicfsmQ",
        "language": "200",
        "customLabel": "",
        "code": "{\n  \"valid_until\": \"2024-05-30T09:14:47.244362+00:00\" | null\n}"
      }
    ],
    "selectedLanguageId": "0OHBB8VD6dlcvCgicfsmQ"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "evsetoken",
        "kind": "required",
        "type": "string",
        "description": "EVSE authentication token for the specific charging station.",
        "children": []
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "autoGeneratedAnchorSlug": "reset-boost-settings",
  "legacyHash": "feoqi-FiZYGv98U0nQ5XC"
}
```
:::