---
title: "A connected site's information, menus, theme (and parent), plugin and theme inventory with updates, and health (Site Health, PHP, error log tail without secrets), as far as the connection's scopes allow (Hostingsurge Connector only)"
method: GET
path: "/wordpress/connections/{connectionId}/overview"
tags: ["WordPress"]
---

# A connected site's information, menus, theme (and parent), plugin and theme inventory with updates, and health (Site Health, PHP, error log tail without secrets), as far as the connection's scopes allow (Hostingsurge Connector only)

`GET /wordpress/connections/{connectionId}/overview`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/wordpress/connections/{connectionId}/overview`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `connectionId` string, uuid, required

## Response `200`

Overview

- object
  - `connectionId` string, uuid, required
  - `site` object, nullable, required
    - `name` string, required
    - `description` string, required
    - `homeUrl` string, required
    - `siteUrl` string, required
    - `adminUrl` string, required
    - `restUrl` string, required
    - `wordpressVersion` string, required
    - `phpVersion` string, required
    - `locale` string, required
    - `timezone` string, required
    - `permalinkStructure` string, required
    - `multisite` boolean, required
    - `https` boolean, required
    - `environment` string, required
    - `counts` object, required
      - `pages` number, required
      - `pageDrafts` number, required
      - `posts` number, required
      - `postDrafts` number, required
    - `theme` object, required
      - `name` string, required
      - `stylesheet` string, required
    - `connector` object, required
      - `version` string, required
      - `scopes` string[], required
      - `pairedAt` string, required
      - `user` object, nullable, required
        - `id` number, required
        - `login` string, required
        - `displayName` string, required
  - `menus` object, nullable, required
    - `menus` object[], required
      - `id` number, required
      - `name` string, required
      - `locations` string[], required
      - `truncated` boolean, required
      - `items` object[], required
        - `id` number, required
        - `title` string, required
        - `url` string, required
        - `type` string, required
        - `object` string, required
        - `objectId` number, required
        - `parent` number, required
        - `order` number, required
    - `locations` object[], required
      - `location` string, required
      - `description` string, required
      - `menuId` number, nullable, required
  - `theme` object, nullable, required
    - `active` object, required
      - `name` string, required
      - `stylesheet` string, required
      - `template` string, required
      - `version` string, required
      - `author` string, required
      - `requiresWordPress` string, required
      - `requiresPhp` string, required
      - `textDomain` string, required
    - `isChildTheme` boolean, required
    - `parent` object, nullable, required
      - `name` string, required
      - `stylesheet` string, required
      - `template` string, required
      - `version` string, required
      - `author` string, required
      - `requiresWordPress` string, required
      - `requiresPhp` string, required
      - `textDomain` string, required
    - `blockTheme` boolean, required
    - `hasThemeJson` boolean, required
    - `customCssBytes` number, required
    - `supports` string[], required
  - `inventory` object, nullable, required
    - `core` object, required
      - `version` string, nullable, required
      - `updateVersion` string, nullable, required
    - `plugins` object[], required
      - `file` string, required
      - `slug` string, required
      - `name` string, required
      - `version` string, required
      - `active` boolean, required
      - `networkActive` boolean
      - `updateVersion` string, nullable, required
      - `autoUpdate` boolean
      - `requiresPhp` string
    - `mustUsePlugins` object[]
      - `file` string, required
      - `name` string, required
      - `version` string, required
    - `dropIns` string[]
    - `themes` object[], required
      - `stylesheet` string, required
      - `name` string, required
      - `version` string, required
      - `active` boolean, required
      - `parent` string, nullable
      - `updateVersion` string, nullable, required
      - `autoUpdate` boolean
    - `checkedAt` string, nullable: ISO-8601 timestamp
  - `health` object, nullable, required
    - `php` object, required
      - `version` string, nullable, required
      - `sapi` string
      - `memoryLimit` string
      - `maxExecutionTime` number
      - `uploadMaxFilesize` string
      - `extensions` string[]
    - `wordpress` object, required
      - `version` string, nullable, required
      - `debug` boolean
      - `debugLog` boolean
      - `debugDisplay` boolean
      - `disallowFileEdit` boolean
      - `cronDisabled` boolean
      - `objectCache` boolean
      - `memoryLimit` string
      - `https` boolean
      - `environment` string
    - `siteHealth` object, required
      - `available` boolean, required
      - `tests` object[], required
        - `test` string, required
        - `status` 'good' | 'recommended' | 'critical' | 'error', required
        - `label` string, required
        - `badge` string
        - `description` string, required
      - `skipped` number
    - `errorLog` object, required
      - `available` boolean, required
      - `source` string, nullable, required
      - `lines` string[], required
      - `fatalErrors` number, required
      - `sizeBytes` number, required
  - `missing` object[], required
    - `part` 'site' | 'menus' | 'theme' | 'inventory' | 'health', required
    - `reason` string, required
  - `readAt` string, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `402`: A paid add-on (code upgrade_required)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited)
- `501`: Not available on this server (code not_configured)
- `503`: The site or the engine did not answer (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)