List status

Reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an honest lens for "is the registry plane up", never a fabricated ok.

GET /v1/registry/status

Addresshttps://api.hanzo.ai/v1/registry/status
MethodGET
Operationget_registry_status
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an honest lens for "is the registry plane up", never a fabricated ok.

Request

GET /v1/registry/status takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200registry.registryStatusok
defaultproblem-detailsrefused

200 body — 6 fields.

FieldInTypeAlwaysDescription
hostbodystring—Host is the OCI registry host clients push to and pull from.
ocibodyboolean—Oci is true when the OCI registry answered its /v2/ probe.
pkgbodyboolean—Pkg is true when the npm registry answered its ping.
pkgHostbodystring—PkgHost is the npm registry host.
realmbodystring—Realm is the token endpoint the OCI registry's challenge advertises, present only when the registry is reachable and auth-gated.
servicebodystring—Service is the token service name from the same challenge.

Failure carries the platform error shape — see Errors.

Examples

hanzo registry status
import { Configuration, RegistryApi } from 'hanzoai';

const api = new RegistryApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getRegistryStatus();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import RegistryApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = RegistryApi(client).get_registry_status()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.RegistryAPI.GetRegistryStatus(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, registry_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = registry_api::get_registry_status(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.RegistryApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new RegistryApi(client).getRegistryStatus();
curl https://api.hanzo.ai/v1/registry/status \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool registry, op get_registry_status — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "registry",
         "arguments": {
           "op": "get_registry_status",
           "input": {}
         }
       }
     }'

Registry API · All Hanzo APIs · Interactive reference

Was this page useful?