curl --request POST \
--url https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prefix": "hub",
"upstream_registry": "docker.io",
"upstream_prefix": "library",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
'import requests
url = "https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules"
payload = {
"prefix": "hub",
"upstream_registry": "docker.io",
"upstream_prefix": "library",
"upstream_username": "<string>",
"upstream_secret": "<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({
prefix: 'hub',
upstream_registry: 'docker.io',
upstream_prefix: 'library',
upstream_username: '<string>',
upstream_secret: '<string>'
})
};
fetch('https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules', 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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules",
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([
'prefix' => 'hub',
'upstream_registry' => 'docker.io',
'upstream_prefix' => 'library',
'upstream_username' => '<string>',
'upstream_secret' => '<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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules"
payload := strings.NewReader("{\n \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules")
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 \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"pull_through_cache_rule": {
"crn": "crn:registry:sa-saopaulo-1:my-account:pull-through-cache-rule/hub",
"prefix": "hub",
"uri_prefix": "cr.sa-saopaulo-1.basaltic.cloud/my-account/hub",
"upstream_registry": "registry-1.docker.io",
"has_credential": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"upstream_prefix": "library",
"upstream_username": "robot"
}
}{
"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": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Create a pull-through cache rule
Maps a prefix in this account onto an upstream registry, so a fleet pulls public base images through its own registry.
Set prefix to hub, upstream_registry to docker.io, and
upstream_prefix to library to pull Docker Hub official images:
docker pull cr.sa-saopaulo-1.basaltic.cloud/my-account/hub/nginx:1.27
What this is for. Docker Hub rate-limits by source IP, and a fleet
behind one NAT is one IP: a rolling deploy across two hundred nodes is
two hundred pulls of the same base image against a shared budget, and
the failure — every node’s image pull backing off at once — arrives as
an outage in the middle of a deploy. One fetch, cached, takes the
budget off the critical path. Setting upstream_username and
upstream_secret helps even for a public upstream, because an
authenticated Docker Hub pull draws on a much larger budget than an
anonymous one.
Nothing is mirrored now. A rule is a mapping, not an instruction to copy a registry. The repository under it and its content are created by the first pull that misses, so a rule nobody pulls through costs a row.
Who can trigger a fetch. A cache miss spends the account’s storage
quota and pulls bytes from a third party, so it needs
registry:BatchImportUpstreamImage on top of the pull actions. A
fleet given only pull consumes what is already cached and gets a 404
on anything else — which is how you keep a production cluster from
reaching the internet while CI keeps the mirror warm.
The prefix must own its namespace. Creating a rule over a prefix the account already has repositories under is refused: those repositories would stay un-mirrored while new names under the same prefix mirrored, and nothing in a reference would say which applied.
Requires registry:CreatePullThroughCacheRule.
curl --request POST \
--url https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prefix": "hub",
"upstream_registry": "docker.io",
"upstream_prefix": "library",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
'import requests
url = "https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules"
payload = {
"prefix": "hub",
"upstream_registry": "docker.io",
"upstream_prefix": "library",
"upstream_username": "<string>",
"upstream_secret": "<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({
prefix: 'hub',
upstream_registry: 'docker.io',
upstream_prefix: 'library',
upstream_username: '<string>',
upstream_secret: '<string>'
})
};
fetch('https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules', 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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules",
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([
'prefix' => 'hub',
'upstream_registry' => 'docker.io',
'upstream_prefix' => 'library',
'upstream_username' => '<string>',
'upstream_secret' => '<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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules"
payload := strings.NewReader("{\n \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules")
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 \"prefix\": \"hub\",\n \"upstream_registry\": \"docker.io\",\n \"upstream_prefix\": \"library\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"pull_through_cache_rule": {
"crn": "crn:registry:sa-saopaulo-1:my-account:pull-through-cache-rule/hub",
"prefix": "hub",
"uri_prefix": "cr.sa-saopaulo-1.basaltic.cloud/my-account/hub",
"upstream_registry": "registry-1.docker.io",
"has_credential": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"upstream_prefix": "library",
"upstream_username": "robot"
}
}{
"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": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}registry:CreatePullThroughCacheRule. See REGISTRY 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.
255Body
One or two lowercase repository-name components. It becomes the leading path of every repository the rule creates, so it has to be a name a client can pull.
"hub"
A hostname with an optional port. https:// is accepted and
stripped; anything else is refused, because the connection can
carry a credential.
"docker.io"
Optional path prepended upstream.
"library"
Optional. Worth setting even against a public registry: an authenticated Docker Hub pull draws on a far larger rate-limit budget than an anonymous one.
The password or token. Write-only — sealed at rest and never
returned. Required with upstream_username, and refused without
it: a half-specified credential produces an anonymous pull that
silently draws on the small budget.
Response
Rule created. Nothing has been fetched.
Show child attributes
Show child attributes

