---
title: "Get account overview"
method: GET
path: "/platform/overview"
tags: ["Platform"]
---

# Get account overview

`GET /platform/overview`

## Request

- Base URL: `https://api.imprezahost.com/v1`
- URL: `https://api.imprezahost.com/v1/platform/overview`
- Auth: API key in header `X-API-Key` and API key in header `X-API-Secret`

One read-only call that situates a caller with no prior history:
servers (agent id, version, state), apps and environments, domains,
open alerts, recent deployment failures (scrubbed signatures) and
the suggested next actions with the exact tool to call. When the
credential is a subcredential with a resource allowlist, every
section is filtered to it and each affected section carries
filtered: {section, showing, of}. No metrics, no logs, no write
actions, no addresses or e-mails.

## Response `200`

The overview envelope (servers, apps, environments, domains, open_alerts, recent_failures, next_steps, filtered).

## Other responses

- `401`: Client identity missing.
- `403`: Missing permission.

---

[API](https://skmtc.dev/imprezahost/apis/impreza-host-public-api.md) · [All operations](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/revisions/db86511f604f?raw)