PrivateLink Connections
Create a PrivateLink connection
Creates a new PrivateLink connection for the authenticated company.
POST
/
privatelink-connections
Create a PrivateLink connection
curl --request POST \
--url https://api.artie.com/privatelink-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"availabilityZoneIds": [
"<string>"
],
"vpcServiceName": "<string>",
"dataPlaneName": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
'import requests
url = "https://api.artie.com/privatelink-connections"
payload = {
"availabilityZoneIds": ["<string>"],
"vpcServiceName": "<string>",
"dataPlaneName": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<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>'],
vpcServiceName: '<string>',
dataPlaneName: '<string>',
environmentUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>'
})
};
fetch('https://api.artie.com/privatelink-connections', 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",
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>'
],
'vpcServiceName' => '<string>',
'dataPlaneName' => '<string>',
'environmentUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<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"
payload := strings.NewReader("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artie.com/privatelink-connections")
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 \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<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.
Body
application/json
Response
OK
Was this page helpful?
Previous
Get a PrivateLink connectionRetrieves the details of a PrivateLink connection by UUID, including its status, VPC service name, region, DNS entry, and availability zones.
Next
⌘I
Create a PrivateLink connection
curl --request POST \
--url https://api.artie.com/privatelink-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"availabilityZoneIds": [
"<string>"
],
"vpcServiceName": "<string>",
"dataPlaneName": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
'import requests
url = "https://api.artie.com/privatelink-connections"
payload = {
"availabilityZoneIds": ["<string>"],
"vpcServiceName": "<string>",
"dataPlaneName": "<string>",
"environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<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>'],
vpcServiceName: '<string>',
dataPlaneName: '<string>',
environmentUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>'
})
};
fetch('https://api.artie.com/privatelink-connections', 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",
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>'
],
'vpcServiceName' => '<string>',
'dataPlaneName' => '<string>',
'environmentUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<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"
payload := strings.NewReader("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"availabilityZoneIds\": [\n \"<string>\"\n ],\n \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artie.com/privatelink-connections")
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 \"vpcServiceName\": \"<string>\",\n \"dataPlaneName\": \"<string>\",\n \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<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>"
}