curl --request POST \
--url https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plaintext": "c3VwZXItc2VjcmV0LXZhbHVl",
"aad": "YWNjb3VudC1pZD0xMjM0"
}
'import requests
url = "https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt"
payload = {
"plaintext": "c3VwZXItc2VjcmV0LXZhbHVl",
"aad": "YWNjb3VudC1pZD0xMjM0"
}
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({plaintext: 'c3VwZXItc2VjcmV0LXZhbHVl', aad: 'YWNjb3VudC1pZD0xMjM0'})
};
fetch('https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt', 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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt",
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([
'plaintext' => 'c3VwZXItc2VjcmV0LXZhbHVl',
'aad' => 'YWNjb3VudC1pZD0xMjM0'
]),
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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt"
payload := strings.NewReader("{\n \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt")
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 \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\n}"
response = http.request(request)
puts response.read_body{
"ciphertext": "AQIDBHByb2QtbWFzdGVyL2VuY3J5cHRlZA==",
"key_crn": "crn:kms:sa-saopaulo-1:my-account:key/prod-master"
}{
"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": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Encrypt a payload
Encrypt plaintext under the key. Symmetric (AES-256) uses AES-GCM with a random 96-bit nonce prefixed to the ciphertext; aad is bound as AEAD additional data and must be supplied verbatim at decrypt. RSA keys use OAEP-SHA256 (aad is ignored). Refused unless key_usage=encrypt_decrypt and state=enabled.
curl --request POST \
--url https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plaintext": "c3VwZXItc2VjcmV0LXZhbHVl",
"aad": "YWNjb3VudC1pZD0xMjM0"
}
'import requests
url = "https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt"
payload = {
"plaintext": "c3VwZXItc2VjcmV0LXZhbHVl",
"aad": "YWNjb3VudC1pZD0xMjM0"
}
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({plaintext: 'c3VwZXItc2VjcmV0LXZhbHVl', aad: 'YWNjb3VudC1pZD0xMjM0'})
};
fetch('https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt', 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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt",
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([
'plaintext' => 'c3VwZXItc2VjcmV0LXZhbHVl',
'aad' => 'YWNjb3VudC1pZD0xMjM0'
]),
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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt"
payload := strings.NewReader("{\n \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\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://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kms.{region}.basaltic.sh/v1/keys/{key_id}/encrypt")
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 \"plaintext\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"aad\": \"YWNjb3VudC1pZD0xMjM0\"\n}"
response = http.request(request)
puts response.read_body{
"ciphertext": "AQIDBHByb2QtbWFzdGVyL2VuY3J5cHRlZA==",
"key_crn": "crn:kms:sa-saopaulo-1:my-account:key/prod-master"
}{
"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": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}kms:Encrypt. See KMS 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.
Path Parameters
"3f8a1c2e-9b47-4d6a-bc11-0e2f5a7d9c41"
Body
Base64-encoded plaintext.
"c3VwZXItc2VjcmV0LXZhbHVl"
Optional base64-encoded additional authenticated data (AES-GCM AEAD). Must be supplied verbatim to Decrypt; mismatch fails the auth tag check. Ignored for asymmetric keys.
"YWNjb3VudC1pZD0xMjM0"
Response
Ciphertext
Base64-encoded opaque, versioned ciphertext. Store verbatim; do not parse its internal layout. Decrypt selects the original material version automatically after rotation.
"AQIDBHByb2QtbWFzdGVyL2VuY3J5cHRlZA=="
CRN of the key the ciphertext was sealed under.
"crn:kms:sa-saopaulo-1:my-account:key/prod-master"

