---
title: "Return WordPress disk quota status"
method: GET
path: "/WPX/has_reached_quota"
tags: ["WPX"]
---

# Return WordPress disk quota status

`GET /WPX/has_reached_quota`

## Request

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

This function reports whether the caller's disk usage is already at or
near the limit that would block a new WordPress installation. The check
reserves headroom for the install itself, so it can report `1` before the
account has actually exceeded its quota.

  **Note:**

  - The onboarding flow calls this up front, before it offers to install
    WordPress, so it can explain the refusal instead of failing partway
    through `create_website`.
  - This function takes no parameters and has no failure path of its own,
    beyond the `wp-toolkit` feature that every function in this module
    needs. A caller that holds the feature always gets a successful status.
  - `create_website` repeats the same check and refuses with an error when
    the quota blocks the install.

## Response `200`

The 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: The quota verdict for the caller's account.
      - `has_reached_quota` 1 | 0: Whether the account has too little free disk space for a new WordPress installation. - `1` - The account cannot fit another installation. - `0` - The account has room for another installation.
    - `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. - `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/has_reached_quota/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)