> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get service status

> Check the overall health of the Square Cloud platform with GET /v2/service/status. It is public, needs no API key and is served from a 5-minute cache.

Service Status returns the aggregate health of the Square Cloud platform, the same signal that powers the public status page and internal alerting. It's a public route with no API key required, which makes it a good fit for automated uptime checks or a small status widget on your own site.

The payload is served from a 5-minute cache, so it can lag a transient incident by up to that window and should not be treated as a live incident feed. If the cached value can't be read, the endpoint still responds successfully with `status: "unknown"` instead of failing the request.

For per-application health instead of the whole platform, see [Get Application Status](/en/api-reference/endpoint/apps/status) or [Get All Applications Status](/en/api-reference/endpoint/apps/status-all).

<Info>
  This route has a 5-minute cache and does not reflect the real-time status of
  status.squarecloud.app.
</Info>

## Response

<ResponseField name="status" type="string">
  The current status of Square Cloud, with `online` indicating the service is online, `degraded` indicating issues, and `unknown` indicating unavailable.
</ResponseField>

<ResponseField name="message" type="string">
  Message about the current status of Square Cloud services.
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
      "status": "online",
      "message": "All services are online."
  }
  ```
</ResponseExample>

## Related

* CLI: [`squarecloud status`](/en/cli-reference/global-flags-and-ci#squarecloud-status)
* SDKs: [`api.service.status()`](/en/sdks/js/client) (JavaScript), [`client.service.status()`](/en/sdks/py/client) (Python), [`c.Service.Status()`](/en/sdks/go/client) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.