Perform a Patch on a location by name
curl --request PATCH \
--url https://api.cpln.io/org/{org}/location/{name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"region": "<string>",
"spec": {
"$drop": [
"enabled"
],
"enabled": true
},
"$replace/spec": {
"enabled": true
}
}
'import requests
url = "https://api.cpln.io/org/{org}/location/{name}"
payload = {
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"region": "<string>",
"spec": {
"$drop": ["enabled"],
"enabled": True
},
"$replace/spec": { "enabled": True }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
$drop: [],
name: '<string>',
description: '<string>',
tags: {},
'$replace/tags': {},
region: '<string>',
spec: {$drop: ['enabled'], enabled: true},
'$replace/spec': {enabled: true}
})
};
fetch('https://api.cpln.io/org/{org}/location/{name}', 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.cpln.io/org/{org}/location/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'$drop' => [
],
'name' => '<string>',
'description' => '<string>',
'tags' => [
],
'$replace/tags' => [
],
'region' => '<string>',
'spec' => [
'$drop' => [
'enabled'
],
'enabled' => true
],
'$replace/spec' => [
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.cpln.io/org/{org}/location/{name}"
payload := strings.NewReader("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://api.cpln.io/org/{org}/location/{name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/location/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"origin": "default",
"region": "<string>",
"spec": {
"enabled": true
},
"status": {
"geo": {
"lat": 123,
"lon": 123,
"country": "<string>",
"state": "<string>",
"city": "<string>",
"continent": "<string>"
},
"ipRanges": [
"<string>"
]
}
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Location
Perform a Patch on a location by name
PATCH
/
org
/
{org}
/
location
/
{name}
Perform a Patch on a location by name
curl --request PATCH \
--url https://api.cpln.io/org/{org}/location/{name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"region": "<string>",
"spec": {
"$drop": [
"enabled"
],
"enabled": true
},
"$replace/spec": {
"enabled": true
}
}
'import requests
url = "https://api.cpln.io/org/{org}/location/{name}"
payload = {
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"region": "<string>",
"spec": {
"$drop": ["enabled"],
"enabled": True
},
"$replace/spec": { "enabled": True }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
$drop: [],
name: '<string>',
description: '<string>',
tags: {},
'$replace/tags': {},
region: '<string>',
spec: {$drop: ['enabled'], enabled: true},
'$replace/spec': {enabled: true}
})
};
fetch('https://api.cpln.io/org/{org}/location/{name}', 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.cpln.io/org/{org}/location/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'$drop' => [
],
'name' => '<string>',
'description' => '<string>',
'tags' => [
],
'$replace/tags' => [
],
'region' => '<string>',
'spec' => [
'$drop' => [
'enabled'
],
'enabled' => true
],
'$replace/spec' => [
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.cpln.io/org/{org}/location/{name}"
payload := strings.NewReader("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://api.cpln.io/org/{org}/location/{name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/location/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"region\": \"<string>\",\n \"spec\": {\n \"$drop\": [\n \"enabled\"\n ],\n \"enabled\": true\n },\n \"$replace/spec\": {\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"origin": "default",
"region": "<string>",
"spec": {
"enabled": true
},
"status": {
"geo": {
"lat": 123,
"lon": 123,
"country": "<string>",
"state": "<string>",
"city": "<string>",
"continent": "<string>"
},
"ipRanges": [
"<string>"
]
}
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Authorizations
serviceAccountKeyjwt
Service account key can be used as API keys
Body
application/json
Available options:
description, tags, provider, region, spec Maximum string length:
64Maximum string length:
250Available options:
aws, gcp, azure, byok, linode, vultr, equinix, oci Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Available options:
builtin, default, custom Available options:
aws, gcp, azure, byok, linode, vultr, equinix, oci Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I