List status

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…

GET /v1/registry/status

Registry → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/registry/status`
Method	`GET`
Operation	`get_registry_status`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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.

Request

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

Response

Status	Body	Meaning
`200`	registryStatus	ok

200 body — 6 fields.

Field	In	Type	Always	Description
`host`	body	string	—	Host is the OCI registry host clients push to and pull from.
`oci`	body	boolean	—	Oci is true when the OCI registry answered its /v2/ probe.
`pkg`	body	boolean	—	Pkg is true when the npm registry answered its ping.
`pkgHost`	body	string	—	PkgHost is the npm registry host.
`realm`	body	string	—	Realm is the token endpoint the OCI registry's challenge advertises, present only when the registry is reachable and auth-gated.
`service`	body	string	—	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 := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.RegistryAPI.GetRegistryStatus(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::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.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + 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

Request

Response

Examples

On this page