curl --request PATCH \
--url https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"upstream_registry": "ghcr.io",
"upstream_prefix": "my-org",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
'import requests
url = "https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}"
payload = {
"upstream_registry": "ghcr.io",
"upstream_prefix": "my-org",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
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({
upstream_registry: 'ghcr.io',
upstream_prefix: 'my-org',
upstream_username: '<string>',
upstream_secret: '<string>'
})
};
fetch('https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}', 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/{prefix}",
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([
'upstream_registry' => 'ghcr.io',
'upstream_prefix' => 'my-org',
'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/{prefix}"
payload := strings.NewReader("{\n \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\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/{prefix}")
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 \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\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": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Update a pull-through cache rule
Repoints a rule or rotates its credential.
The prefix itself is immutable: it is the rule’s identity, the CRN a policy names, and the leading path of every repository already mirrored through it. Moving it would orphan those repositories from the rule that created them.
Omitting a field leaves it alone; sending an empty
upstream_username and upstream_secret together clears the
credential and makes the rule anonymous. Content already mirrored is
not re-fetched when the upstream changes — it is content-addressed
and still valid.
Requires registry:UpdatePullThroughCacheRule.
curl --request PATCH \
--url https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"upstream_registry": "ghcr.io",
"upstream_prefix": "my-org",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
'import requests
url = "https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}"
payload = {
"upstream_registry": "ghcr.io",
"upstream_prefix": "my-org",
"upstream_username": "<string>",
"upstream_secret": "<string>"
}
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({
upstream_registry: 'ghcr.io',
upstream_prefix: 'my-org',
upstream_username: '<string>',
upstream_secret: '<string>'
})
};
fetch('https://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}', 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/{prefix}",
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([
'upstream_registry' => 'ghcr.io',
'upstream_prefix' => 'my-org',
'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/{prefix}"
payload := strings.NewReader("{\n \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\n \"upstream_username\": \"<string>\",\n \"upstream_secret\": \"<string>\"\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://registry.{region}.basaltic.sh/v1/pull-through-cache-rules/{prefix}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\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/{prefix}")
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 \"upstream_registry\": \"ghcr.io\",\n \"upstream_prefix\": \"my-org\",\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": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}registry:UpdatePullThroughCacheRule. 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.
Path Parameters
The rule's prefix. May contain a slash — team/base is a legal
two-component prefix — so it is matched as a path remainder rather
than as a single segment.
"hub"
Body
Response
Rule updated.
Show child attributes
Show child attributes

