Create route
curl --request POST \
--url https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination_cidr": "0.0.0.0/0",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": "c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f",
"target_nat_gateway": "e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f",
"target_egress_only_gateway": "b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f",
"tags": {}
}
'import requests
url = "https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes"
payload = {
"destination_cidr": "0.0.0.0/0",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": "c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f",
"target_nat_gateway": "e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f",
"target_egress_only_gateway": "b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f",
"tags": {}
}
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({
destination_cidr: '0.0.0.0/0',
description: 'Default route to the internet gateway',
next_hop_ip: '10.0.1.1',
target_internet_gateway: 'c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f',
target_nat_gateway: 'e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f',
target_egress_only_gateway: 'b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f',
tags: {}
})
};
fetch('https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes', 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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes",
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([
'destination_cidr' => '0.0.0.0/0',
'description' => 'Default route to the internet gateway',
'next_hop_ip' => '10.0.1.1',
'target_internet_gateway' => 'c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f',
'target_nat_gateway' => 'e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f',
'target_egress_only_gateway' => 'b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f',
'tags' => [
]
]),
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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes"
payload := strings.NewReader("{\n \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes")
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 \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"route": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:network:sa-saopaulo-1:my-account:route/<uuid>",
"destination_cidr": "0.0.0.0/0",
"target_type": "ip",
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"target_nat_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"target_egress_only_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Routes
Create route
Install a static route on the route table.
POST
/
v1
/
route-tables
/
{route_table_id}
/
routes
Create route
curl --request POST \
--url https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination_cidr": "0.0.0.0/0",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": "c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f",
"target_nat_gateway": "e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f",
"target_egress_only_gateway": "b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f",
"tags": {}
}
'import requests
url = "https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes"
payload = {
"destination_cidr": "0.0.0.0/0",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": "c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f",
"target_nat_gateway": "e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f",
"target_egress_only_gateway": "b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f",
"tags": {}
}
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({
destination_cidr: '0.0.0.0/0',
description: 'Default route to the internet gateway',
next_hop_ip: '10.0.1.1',
target_internet_gateway: 'c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f',
target_nat_gateway: 'e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f',
target_egress_only_gateway: 'b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f',
tags: {}
})
};
fetch('https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes', 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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes",
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([
'destination_cidr' => '0.0.0.0/0',
'description' => 'Default route to the internet gateway',
'next_hop_ip' => '10.0.1.1',
'target_internet_gateway' => 'c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f',
'target_nat_gateway' => 'e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f',
'target_egress_only_gateway' => 'b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f',
'tags' => [
]
]),
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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes"
payload := strings.NewReader("{\n \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\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://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://network.{region}.basaltic.sh/v1/route-tables/{route_table_id}/routes")
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 \"destination_cidr\": \"0.0.0.0/0\",\n \"description\": \"Default route to the internet gateway\",\n \"next_hop_ip\": \"10.0.1.1\",\n \"target_internet_gateway\": \"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f\",\n \"target_nat_gateway\": \"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f\",\n \"target_egress_only_gateway\": \"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"route": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:network:sa-saopaulo-1:my-account:route/<uuid>",
"destination_cidr": "0.0.0.0/0",
"target_type": "ip",
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Default route to the internet gateway",
"next_hop_ip": "10.0.1.1",
"target_internet_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"target_nat_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"target_egress_only_gateway": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requires the IAM action
network:CreateRoute. See NETWORK permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Headers
Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.
Maximum string length:
255Path Parameters
Route Table ID
Body
application/json
Exactly one of next_hop_ip / target_internet_gateway / target_nat_gateway / target_egress_only_gateway (and future target_*_id fields) must be set.
Example:
"0.0.0.0/0"
Example:
"Default route to the internet gateway"
Unicast next hop inside this VPC's CIDR (same IP family as destination_cidr). Not for internet egress — use a gateway target id instead.
Example:
"10.0.1.1"
Gateway UUID, CRN or exact account-scoped name. Must belong to the route table VPC and match the destination_cidr address family. Exactly one route target is required.
Example:
"c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f"
Gateway UUID, CRN or exact account-scoped name. Must belong to the route table VPC and match the destination_cidr address family. Exactly one route target is required.
Example:
"e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f"
Gateway UUID, CRN or exact account-scoped name. Must belong to the route table VPC and match the destination_cidr address family. Exactly one route target is required.
Example:
"b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f"
Show child attributes
Show child attributes
Response
Route created
Show child attributes
Show child attributes