---
title: "Get host"
method: GET
path: "/v1/hosts/{host_id}"
tags: ["Host"]
---

# Get host

`GET /v1/hosts/{host_id}`

## Request

- Base URL: `http:////localhost:3000`
- URL: `http:////localhost:3000/v1/hosts/{host_id}`
- Auth: none declared

Returns information about a particular host in the cluster.

## Path parameters

- `host_id` string, required

## Response `200`

OK response.

- Host
  - `client_addresses` string[], required: The addresses that this host advertises to client applications.
  - `cohort` HostCohort
    - `control_available` boolean, required: Indicates if the host is a control node in the cohort.
    - `member_id` string, required: The member ID of the host within the cohort.
    - `type` string, required: The type of cohort that the host belongs to.
  - `cpus` integer: The number of CPUs on this host.
  - `data_dir` string, required: The data directory for the host.
  - `default_pgedge_version` PgEdgeVersion
    - `postgres_version` string, required: The Postgres major and minor version.
    - `spock_version` string, required: The Spock major version.
    - `stability` 'stable' | 'rc' | 'beta' | 'dev' | 'deprecated': Release stability of the manifest image backing this version. Only `stable` is selected automatically for a new database; `stable`, `rc`, and `deprecated` may be applied as an explicit image upgrade; `beta` and `dev` are opt-in for new databases only. `dev` is a mutable tag whose contents can change under a running deployment. May be absent for hosts that do not report it.
  - `etcd_mode` 'server' | 'client': The etcd mode for this host.
  - `id` string, required: Unique identifier for the host.
  - `memory` string: The amount of memory available on this host.
  - `orchestrator` string, required: The orchestrator used by this host.
  - `peer_addresses` string[], required: The addresses that this host advertises to other hosts.
  - `status` HostStatus, required
    - `components` object, required: The status of each component of the host.
    - `state` 'healthy' | 'unreachable' | 'degraded' | 'unknown', required
    - `updated_at` string, date-time, required: The last time the host status was updated.
  - `supported_pgedge_versions` PgEdgeVersion[]: The PgEdge versions supported by this host.
    - `postgres_version` string, required: The Postgres major and minor version.
    - `spock_version` string, required: The Spock major version.
    - `stability` 'stable' | 'rc' | 'beta' | 'dev' | 'deprecated': Release stability of the manifest image backing this version. Only `stable` is selected automatically for a new database; `stable`, `rc`, and `deprecated` may be applied as an explicit image upgrade; `beta` and `dev` are opt-in for new databases only. `dev` is a mutable tag whose contents can change under a running deployment. May be absent for hosts that do not report it.

## Other responses

- `400`: Bad Request response.
- `404`: Not Found response.
- `409`: Conflict response.
- `500`: Internal Server Error response.
- `default`: Unexpected error response

---

[API](https://skmtc.dev/pgedge/apis/pgedge-control-plane-v1-api.md) - [All operations](https://skmtc.dev/pgedge/apis/pgedge-control-plane-v1-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pgedge/apis/pgedge-control-plane-v1-api/revisions/34e82976a4b2?raw)
