---
title: "Get the appliance hardware specs"
method: GET
path: "/api/v1/appliance/specs"
tags: ["System"]
---

# Get the appliance hardware specs

`GET /api/v1/appliance/specs`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/appliance/specs`
- Auth: none required

Returns the CPU, memory, disks and data filesystem of the host, as reported by the orkestrator. Anonymous until the instance is enrolled, then a badge is required. The CPU, memory and disks are only returned to a caller who may read the control plane. Answers 501 when the orkestrator does not provide them.

## Response `200`

OK

- ApplianceSpecs: ApplianceSpecs schema
  - `cpu` object, nullable
    - `count` integer
    - `model` string, nullable
  - `data` object
    - `free_bytes` integer
    - `fs_type` string
    - `persistent` boolean
    - `size_bytes` integer
  - `disks` object[], nullable
    - `model` string, nullable
    - `name` string
    - `size_bytes` integer
  - `memory` object, nullable
    - `available_bytes` integer
    - `total_bytes` integer
  - `warnings` string[]

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `500`: Internal Server Error _(panics)_
- `default`

---

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