Create subnet
curl --request POST \
--url https://network.{region}.basaltic.sh/v1/subnets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"vpc": "5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f",
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"description": "Public web-tier subnet",
"gateway_ipv4": "10.0.1.1",
"route_table": "a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f",
"allocate_cidr_ipv6": false,
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"tags": {}
}
'import requests
url = "https://network.{region}.basaltic.sh/v1/subnets"
payload = {
"vpc": "5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f",
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"description": "Public web-tier subnet",
"gateway_ipv4": "10.0.1.1",
"route_table": "a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f",
"allocate_cidr_ipv6": False,
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"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({
vpc: '5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f',
name: 'prod-web',
cidr_ipv4: '10.0.1.0/24',
description: 'Public web-tier subnet',
gateway_ipv4: '10.0.1.1',
route_table: 'a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f',
allocate_cidr_ipv6: false,
cidr_ipv6: '2a13:9500:1a6:100::/64',
tags: {}
})
};
fetch('https://network.{region}.basaltic.sh/v1/subnets', 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/subnets",
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([
'vpc' => '5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f',
'name' => 'prod-web',
'cidr_ipv4' => '10.0.1.0/24',
'description' => 'Public web-tier subnet',
'gateway_ipv4' => '10.0.1.1',
'route_table' => 'a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f',
'allocate_cidr_ipv6' => false,
'cidr_ipv6' => '2a13:9500:1a6:100::/64',
'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/subnets"
payload := strings.NewReader("{\n \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\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/subnets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://network.{region}.basaltic.sh/v1/subnets")
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 \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"subnet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:network:sa-saopaulo-1:my-account:vpc/prod/subnet/prod-web",
"vpc": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"route_table": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"gateway_ipv4": "10.0.1.1",
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Public web-tier subnet",
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"gateway_ipv6": "2a13:9500:1a6:100::1"
}
}{
"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": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"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"
}
}Subnets
Create subnet
Carve a CIDR out of a VPC. The subnet network and its link to the VPC router are provisioned automatically.
POST
/
v1
/
subnets
Create subnet
curl --request POST \
--url https://network.{region}.basaltic.sh/v1/subnets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"vpc": "5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f",
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"description": "Public web-tier subnet",
"gateway_ipv4": "10.0.1.1",
"route_table": "a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f",
"allocate_cidr_ipv6": false,
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"tags": {}
}
'import requests
url = "https://network.{region}.basaltic.sh/v1/subnets"
payload = {
"vpc": "5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f",
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"description": "Public web-tier subnet",
"gateway_ipv4": "10.0.1.1",
"route_table": "a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f",
"allocate_cidr_ipv6": False,
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"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({
vpc: '5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f',
name: 'prod-web',
cidr_ipv4: '10.0.1.0/24',
description: 'Public web-tier subnet',
gateway_ipv4: '10.0.1.1',
route_table: 'a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f',
allocate_cidr_ipv6: false,
cidr_ipv6: '2a13:9500:1a6:100::/64',
tags: {}
})
};
fetch('https://network.{region}.basaltic.sh/v1/subnets', 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/subnets",
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([
'vpc' => '5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f',
'name' => 'prod-web',
'cidr_ipv4' => '10.0.1.0/24',
'description' => 'Public web-tier subnet',
'gateway_ipv4' => '10.0.1.1',
'route_table' => 'a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f',
'allocate_cidr_ipv6' => false,
'cidr_ipv6' => '2a13:9500:1a6:100::/64',
'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/subnets"
payload := strings.NewReader("{\n \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\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/subnets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://network.{region}.basaltic.sh/v1/subnets")
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 \"vpc\": \"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f\",\n \"name\": \"prod-web\",\n \"cidr_ipv4\": \"10.0.1.0/24\",\n \"description\": \"Public web-tier subnet\",\n \"gateway_ipv4\": \"10.0.1.1\",\n \"route_table\": \"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f\",\n \"allocate_cidr_ipv6\": false,\n \"cidr_ipv6\": \"2a13:9500:1a6:100::/64\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"subnet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:network:sa-saopaulo-1:my-account:vpc/prod/subnet/prod-web",
"vpc": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"route_table": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"name": "prod-web",
"cidr_ipv4": "10.0.1.0/24",
"gateway_ipv4": "10.0.1.1",
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Public web-tier subnet",
"cidr_ipv6": "2a13:9500:1a6:100::/64",
"gateway_ipv6": "2a13:9500:1a6:100::1"
}
}{
"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": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"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:CreateSubnet. 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:
255Body
application/json
VPC UUID, CRN or exact name in the caller account.
Example:
"5f8d3a2e-1c4b-4e7a-9f6d-2b1a8c3e5d7f"
Resource names must not start with the literal crn: prefix or be UUIDs (canonical, compact, braced, or urn:uuid: forms, in either case).
Example:
"prod-web"
Example:
"10.0.1.0/24"
Example:
"Public web-tier subnet"
Defaults to the first usable host in the CIDR
Example:
"10.0.1.1"
Route-table UUID, nested CRN or exact name within the subnet VPC. On PATCH the owned path subnet supplies the VPC. Omission on create selects the default table; an empty reference is invalid.
Example:
"a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f"
Allocate a free /64 from the VPC IPv6 range. Can be enabled after creation. Every existing and new interface receives an IPv6 /96 and its first /128 automatically. NAT gateways hosted here also receive a public IPv6 address from the regional pool. Updating hosted gateways requires UpdateNATGateway permission and public IPv6 quota.
An aligned /64 inside the VPC IPv6 range. Can be added later; cannot replace an existing range. Mutually exclusive with allocate_cidr_ipv6.
Example:
"2a13:9500:1a6:100::/64"
Show child attributes
Show child attributes
Response
Subnet created
Show child attributes
Show child attributes