STANDARD STARTER CONTRACT / gateway-timeout
Gateway timeout
A server acting as a gateway or proxy did not receive a timely response from an upstream server needed to complete the request.
HTTP 504
Canonical type URI
https://errors.ctrlbox.dev/problems/gateway-timeoutThis stable URI identifies the problem type, not a particular occurrence.
What to do next
- Check operation state before retrying: a timeout does not prove that an upstream write failed.
HTTP response contract
Set the actual HTTP status to 504 and Content-Type: application/problem+json. The JSON status below must agree with the actual response status.
RFC-defined members
- type
- The canonical URI above; clients use it as the primary problem identifier.
- title
- Gateway timeout — a stable human-readable summary (localization is permitted).
- status
- 504 — advisory in the body; it does not set the HTTP status.
- detail
- A safe explanation specific to this occurrence. Clients should not parse it for machine decisions.
- instance
- An optional URI reference identifying a specific occurrence. It need not resolve; avoid sensitive identifiers.
These five members are defined by RFC 9457. This template includes type, title, status, and detail in its samples; RFC 9457 does not require all five.
Custom extension fields
This definition declares no custom extensions.
Extensions belong to this type’s contract. Consumers must ignore extensions they do not recognize.
Example response body
Illustrative occurrence data. Construct the response manually in your application or automation.
Example
{
"type": "https://errors.ctrlbox.dev/problems/gateway-timeout",
"title": "Gateway timeout",
"status": 504,
"detail": "A server acting as a gateway or proxy did not receive a timely response from an upstream server needed to complete the request."
}Keep established public type URIs stable. The names here are template conventions, not an RFC catalogue. Read the response guide for manual setup and standards references.