---
title: GET /api/v1/instances
description: List Instances
locale: en
version: 0.2.0
canonical: https://enterium-developer-docs.pages.dev/developers/api/instances/get-instances/
---

> Documentation index: https://enterium-developer-docs.pages.dev/developers/llms.txt — every page of this portal has a Markdown twin at <route>.md; the frozen API contract is at https://enterium-developer-docs.pages.dev/developers/api/openapi.json.

:::note
Generated from the OpenAPI contract — do not edit by hand. Interactive explorer with full schemas: [https://entherium.duckdns.org:8443/reference](https://entherium.duckdns.org:8443/reference); frozen spec for this build: [openapi.json](/developers/api/openapi.json). Group: [instances](../).
:::

List Instances

**Auth:** `Authorization: Bearer <token>` required

## Request

```sh
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/instances" \
  -H "Authorization: Bearer <token>"
```

## Response `200`

The contract carries no example for this response; schema: `array of HugoInstanceRead`. Field-level shape: [interactive explorer](https://entherium.duckdns.org:8443/reference).

## Returns

`array of HugoInstanceRead` — Successful Response

| Field | Type | Description |
| --- | --- | --- |
| `attached_sc` | `integer \| null` (opt.) |  |
| `backend` | `"gcs" \| "local-fs" \| "wp"` (opt.) |  |
| `base_url` | `string \| null` (opt.) |  |
| `caption` | `string \| null` (opt.) |  |
| `createtime` | `string` |  |
| `gcs_bucket` | `string \| null` (opt.) |  |
| `guid` | `integer` |  |
| `hostname` | `string \| null` (opt.) |  |
| `instance_id` | `string` |  |
| `is_active` | `boolean` (opt.) |  |
| `last_build_at` | `string \| null` |  |
| `last_publish_at` | `string \| null` |  |
| `owner` | `integer \| null` (opt.) |  |
| `posts_count` | `integer` |  |
| `registry` | `object` (opt.) |  |
| `rsid` | `integer` |  |
| `template_dir` | `string \| null` (opt.) |  |
| `theme_repo` | `string \| null` (opt.) |  |
| `theme_sha` | `string \| null` (opt.) |  |
| `tier` | `"prod" \| "dev" \| "test" \| "staging"` (opt.) |  |
| `updatedby` | `integer \| null` (opt.) |  |
| `updatetime` | `string` |  |
| `vps_ip` | `string \| null` (opt.) |  |
| `vps_port` | `integer \| null` (opt.) |  |
| `warmup_state` | `"cold" \| "warming" \| "warm"` |  |

## Parameters

None.

## Errors

| Code | Meaning | Body |
| --- | --- | --- |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |

Every error body is `{detail, code?, request_id, doc_url}` — `request_id` is the value to quote, `doc_url` points at the [Errors reference](../../../reference/errors/).