{"openapi":"3.0.3","info":{"title":"#GoFile service status API","version":"1","description":"Live status of HMRC's Corporation Tax, VAT and Income Tax services, Companies House, and #GoFile's own systems. Updated every two minutes. Read-only, no authentication, CORS enabled, cached for 30 seconds. Nothing identifies a customer or a filing. Fields are only ever added within version 1.","contact":{"name":"#GoFile support","url":"https://secure.gofile.co.uk/support/"}},"servers":[{"url":"https://status.gofile.co.uk"}],"paths":{"/api/v1/summary.json":{"get":{"summary":"Overall state and one state per component","operationId":"getSummary","responses":{"200":{"description":"The summary","headers":{"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer"},"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"overall":{"type":"string","enum":["operational","degraded","outage","maintenance","external","unknown"],"description":"#GoFile's own state; external = an HMRC or Companies House service is impaired while #GoFile is fine"},"overall_label":{"type":"string"},"headline":{"type":"string"},"message":{"type":"string"},"own_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"external_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"summary":{"type":"string"},"components":{"type":"object","additionalProperties":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]}},"active_incidents":{"type":"integer"},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}}}}},"304":{"description":"Not modified"}}}},"/api/v1/status.json":{"get":{"summary":"The full status payload","operationId":"getStatus","responses":{"200":{"description":"The full payload","headers":{"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer"},"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"overall":{"type":"object","properties":{"state":{"type":"string","enum":["operational","degraded","outage","maintenance","external","unknown"],"description":"#GoFile's own state; external = an HMRC or Companies House service is impaired while #GoFile is fine"},"label":{"type":"string"},"headline":{"type":"string"},"message":{"type":"string","description":"Customer-facing service message; empty when all clear"},"own_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"external_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"summary":{"type":"string"}}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["hmrc","ch","gofile"]},"name":{"type":"string"},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"components":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","enum":["filing","api","ch_api","ch_filing","app","db","crons","email"]},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"since":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"headline":{"type":"string"},"metrics":{"type":"object","description":"Depends on kind. Counts are buckets, rates are percentages.","properties":{"resolved_share_24h":{"type":["integer","null"],"description":"Filing services: share of filings that reached HMRC in the last 24 hours and have any HMRC result"},"held_unresolved":{"type":"string","enum":["none","some","several","many"],"description":"Filing services: filings left without a final HMRC result (held or ambiguous) and awaiting reconciliation, last 7 days"},"poller_late":{"type":"boolean","description":"true while our own result checks are late; the component is then unknown"},"waiting_over_2h":{"type":"string","enum":["none","some","several","many"]},"accept_median_minutes_24h":{"type":["integer","null"]},"accept_p90_minutes_24h":{"type":["integer","null"]},"timing_sample_ok":{"type":"boolean"},"error_rate_15m":{"type":["integer","null"]},"no_response_15m":{"type":"string","enum":["none","some","several","many"]},"submit_failures_60m":{"type":"string","enum":["none","some","several","many"]},"response_ms":{"type":["integer","null"]},"query_ms":{"type":["integer","null"]},"late":{"type":"array","items":{"type":"string"}},"backlog":{"type":"string","enum":["none","some","several","many"]}},"additionalProperties":true},"maintenance_until":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"incident_ids":{"type":"array","items":{"type":"integer"}},"uptime_pct":{"type":["number","null"],"description":"null until seven days of history exist"},"uptime_days":{"type":"integer"},"monitoring_since":{"type":["string","null"],"format":"date"},"uptime_90d":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown","nodata"]}}}},"hmrc_notice":{"type":"object","properties":{"planned_downtime":{"type":["string","null"]},"service_issues":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"url":{"type":"string"}}}}}}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"source":{"type":"string","enum":["auto","manual"]},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"impact":{"type":"string","enum":["degraded","outage","maintenance"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"started_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"updates":{"type":"array","description":"Newest first","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"body":{"type":"string"}}}}}}},"maintenance":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","enum":["govuk","gofile"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"start":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"end":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"active":{"type":"boolean"},"raw":{"type":["string","null"],"description":"HMRC's own wording of the window"},"url":{"type":["string","null"]}}}},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}}}}},"304":{"description":"Not modified"}}}},"/api/v1/incidents.json":{"get":{"summary":"Incidents and maintenance windows","operationId":"getIncidents","responses":{"200":{"description":"Incidents and windows","headers":{"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer"},"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"source":{"type":"string","enum":["auto","manual"]},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"impact":{"type":"string","enum":["degraded","outage","maintenance"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"started_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"updates":{"type":"array","description":"Newest first","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"body":{"type":"string"}}}}}}},"maintenance":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","enum":["govuk","gofile"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"start":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"end":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"active":{"type":"boolean"},"raw":{"type":["string","null"],"description":"HMRC's own wording of the window"},"url":{"type":["string","null"]}}}},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}}}}},"304":{"description":"Not modified"}}}},"/api/v1/history.json":{"get":{"summary":"Per-component daily history for 90 days","operationId":"getHistory","responses":{"200":{"description":"History","headers":{"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"days":{"type":"integer"},"components":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"uptime_pct":{"type":["number","null"]},"days":{"type":"array","items":{"type":"object"}}}}},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}}}}},"304":{"description":"Not modified"}}}},"/feed.atom":{"get":{"summary":"Atom feed of incidents and maintenance windows","operationId":"getFeed","responses":{"200":{"description":"Atom 1.0","content":{"application/atom+xml":{"schema":{"type":"string"}}}}}}},"/badge.svg":{"get":{"summary":"SVG badge for one component or the overall state","operationId":"getBadge","parameters":[{"name":"component","in":"query","required":false,"schema":{"type":"string","enum":["hmrc_ct","hmrc_vat","hmrc_itsa","hmrc_paye","ch_api","ch_filing","gofile_app","gofile_db","gofile_crons","gofile_email"]}}],"responses":{"200":{"description":"SVG","content":{"image/svg+xml":{"schema":{"type":"string"}}}}}}},"/health":{"get":{"summary":"Snapshot freshness for uptime monitors","operationId":"getHealth","responses":{"200":{"description":"ok <age seconds>","content":{"text/plain":{"schema":{"type":"string"}}}},"503":{"description":"stale <age seconds> or stale no-snapshot"}}}},"/llms.txt":{"get":{"summary":"Plain-text guide for AI agents","operationId":"getLlms","responses":{"200":{"description":"Markdown-flavoured text","content":{"text/plain":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"Status":{"type":"object","properties":{"version":{"type":"integer"},"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"overall":{"type":"object","properties":{"state":{"type":"string","enum":["operational","degraded","outage","maintenance","external","unknown"],"description":"#GoFile's own state; external = an HMRC or Companies House service is impaired while #GoFile is fine"},"label":{"type":"string"},"headline":{"type":"string"},"message":{"type":"string","description":"Customer-facing service message; empty when all clear"},"own_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"external_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"summary":{"type":"string"}}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["hmrc","ch","gofile"]},"name":{"type":"string"},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"components":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","enum":["filing","api","ch_api","ch_filing","app","db","crons","email"]},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"since":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"headline":{"type":"string"},"metrics":{"type":"object","description":"Depends on kind. Counts are buckets, rates are percentages.","properties":{"resolved_share_24h":{"type":["integer","null"],"description":"Filing services: share of filings that reached HMRC in the last 24 hours and have any HMRC result"},"held_unresolved":{"type":"string","enum":["none","some","several","many"],"description":"Filing services: filings left without a final HMRC result (held or ambiguous) and awaiting reconciliation, last 7 days"},"poller_late":{"type":"boolean","description":"true while our own result checks are late; the component is then unknown"},"waiting_over_2h":{"type":"string","enum":["none","some","several","many"]},"accept_median_minutes_24h":{"type":["integer","null"]},"accept_p90_minutes_24h":{"type":["integer","null"]},"timing_sample_ok":{"type":"boolean"},"error_rate_15m":{"type":["integer","null"]},"no_response_15m":{"type":"string","enum":["none","some","several","many"]},"submit_failures_60m":{"type":"string","enum":["none","some","several","many"]},"response_ms":{"type":["integer","null"]},"query_ms":{"type":["integer","null"]},"late":{"type":"array","items":{"type":"string"}},"backlog":{"type":"string","enum":["none","some","several","many"]}},"additionalProperties":true},"maintenance_until":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"incident_ids":{"type":"array","items":{"type":"integer"}},"uptime_pct":{"type":["number","null"],"description":"null until seven days of history exist"},"uptime_days":{"type":"integer"},"monitoring_since":{"type":["string","null"],"format":"date"},"uptime_90d":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown","nodata"]}}}},"hmrc_notice":{"type":"object","properties":{"planned_downtime":{"type":["string","null"]},"service_issues":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"url":{"type":"string"}}}}}}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"source":{"type":"string","enum":["auto","manual"]},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"impact":{"type":"string","enum":["degraded","outage","maintenance"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"started_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"updates":{"type":"array","description":"Newest first","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"body":{"type":"string"}}}}}}},"maintenance":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","enum":["govuk","gofile"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"start":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"end":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"active":{"type":"boolean"},"raw":{"type":["string","null"],"description":"HMRC's own wording of the window"},"url":{"type":["string","null"]}}}},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}},"Summary":{"type":"object","properties":{"version":{"type":"integer"},"generated_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"overall":{"type":"string","enum":["operational","degraded","outage","maintenance","external","unknown"],"description":"#GoFile's own state; external = an HMRC or Companies House service is impaired while #GoFile is fine"},"overall_label":{"type":"string"},"headline":{"type":"string"},"message":{"type":"string"},"own_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"external_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"summary":{"type":"string"},"components":{"type":"object","additionalProperties":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]}},"active_incidents":{"type":"integer"},"meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}},"Overall":{"type":"object","properties":{"state":{"type":"string","enum":["operational","degraded","outage","maintenance","external","unknown"],"description":"#GoFile's own state; external = an HMRC or Companies House service is impaired while #GoFile is fine"},"label":{"type":"string"},"headline":{"type":"string"},"message":{"type":"string","description":"Customer-facing service message; empty when all clear"},"own_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"external_state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"summary":{"type":"string"}}},"Component":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","enum":["filing","api","ch_api","ch_filing","app","db","crons","email"]},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown"]},"since":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"headline":{"type":"string"},"metrics":{"type":"object","description":"Depends on kind. Counts are buckets, rates are percentages.","properties":{"resolved_share_24h":{"type":["integer","null"],"description":"Filing services: share of filings that reached HMRC in the last 24 hours and have any HMRC result"},"held_unresolved":{"type":"string","enum":["none","some","several","many"],"description":"Filing services: filings left without a final HMRC result (held or ambiguous) and awaiting reconciliation, last 7 days"},"poller_late":{"type":"boolean","description":"true while our own result checks are late; the component is then unknown"},"waiting_over_2h":{"type":"string","enum":["none","some","several","many"]},"accept_median_minutes_24h":{"type":["integer","null"]},"accept_p90_minutes_24h":{"type":["integer","null"]},"timing_sample_ok":{"type":"boolean"},"error_rate_15m":{"type":["integer","null"]},"no_response_15m":{"type":"string","enum":["none","some","several","many"]},"submit_failures_60m":{"type":"string","enum":["none","some","several","many"]},"response_ms":{"type":["integer","null"]},"query_ms":{"type":["integer","null"]},"late":{"type":"array","items":{"type":"string"}},"backlog":{"type":"string","enum":["none","some","several","many"]}},"additionalProperties":true},"maintenance_until":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"incident_ids":{"type":"array","items":{"type":"integer"}},"uptime_pct":{"type":["number","null"],"description":"null until seven days of history exist"},"uptime_days":{"type":"integer"},"monitoring_since":{"type":["string","null"],"format":"date"},"uptime_90d":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"state":{"type":"string","enum":["operational","degraded","outage","maintenance","unknown","nodata"]}}}},"hmrc_notice":{"type":"object","properties":{"planned_downtime":{"type":["string","null"]},"service_issues":{"type":["string","null"]},"updated_at":{"type":["string","null"]},"url":{"type":"string"}}}}},"Incident":{"type":"object","properties":{"id":{"type":"integer"},"source":{"type":"string","enum":["auto","manual"]},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"impact":{"type":"string","enum":["degraded","outage","maintenance"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"started_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},{"type":"null"}]},"updates":{"type":"array","description":"Newest first","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"body":{"type":"string"}}}}}},"Update":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"state":{"type":"string","enum":["scheduled","investigating","identified","monitoring","resolved"]},"body":{"type":"string"}}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","enum":["govuk","gofile"]},"components":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"start":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"end":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"},"active":{"type":"boolean"},"raw":{"type":["string","null"],"description":"HMRC's own wording of the window"},"url":{"type":["string","null"]}}},"Meta":{"type":"object","properties":{"stale":{"type":"boolean","description":"true when the snapshot is more than 10 minutes old"},"age_seconds":{"type":["integer","null"]},"served_at":{"type":"string","format":"date-time","description":"ISO 8601 with the UK offset"}}}}}}