PrivateLink Connections
Update a PrivateLink connection
Updates an existing PrivateLink connection by UUID. The name can always be updated. The config fields (region / VPC service name / data plane / availability zones) are only mutable while the connection is under review or errored — once it is being provisioned or live they are immutable.
POST
/
privatelink-connections
/
{uuid}
Update a PrivateLink connection
curl --request POST \
--url https://api.artie.com/privatelink-connections/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"availabilityZoneIds": [
"<string>"
],
"name": "<string>",
"vpcServiceName": "<string>",
"dataPlaneName": "<string>"
}
'import requests
url = "https://api.artie.com/privatelink-connections/{uuid}"
payload = {
"availabilityZoneIds": ["<string>"],
"name": "<string>",
"vpcServiceName": "<string>",
"dataPlaneName": "<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({
availabilityZoneIds: ['<string>'],
name: '<string>',
vpcServiceName: '<string>',
dataPlaneName: '<string>'
})
};
fetch('https://api.artie.com/privatelink-connections/{uuid}', 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.artie.com/privatelink-connections/{uuid}",
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([
'availabilityZoneIds' => [
'<string>'
],
'name' => '<string>',
'vpcServiceName' => '<string>',
'dataPlaneName' => '<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.artie.com/privatelink-connections/{uuid}"
payload := strings.NewReader("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<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.artie.com/privatelink-connections/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artie.com/privatelink-connections/{uuid}")
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 \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"availabilityZoneIds": [
"<string>"
],
"companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"dnsEntry": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"region": "<string>",
"status": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vpcServiceName": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"dataPlaneName": "<string>",
"provisioningError": "<string>",
"vpcEndpointId": "<string>"
}Authorizations
API key passed as a Bearer token in the Authorization header.
Path Parameters
Body
application/json
Response
OK
Was this page helpful?
Previous
Delete a PrivateLink connectionPermanently deletes a PrivateLink connection by UUID. This action cannot be undone and will remove the connection from your account.
Next
⌘I
Update a PrivateLink connection
curl --request POST \
--url https://api.artie.com/privatelink-connections/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"availabilityZoneIds": [
"<string>"
],
"name": "<string>",
"vpcServiceName": "<string>",
"dataPlaneName": "<string>"
}
'import requests
url = "https://api.artie.com/privatelink-connections/{uuid}"
payload = {
"availabilityZoneIds": ["<string>"],
"name": "<string>",
"vpcServiceName": "<string>",
"dataPlaneName": "<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({
availabilityZoneIds: ['<string>'],
name: '<string>',
vpcServiceName: '<string>',
dataPlaneName: '<string>'
})
};
fetch('https://api.artie.com/privatelink-connections/{uuid}', 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.artie.com/privatelink-connections/{uuid}",
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([
'availabilityZoneIds' => [
'<string>'
],
'name' => '<string>',
'vpcServiceName' => '<string>',
'dataPlaneName' => '<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.artie.com/privatelink-connections/{uuid}"
payload := strings.NewReader("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<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.artie.com/privatelink-connections/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artie.com/privatelink-connections/{uuid}")
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 \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"availabilityZoneIds": [
"<string>"
],
"companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"dnsEntry": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"region": "<string>",
"status": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vpcServiceName": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"dataPlaneName": "<string>",
"provisioningError": "<string>",
"vpcEndpointId": "<string>"
}