Service

Get the aggregate platform and dependency status

Changed on

Square Cloud's overall status, the health of each Square Cloud service, and the current status of the external providers the platform depends on.

status on each entry is one of operational, degraded, outage, maintenance or unknown. unknown means the check could not be verified and is NOT evidence of an outage (some providers publish no status API, so their health cannot always be confirmed).

summary is present only when an entry is not operational, where it explains what is wrong and what it affects. A healthy entry carries no summary, because the status already says it.

Only Square Cloud's own services and its own status page influence the top-level status: a third-party incident is reported under dependencies without flipping the platform badge. Entries are ordered by blast radius.

The top-level status is maintenance when a maintenance is the only thing going on; any instability or outage makes it degraded. incidents lists what is open on the status page right now (maintenance windows and incidents, newest first, each with its latest update) and components lists every status page component that is not operational, such as a cluster. Both are empty arrays when there is nothing to report.

Served from a document refreshed every 5 minutes; stale: true means that document was unavailable and the payload was probed live instead.

get/v2/service/status

Request

Response

Current status. status/message describe Square Cloud itself, services are Square-run, dependencies are third parties.

status'online' | 'maintenance' | 'degraded' | 'unknown' required

unknown means the check itself could not run; it is not evidence of an outage.

messagestring required
checked_atstring date-time
staleboolean
servicesobject
dependenciesobject

Changes

    • warning

      added the new maintenance enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status

    • warning

      added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status