curl --request PATCH \
--url https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dismissed": true,
"welcome_seen": true,
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding"
payload = {
"dismissed": True,
"welcome_seen": True,
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dismissed: true,
welcome_seen: true,
instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
confirmed_instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding', 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://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding",
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([
'dismissed' => true,
'welcome_seen' => true,
'instance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'confirmed_instance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding"
payload := strings.NewReader("{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"onboarding": {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>",
"provisioning_status": "pending",
"provisioning_step": "<string>",
"dismissed": true,
"welcome_seen": true,
"connection_recorded": true,
"steps": [
{
"id": "ssh",
"complete": true
}
],
"error_code": "<string>",
"vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subnet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"security_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"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"
}
}Update shared account guide preferences
Requires a personal user with a current role assignment in this account. Progress and dismissal are shared by all account members. Resource operations still require their normal permissions.
curl --request PATCH \
--url https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dismissed": true,
"welcome_seen": true,
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding"
payload = {
"dismissed": True,
"welcome_seen": True,
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dismissed: true,
welcome_seen: true,
instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
confirmed_instance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding', 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://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding",
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([
'dismissed' => true,
'welcome_seen' => true,
'instance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'confirmed_instance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding"
payload := strings.NewReader("{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://workspace.basaltic.sh/v1/accounts/{account_id}/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dismissed\": true,\n \"welcome_seen\": true,\n \"instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"confirmed_instance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"onboarding": {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>",
"provisioning_status": "pending",
"provisioning_step": "<string>",
"dismissed": true,
"welcome_seen": true,
"connection_recorded": true,
"steps": [
{
"id": "ssh",
"complete": true
}
],
"error_code": "<string>",
"vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subnet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"security_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmed_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"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"
}
}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.
Path Parameters
Body
Response
Current account onboarding
Account-shared first-server progress. New accounts provision one IPv4 public subnet, an internet gateway, and a security group. No NAT gateway or public IP is allocated during setup. Existing accounts are never automatically provisioned.
Show child attributes
Show child attributes

