---
title: "Return WordPress installation"
method: GET
path: "/WPX/get_website"
tags: ["WPX"]
---

# Return WordPress installation

`GET /WPX/get_website`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/WPX/get_website`
- Auth: HTTP basic

This function returns a single WordPress installation, addressed by its
numeric WordPress Toolkit instance `id` parameter. The returned row is
identical to one element of the `list_websites` response, so the same
consumer mapping works for both.

  **Note:**

  - This is a lightweight by-id read intended for resolving one
    installation directly, without listing every installation. A direct
    lookup is not subject to the brief eventual-consistency lag that can
    keep a freshly created installation out of `list_websites`.
  - A valid `id` parameter that does not exist, or that belongs to another
    account, is **not** an error: the call succeeds with an empty (`null`)
    `data` field. An installation owned by another account is
    indistinguishable from one that does not exist.
  - A missing or non-integer `id` parameter, or a backend failure, returns
    a failure status with a message in the `errors` field.

## Query parameters

- `id` integer, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The name of the method called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` object, nullable: The installation row, or `null` when no installation with the given `id` value is owned by the caller.
      - `admin_url` string: The WordPress administrator login URL.
      - `alive` 1 | 0: Whether the installation is responding.
      - `broken` 1 | 0: Whether WordPress Toolkit reports the installation as broken.
      - `documentroot` string: The filesystem path to the WordPress root.
      - `domain` string: The normalized bare hostname of the site.
      - `infected` 1 | 0: Whether WordPress Toolkit reports the installation as infected.
      - `outdated_php` 1 | 0: Whether the installation runs an outdated PHP version.
      - `outdated_wp` 1 | 0: Whether the installation runs an outdated WordPress version.
      - `title` string: The WordPress site title. May be empty.
      - `unsupported_php` 1 | 0: Whether the installation runs an unsupported PHP version.
      - `unsupported_wp` 1 | 0: Whether the installation runs an unsupported WordPress version.
      - `url` string: The public site URL.
      - `version` string: The WordPress version. May be empty if unknown.
      - `wptk_id` integer, nullable: The WordPress Toolkit instance id. This is `null` when the upstream record carries no id. Guard against that before you send the value to a function that takes an `id` parameter, because WordPress Toolkit ids are positive integers and there is no valid `0`.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `status` 1 | 0: - `1` - Success. A found installation, or an empty (`null`) `data` when no such installation exists. - `0` - Failed: Check the errors field for more details.
    - `warnings` string[], nullable: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

## Changes

- **2026-09-23** `aed66b1a51cc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/WPX/get_website/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)