Returns the org's deployed sites at the pretty URLs they serve at.
Returns the org's deployed sites at the pretty URLs they serve at.
GET /v1/projects/sites
| Address | https://api.hanzo.ai/v1/projects/sites |
| Method | GET |
| Operation | get_projects_sites |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the org's deployed sites at the pretty URLs they serve at.
It reads the SAME org-scoped store as /v1/projects and keeps only the projects
that are actually live, so a draft or a failed build is not advertised as a
site.
Scope: a validated principal is required (403 without one) and the list is keyed by that principal's org.
Request
GET /v1/projects/sites takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | projectsSite[] | ok |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
[].name | body | string | — | Name is the site's display name. |
[].slug | body | string | — | Slug is the site's handle — also the label of the host it serves at. |
[].status | body | string | — | Status is the project's state behind the site — whether it is serving, still building, or failed its last build. |
[].updatedAt | body | integer | — | UpdatedAt is when the project last changed, as Unix seconds. |
[].url | body | string | — | URL is the pretty address readers use, not the object-store path behind it. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, ProjectsApi } from 'hanzoai';
const api = new ProjectsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProjectsSites();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProjectsApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProjectsApi(client).get_projects_sites()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ProjectsAPI.GetProjectsSites(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, projects_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = projects_api::get_projects_sites(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProjectsApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new ProjectsApi(client).getProjectsSites();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/projects/sites \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches projects through the projects tool, which names its 48 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_projects"
}
}
}'How is this guide?