Returns one site — the same row ListSites carries, for one slug.

Returns one site — the same row ListSites carries, for one slug. Every sub-resource under a site already answered: deployments, releases, publish.

GET /v1/projects/sites/{slug}

Projects → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/projects/sites/{slug}`
Method	`GET`
Operation	`get_projects_sites_by_slug`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one site — the same row ListSites carries, for one slug.

Every sub-resource under a site already answered: deployments, releases, publish. The site itself did not, and a route that is never registered answers 404 for a LIVE site exactly as it does for one that was never created. So the one call a client makes to ask "is it there yet?" could only ever say no, and a CI lane watching for its own publish would wait forever on a success it had already achieved.

The org is the caller's, never a path segment. A slug is unique within an org and two orgs may both own tel; taking the org from the validated principal instead of the URL means a caller cannot read another org's site by editing a path, and it is the same scope ListProjects and ListSites already use.

A site that exists but is not live is NOT found here, matching ListSites, which keeps only live rows so a draft or a failed build is never advertised as a site. One definition of "is a site", used by both.

Request

1 field.

Field	In	Type	Required	Description
`slug`	path	string	yes	Slug is the project to act on, from the path.

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.getProjectsSitesBySlug({ slug: 'slug' });

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_by_slug(slug='slug')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.ProjectsAPI.GetProjectsSitesBySlug(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_by_slug(&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).getProjectsSitesBySlug();

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/<slug> \
  -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"
         }
       }
     }'

Projects API · All Hanzo APIs · Interactive reference

Returns one site — the same row ListSites carries, for one slug.

Request

Response

Examples

On this page