Change a connection's address
curl --request PUT \
--url https://chargerdojo.com/api/v1/connections/{id}/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"partnerBaseUrl": "<string>"
}
'import requests
url = "https://chargerdojo.com/api/v1/connections/{id}/address"
payload = { "partnerBaseUrl": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({partnerBaseUrl: '<string>'})
};
fetch('https://chargerdojo.com/api/v1/connections/{id}/address', 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://chargerdojo.com/api/v1/connections/{id}/address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'partnerBaseUrl' => '<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://chargerdojo.com/api/v1/connections/{id}/address"
payload := strings.NewReader("{\n \"partnerBaseUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://chargerdojo.com/api/v1/connections/{id}/address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"partnerBaseUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chargerdojo.com/api/v1/connections/{id}/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partnerBaseUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "<string>",
"partnerBaseUrl": "<string>",
"ourRole": "CPO",
"theirRole": "CPO",
"ocpiVersion": "2.1.1",
"status": "pending",
"kind": "external",
"lastError": "<string>"
},
"meta": {
"limit": 123,
"skip": 123,
"nextCursor": "<string>"
}
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Connections
Change a connection's address
Move an owned connection to a new base URL when the partner host changes, keeping its tokens and history, then re-read their endpoints at the new address.
PUT
/
connections
/
{id}
/
address
Change a connection's address
curl --request PUT \
--url https://chargerdojo.com/api/v1/connections/{id}/address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"partnerBaseUrl": "<string>"
}
'import requests
url = "https://chargerdojo.com/api/v1/connections/{id}/address"
payload = { "partnerBaseUrl": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({partnerBaseUrl: '<string>'})
};
fetch('https://chargerdojo.com/api/v1/connections/{id}/address', 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://chargerdojo.com/api/v1/connections/{id}/address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'partnerBaseUrl' => '<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://chargerdojo.com/api/v1/connections/{id}/address"
payload := strings.NewReader("{\n \"partnerBaseUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://chargerdojo.com/api/v1/connections/{id}/address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"partnerBaseUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chargerdojo.com/api/v1/connections/{id}/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partnerBaseUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "<string>",
"partnerBaseUrl": "<string>",
"ourRole": "CPO",
"theirRole": "CPO",
"ocpiVersion": "2.1.1",
"status": "pending",
"kind": "external",
"lastError": "<string>"
},
"meta": {
"limit": 123,
"skip": 123,
"nextCursor": "<string>"
}
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"message": "<string>",
"status": "error",
"code": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
A cdojo_... API key created in the app under Settings.
Path Parameters
Identifier from the path. Owner scoped: another owner's id answers 404.
Body
application/json
The base URL the partner's OCPI implementation is now reachable at. The connection keeps its tokens, its id and its run history, drops to pending, and is re-registered only if their endpoints answer at the new address.