Plugs / Create

POST

api

assets

plugs

Plugs / Create

curl --request POST \
  --url https://api.chargecloud.dev/api/v1/assets/plugs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chargepoint_uuid": "<string>",
  "type_id": 2,
  "phase": "ac3",
  "ampere": 4999,
  "voltage": 4999,
  "max_power": 1,
  "active": true,
  "fixable": true,
  "with_cable": false,
  "cable_length": 1,
  "export": false,
  "comment": "<string>",
  "serial_number": "<string>",
  "article_number": "<string>"
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/plugs"

payload = {
    "chargepoint_uuid": "<string>",
    "type_id": 2,
    "phase": "ac3",
    "ampere": 4999,
    "voltage": 4999,
    "max_power": 1,
    "active": True,
    "fixable": True,
    "with_cable": False,
    "cable_length": 1,
    "export": False,
    "comment": "<string>",
    "serial_number": "<string>",
    "article_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({
    chargepoint_uuid: '<string>',
    type_id: 2,
    phase: 'ac3',
    ampere: 4999,
    voltage: 4999,
    max_power: 1,
    active: true,
    fixable: true,
    with_cable: false,
    cable_length: 1,
    export: false,
    comment: '<string>',
    serial_number: '<string>',
    article_number: '<string>'
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/plugs', 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.chargecloud.dev/api/v1/assets/plugs",
  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([
    'chargepoint_uuid' => '<string>',
    'type_id' => 2,
    'phase' => 'ac3',
    'ampere' => 4999,
    'voltage' => 4999,
    'max_power' => 1,
    'active' => true,
    'fixable' => true,
    'with_cable' => false,
    'cable_length' => 1,
    'export' => false,
    'comment' => '<string>',
    'serial_number' => '<string>',
    'article_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.chargecloud.dev/api/v1/assets/plugs"

	payload := strings.NewReader("{\n  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_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.chargecloud.dev/api/v1/assets/plugs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/plugs")

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  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\"\n}"

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

{
  "plug": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "plug_type": {
      "id": 123,
      "name": "<string>",
      "standard": "<string>"
    },
    "chargepoint_uuid": "<string>",
    "type_id": 2,
    "phase": "ac3",
    "ampere": 4999,
    "voltage": 4999,
    "max_power": 1,
    "active": true,
    "fixable": true,
    "with_cable": false,
    "cable_length": 1,
    "export": false,
    "comment": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth2 Bearer Authorization

Scopes

asset:plugs

Headers

Accept-Language

string

BCP 47 language tag for content negotiation (e.g. en, de-DE).

Example:

"en"

Body

application/json

Creates a plug and attaches it to a chargepoint of the authenticated client. Required permission: asset:plugs:create. Available contexts: API Key, User.

chargepoint_uuid

string

required

The UUID of the charge point this plug is physically attached to. Set at creation and cannot be changed via update. Each plug must always be linked to exactly one charge point.

Pattern: ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$

type_id

integer<int32>

required

Identifier of the plug type (e.g. Type 2, CCS, CHAdeMO). Allowed values come from PlugTypes / List; unknown ids are rejected with a 422 response. An incorrect plug type may cause the connector to fail quality checks and be excluded from public outputs and roaming platforms.

Required range: x >= 1

phase

enum<string>

required

Electrical phase wiring. Allowed values: ac1 (single-phase AC), ac3 (three-phase AC), dc (direct current / fast charging).

Available options:

ac1,

ac3,

dc

Example:

"ac3"

ampere

integer<int32>

required

Maximum supported current in amperes. Displayed in the app and transmitted to roaming partners. Typical values: 16A (Schuko), 32A (Type 2), 200A (CHAdeMO), 600A (CCS2).

Required range: 0 <= x <= 9999

voltage

integer<int32>

required

Nominal voltage in volts. Displayed in the app and transmitted to roaming partners. Typical values: 230V (Type 1/Schuko), 400V (Type 2 AC), up to 1000V (DC fast charging).

Required range: 0 <= x <= 9999

max_power

number<float>

required

The maximum charging power of this plug in kilowatts. One of the most important fields for end users, as drivers filter charge points by this value when searching for a suitable location.

Required range: x >= 0

active

boolean

default:true

required

Whether the plug is in service. Inactive plugs are excluded from public visibility and roaming.

fixable

boolean

default:true

required

Whether the plug can be mechanically locked during a session.

with_cable

boolean

default:false

required

True for tethered plugs with a fixed cable, false for sockets.

cable_length

integer<int32>

required

Cable length in centimeters. Only meaningful when with_cable is true.

Required range: x >= 0

export

boolean

default:false

required

Whether the plug is advertised through outbound roaming and public APIs (OICP, OCPI).

comment

string

Free-form internal note, visible only to back-office users.

Maximum string length: 255

serial_number

string

Hardware serial number of the plug.

Maximum string length: 25

article_number

string

Manufacturer article (model) number.

Maximum string length: 25

Response

The newly created plug.

plug

object

required

The plug record of a charge point with its plug type and electrical ratings.

Show child attributes

⌘I

Plugs / Create

curl --request POST \
  --url https://api.chargecloud.dev/api/v1/assets/plugs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chargepoint_uuid": "<string>",
  "type_id": 2,
  "phase": "ac3",
  "ampere": 4999,
  "voltage": 4999,
  "max_power": 1,
  "active": true,
  "fixable": true,
  "with_cable": false,
  "cable_length": 1,
  "export": false,
  "comment": "<string>",
  "serial_number": "<string>",
  "article_number": "<string>"
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/plugs"

payload = {
    "chargepoint_uuid": "<string>",
    "type_id": 2,
    "phase": "ac3",
    "ampere": 4999,
    "voltage": 4999,
    "max_power": 1,
    "active": True,
    "fixable": True,
    "with_cable": False,
    "cable_length": 1,
    "export": False,
    "comment": "<string>",
    "serial_number": "<string>",
    "article_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({
    chargepoint_uuid: '<string>',
    type_id: 2,
    phase: 'ac3',
    ampere: 4999,
    voltage: 4999,
    max_power: 1,
    active: true,
    fixable: true,
    with_cable: false,
    cable_length: 1,
    export: false,
    comment: '<string>',
    serial_number: '<string>',
    article_number: '<string>'
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/plugs', 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.chargecloud.dev/api/v1/assets/plugs",
  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([
    'chargepoint_uuid' => '<string>',
    'type_id' => 2,
    'phase' => 'ac3',
    'ampere' => 4999,
    'voltage' => 4999,
    'max_power' => 1,
    'active' => true,
    'fixable' => true,
    'with_cable' => false,
    'cable_length' => 1,
    'export' => false,
    'comment' => '<string>',
    'serial_number' => '<string>',
    'article_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.chargecloud.dev/api/v1/assets/plugs"

	payload := strings.NewReader("{\n  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_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.chargecloud.dev/api/v1/assets/plugs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/plugs")

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  \"chargepoint_uuid\": \"<string>\",\n  \"type_id\": 2,\n  \"phase\": \"ac3\",\n  \"ampere\": 4999,\n  \"voltage\": 4999,\n  \"max_power\": 1,\n  \"active\": true,\n  \"fixable\": true,\n  \"with_cable\": false,\n  \"cable_length\": 1,\n  \"export\": false,\n  \"comment\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\"\n}"

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

{
  "plug": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "plug_type": {
      "id": 123,
      "name": "<string>",
      "standard": "<string>"
    },
    "chargepoint_uuid": "<string>",
    "type_id": 2,
    "phase": "ac3",
    "ampere": 4999,
    "voltage": 4999,
    "max_power": 1,
    "active": true,
    "fixable": true,
    "with_cable": false,
    "cable_length": 1,
    "export": false,
    "comment": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Getting started - Core

Core API

Authorizations

Scopes

Headers

Body

Response