# List pages

URL: https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-repos-by-repo-pages

> Returns the repo's Pages status, live URL, custom domain and build source.

`GET /v1/provider/github/repos/{repo}/pages`

> [Provider →](https://docs.hanzo.ai/docs/openapi/provider) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                              |
| ------------- | ------------------------------------------------------------ |
| **Address**   | `https://api.hanzo.ai/v1/provider/github/repos/{repo}/pages` |
| **Method**    | `GET`                                                        |
| **Operation** | `get_provider_github_repos_by_repo_pages`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                       |

Returns the repo's Pages status, live URL, custom domain and build
source. The repo is resolved against the org installation's GRANTED set, so a
caller can never address a repo the App was not granted; 404 when the repo has no
Pages site.

## Request

1 field.

| Field  | In   | Type   | Required | Description                                                                                                                           |
| ------ | ---- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `repo` | path | string | yes      | Repo is the repository's short name within the org's installation, with no owner prefix (the owner is server-derived from the grant). |

## Response

| Status    | Body                     | Meaning |
| --------- | ------------------------ | ------- |
| `200`     | provider.githubPagesView | ok      |
| `default` | problem-details          | refused |

`200` body — 10 fields.

| Field           | In   | Type                       | Always | Description                                                              |
| --------------- | ---- | -------------------------- | ------ | ------------------------------------------------------------------------ |
| `buildType`     | body | string                     | —      | BuildType is the builder in use: "legacy" (branch source) or "workflow". |
| `cname`         | body | string                     | —      | CNAME is the custom domain, absent when none is set.                     |
| `custom404`     | body | boolean                    | —      | Custom404 is whether the repo ships its own 404 page.                    |
| `httpsEnforced` | body | boolean                    | —      | HTTPSEnforced is GitHub's enforce-HTTPS bit.                             |
| `repo`          | body | string                     | —      | Repo is the repository the site belongs to.                              |
| `source`        | body | provider.githubPagesSource | —      |                                                                          |
| `source.branch` | body | string                     | —      | Branch is the branch the site builds from.                               |
| `source.path`   | body | string                     | —      | Path is the directory within that branch: "/" or "/docs".                |
| `status`        | body | string                     | —      | Status is GitHub's build state: "built", "building" or "errored".        |
| `url`           | body | string                     | —      | URL is the live site (GitHub's html\_url).                               |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo provider github repos pages get <repo>
```

**SDK**

**.ts**

```ts
import { Configuration, ProviderApi } from 'hanzoai';

const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProviderGithubReposByRepoPages({ repo: 'repo' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).get_provider_github_repos_by_repo_pages(repo='repo')
```

**.go**

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

resp, _, err := client.ProviderAPI.GetProviderGithubReposByRepoPages(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, provider_api};

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

let result = provider_api::get_provider_github_repos_by_repo_pages(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;

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

var result = new ProviderApi(client).getProviderGithubReposByRepoPages();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/provider/github/repos/<repo>/pages \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **provider** through the `provider` tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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_connections"
         }
       }
     }'
```

---

[Provider API](https://docs.hanzo.ai/docs/openapi/provider) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)