# Client API: Help

> The docs site's guides for a page of the dashboard, and a search over them.

Source: https://www.coritan.com/docs/api/reference/client/help/

The docs site's guides for a page of the dashboard, and a search over them. Needs no auth.

Base URL: `https://api.coritan.com/api/v1`. Paths below are complete.

To try these requests in the browser, open the [interactive Client API reference](https://api.coritan.com/docs).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/help/changelog`](#op-get-api-v1-help-changelog) | List the newest changes from the changelog on the docs site |
| GET | [`/api/v1/help/pages`](#op-get-api-v1-help-pages) | List the guides for a page of the dashboard |
| GET | [`/api/v1/help/search`](#op-get-api-v1-help-search) | Search the guides on the docs site |

### List the newest changes from the changelog on the docs site {#op-get-api-v1-help-changelog}

`GET /api/v1/help/changelog`

List the newest changes from the changelog on the docs site. No sign-in needed.

The changelog has a page for each month. Under each date, every change
has a title and a paragraph that describes it. The answer lists those
changes newest first, up to `limit`. Each has its `date` as `YYYY-MM-DD`,
its `title`, its paragraph as plain text in `summary`, and its `url`: the
change in the changelog on the docs site, which links the guide that
covers it.

`docs_url` is the docs site's home page and `changelog_url` is the
changelog's first page. The changes and their addresses are those of the
storefront the request came through; on a storefront with no docs site,
both are null and the list is empty.

Refuses with 422 when `limit` is below 1 or above 100.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer | no | The most changes to list, from 1 to 100. The answer lists 20 when it is left out. Default: `20`. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type | Description |
| --- | --- | --- |
| `docs_url` | string or null | The docs site's home page. Null when this storefront has no docs site. |
| `changelog_url` | string or null | The changelog's first page on the docs site. Null when this storefront has no docs site or its docs have no changelog. |
| `entries` | array of HelpChangelogEntry | The changes, newest first, up to `limit`. |
| `entries[].date` | string | The day of the change, as `YYYY-MM-DD`. |
| `entries[].title` | string | What changed, in a few words. |
| `entries[].summary` | string | The paragraph that describes the change, as plain text. |
| `entries[].url` | string | The change in the changelog on the docs site, such as `https://www.coritan.com/docs/changelog/september-2026/#whois-privacy-starts-on`. |

### List the guides for a page of the dashboard {#op-get-api-v1-help-pages}

`GET /api/v1/help/pages`

List the guides for a page of the dashboard. No sign-in needed.

Send the path of the page the customer is on as `route`. The answer lists
up to eight guides from the docs site, most specific first: the guides
written for that page, then the guides for the pages above it. For a
folder open in a server's file manager, that is the guides for the Files
tab, then those for the servers list, then those for the dashboard.

On a resource's Overview, a path such as
`/dashboard/websites/example.com/overview`, the tutorials that name the
resource's list or a page under it come first, then the other guides in
that order. A tutorial takes a customer from a new resource to a working
result.

Each guide has its `title`, a one-sentence `description`, its `url` on
the docs site, its `type` and the `section` of the docs it is in.
`docs_url` is the docs site's home page. The guides and their addresses
are those of the storefront the request came through; on a storefront
with no docs site, `docs_url` is null and the list is empty.

Refuses with 422 when `route` is missing, does not start with `/`, or is
longer than 512 characters.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `route` | query | string | yes | The path of the dashboard page the customer is on, such as `/dashboard/servers/1f2e3d4c/files`. A query string is ignored. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type | Description |
| --- | --- | --- |
| `route` | string | The dashboard path the guides are for, without its query string. |
| `docs_url` | string or null | The docs site's home page. Null when this storefront has no docs site. |
| `pages` | array of HelpPage | Up to eight guides, most specific first. On a resource's Overview, the tutorials for its area come first. |
| `pages[].title` | string | The guide's title. |
| `pages[].description` | string | One sentence on what the guide helps with. |
| `pages[].url` | string | The guide on the docs site, such as `https://www.coritan.com/docs/managed-containers/files/`. |
| `pages[].type` | string | The kind of guide: `overview`, `concept`, `how-to`, `tutorial`, `reference` or `troubleshooting`. |
| `pages[].section` | string | The section of the docs the guide is in, as the docs site names it, such as `Container Apps`. |

### Search the guides on the docs site {#op-get-api-v1-help-search}

`GET /api/v1/help/search`

Search the guides on the docs site. No sign-in needed.

Answers with up to eight guides for the words in `q`, best match first,
each in the same shape as `GET /api/v1/help/pages` gives. A guide matches
when every word appears in it, and the last word also matches the start
of a longer word, so the results can follow the customer's typing. A
match in a title counts most. An empty `q` answers an empty list.

The API reference is not searched here: `search_url` opens the same
search on the docs site, which includes it. The guides are those of the
storefront the request came through.

Refuses with 422 when `q` is longer than 200 characters.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `q` | query | string | no | The words to search for. The last word also matches the start of a longer word. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type | Description |
| --- | --- | --- |
| `query` | string | The words searched for. |
| `docs_url` | string or null | The docs site's home page. Null when this storefront has no docs site. |
| `search_url` | string or null | The same search on the docs site, which also searches the API reference. Null when this storefront has no docs site. |
| `pages` | array of HelpPage | Up to eight guides, best match first. |
| `pages[].title` | string | The guide's title. |
| `pages[].description` | string | One sentence on what the guide helps with. |
| `pages[].url` | string | The guide on the docs site, such as `https://www.coritan.com/docs/managed-containers/files/`. |
| `pages[].type` | string | The kind of guide: `overview`, `concept`, `how-to`, `tutorial`, `reference` or `troubleshooting`. |
| `pages[].section` | string | The section of the docs the guide is in, as the docs site names it, such as `Container Apps`. |