# Cachet - [Introduction](https://docs.cachethq.io/docs/v3.x/introduction.md): Cachet is an open source, self-hosted status page system. - [Installation](https://docs.cachethq.io/docs/v3.x/installation.md): Learn how to install Cachet on your server. - [Demo](https://docs.cachethq.io/docs/v3.x/demo.md): There's no better way to see what Cachet can do than to see it in action. - [Development](https://docs.cachethq.io/docs/v3.x/development.md): Learn how to develop and contribute to Cachet. - [Migration guide](https://docs.cachethq.io/docs/v3.x/migration-guide.md): Learn how to migrate from Cachet v2.x to v3.x. - [Changelog](https://docs.cachethq.io/docs/v3.x/changelog.md): Learn about the changes in Cachet. - [Incidents](https://docs.cachethq.io/docs/v3.x/guide/incidents.md): Learn how to manage incidents in Cachet. - [Components](https://docs.cachethq.io/docs/v3.x/guide/components.md): Learn how to manage components in Cachet. - [Schedules](https://docs.cachethq.io/docs/v3.x/guide/schedules.md): Learn how to manage scheduled maintenance in Cachet. - [Metrics](https://docs.cachethq.io/docs/v3.x/guide/metrics.md): Learn how to manage metrics in Cachet. - [Subscribers](https://docs.cachethq.io/docs/v3.x/guide/subscribers.md): Learn how to manage subscribers in Cachet. - [Webhooks](https://docs.cachethq.io/docs/v3.x/guide/webhooks.md): Learn how to use webhooks in Cachet. - [MCP server](https://docs.cachethq.io/docs/v3.x/guide/mcp.md): Connect AI agents to Cachet using the Model Context Protocol. - [Users](https://docs.cachethq.io/docs/v3.x/guide/users.md): Learn how to manage users and access to your Cachet dashboard. - [Dashboard](https://docs.cachethq.io/docs/v3.x/guide/dashboard.md): Learn about Cachet's dashboard. - [Status badges](https://docs.cachethq.io/docs/v3.x/guide/status-badges.md): Embed the current Cachet system or component status in an SVG badge. - [Cachet](https://docs.cachethq.io/docs/v3.x/configuration/cachet.md): Learn how to manage Cachet. - [Environment variables](https://docs.cachethq.io/docs/v3.x/configuration/environment.md): Configure Cachet using environment variables. - [Customization](https://docs.cachethq.io/docs/v3.x/configuration/customization.md): Learn how to customize Cachet. - [Theme](https://docs.cachethq.io/docs/v3.x/configuration/theme.md): Learn how to configure and theme Cachet. - [Theme hooks](https://docs.cachethq.io/docs/v3.x/configuration/theme-hooks.md): Theme Cachet with stable CSS selectors and render hooks. - [Beacon](https://docs.cachethq.io/docs/v3.x/configuration/beacon.md): Learn how to configure Cachet's beacon. - [API keys](https://docs.cachethq.io/docs/v3.x/configuration/api-keys.md): Learn how to create and manage API keys in Cachet. - [Oh Dear](https://docs.cachethq.io/docs/v3.x/integrations/oh-dear.md): Import your Oh Dear data into Cachet. - [Credits](https://docs.cachethq.io/docs/credits.md): Our contributors and the open source projects we depend on make Cachet possible. - [Trademarks](https://docs.cachethq.io/docs/trademarks.md): Learn about Cachet's trademarks and how to use them. - [Introduction](https://docs.cachethq.io/docs/api-reference/introduction.md): Learn how to interact with the Cachet API. - [Authentication](https://docs.cachethq.io/docs/api-reference/authentication.md): Learn how to authenticate with the Cachet API - [Pagination](https://docs.cachethq.io/docs/api-reference/pagination.md): Learn how to paginate through the results of a query. - [Filtering and sorting](https://docs.cachethq.io/docs/api-reference/filtering.md): Learn how to filter and sort data in the Cachet API. - [Rate limiting](https://docs.cachethq.io/docs/api-reference/rate-limiting.md): Learn how rate limits work in the Cachet API. - [Test the API](https://docs.cachethq.io/docs/api-reference/cachet/test-the-api.md) - [Get Version](https://docs.cachethq.io/docs/api-reference/cachet/get-version.md) - [Get System Status](https://docs.cachethq.io/docs/api-reference/cachet/get-system-status.md) - [List Components](https://docs.cachethq.io/docs/api-reference/components/list-components.md) - [Create Component](https://docs.cachethq.io/docs/api-reference/components/create-component.md) - [Delete Components](https://docs.cachethq.io/docs/api-reference/components/delete-components.md) - [Get Component](https://docs.cachethq.io/docs/api-reference/components/get-component.md) - [Update Component](https://docs.cachethq.io/docs/api-reference/components/update-component.md) - [Delete Component](https://docs.cachethq.io/docs/api-reference/components/delete-component.md) - [List Component Groups](https://docs.cachethq.io/docs/api-reference/component-groups/list-component-groups.md) - [Create Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/create-component-group.md) - [Delete Component Groups](https://docs.cachethq.io/docs/api-reference/component-groups/delete-component-groups.md) - [Get Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/get-component-group.md) - [Update Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/update-component-group.md) - [Delete Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/delete-component-group.md) - [List Incidents](https://docs.cachethq.io/docs/api-reference/incidents/list-incidents.md) - [Create Incident](https://docs.cachethq.io/docs/api-reference/incidents/create-incident.md) - [Delete Incidents](https://docs.cachethq.io/docs/api-reference/incidents/delete-incidents.md) - [Get Incident](https://docs.cachethq.io/docs/api-reference/incidents/get-incident.md) - [Update Incident](https://docs.cachethq.io/docs/api-reference/incidents/update-incident.md) - [Delete Incident](https://docs.cachethq.io/docs/api-reference/incidents/delete-incident.md) - [List Incident Updates](https://docs.cachethq.io/docs/api-reference/incident-updates/list-incident-updates.md) - [Create Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/create-incident-update.md) - [Get Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/get-incident-update.md) - [Update Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/update-incident-update.md) - [Delete Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/delete-incident-update.md) - [List Incident Templates](https://docs.cachethq.io/docs/api-reference/incident-templates/list-incident-templates.md) - [Create Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/create-incident-template.md) - [Delete Incident Templates](https://docs.cachethq.io/docs/api-reference/incident-templates/delete-incident-templates.md) - [Get Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/get-incident-template.md) - [Update Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/update-incident-template.md) - [Delete Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/delete-incident-template.md) - [List Metrics](https://docs.cachethq.io/docs/api-reference/metrics/list-metrics.md) - [Create Metric](https://docs.cachethq.io/docs/api-reference/metrics/create-metric.md) - [Delete Metrics](https://docs.cachethq.io/docs/api-reference/metrics/delete-metrics.md) - [Get Metric](https://docs.cachethq.io/docs/api-reference/metrics/get-metric.md) - [Update Metric](https://docs.cachethq.io/docs/api-reference/metrics/update-metric.md) - [Delete Metric](https://docs.cachethq.io/docs/api-reference/metrics/delete-metric.md) - [List Metric Points](https://docs.cachethq.io/docs/api-reference/metric-points/list-metric-points.md) - [Create Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/create-metric-point.md) - [Get Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/get-metric-point.md) - [Delete Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/delete-metric-point.md) - [List Schedules](https://docs.cachethq.io/docs/api-reference/schedules/list-schedules.md) - [Create Schedule](https://docs.cachethq.io/docs/api-reference/schedules/create-schedule.md) - [Delete Schedules](https://docs.cachethq.io/docs/api-reference/schedules/delete-schedules.md) - [Get Schedule](https://docs.cachethq.io/docs/api-reference/schedules/get-schedule.md) - [Update Schedule](https://docs.cachethq.io/docs/api-reference/schedules/update-schedule.md) - [Delete Schedule](https://docs.cachethq.io/docs/api-reference/schedules/delete-schedule.md) - [List Schedule Updates](https://docs.cachethq.io/docs/api-reference/schedule-updates/list-schedule-updates.md) - [Create Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/create-schedule-update.md) - [Get Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/get-schedule-update.md) - [Update Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/update-schedule-update.md) - [Delete Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/delete-schedule-update.md) - [List Subscribers](https://docs.cachethq.io/docs/api-reference/subscribers/list-subscribers.md) - [Create Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/create-subscriber.md) - [Get Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/get-subscriber.md) - [Update Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/update-subscriber.md) - [Delete Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/delete-subscriber.md) - [Introduction](https://docs.cachethq.io/docs/v2.x/introduction.md): Cachet is a beautiful and powerful open source status page system. - [Component Statuses](https://docs.cachethq.io/docs/v2.x/component-statuses.md): Learn about the different component statuses in Cachet. - [Incident Statuses](https://docs.cachethq.io/docs/v2.x/incident-statuses.md): Learn about the different incident statuses in Cachet. - [Client Libraries](https://docs.cachethq.io/docs/v2.x/client-libraries.md): A list of third party libraries for the Cachet API. - [Frequently Asked Questions](https://docs.cachethq.io/docs/v2.x/faq.md): Common questions and answers about Cachet. - [Installation](https://docs.cachethq.io/docs/v2.x/installation/guide.md): Learn how to install Cachet on your server. - [Docker](https://docs.cachethq.io/docs/v2.x/installation/docker.md): Learn how to install Cachet on your server with Docker. - [Windows](https://docs.cachethq.io/docs/v2.x/installation/windows.md): Learn how to install Cachet on your Windows server. - [Upgrading](https://docs.cachethq.io/docs/v2.x/installation/upgrading.md): Learn how to upgrade Cachet to the latest version. - [Beacons](https://docs.cachethq.io/docs/v2.x/installation/beacons.md): Learn about Cachet's beacon system. - [Prerequisites](https://docs.cachethq.io/docs/v2.x/configuration/prerequisites.md): Prerequisites for installing Cachet. - [GitHub OAuth Token](https://docs.cachethq.io/docs/v2.x/configuration/github-oauth-token.md): How to enable GitHub Emoji support in Cachet. - [CORS](https://docs.cachethq.io/docs/v2.x/configuration/cors.md): Learn how to configure CORS in Cachet. - [Mail](https://docs.cachethq.io/docs/v2.x/configuration/mail.md): Learn how to configure mail in Cachet. - [Queue](https://docs.cachethq.io/docs/v2.x/configuration/queue.md): Learn how to configure the queue in Cachet. - [Subscribers](https://docs.cachethq.io/docs/v2.x/configuration/subscribers.md): Learn how to configure subscribers in Cachet. - [Credits](https://docs.cachethq.io/docs/credits.md): Our contributors and the open source projects we depend on make Cachet possible. - [Trademarks](https://docs.cachethq.io/docs/trademarks.md): Learn about Cachet's trademarks and how to use them. - [Test the API](https://docs.cachethq.io/docs/api-reference/cachet/test-the-api.md) - [Get Version](https://docs.cachethq.io/docs/api-reference/cachet/get-version.md) - [Get System Status](https://docs.cachethq.io/docs/api-reference/cachet/get-system-status.md) - [List Components](https://docs.cachethq.io/docs/api-reference/components/list-components.md) - [Create Component](https://docs.cachethq.io/docs/api-reference/components/create-component.md) - [Delete Components](https://docs.cachethq.io/docs/api-reference/components/delete-components.md) - [Get Component](https://docs.cachethq.io/docs/api-reference/components/get-component.md) - [Update Component](https://docs.cachethq.io/docs/api-reference/components/update-component.md) - [Delete Component](https://docs.cachethq.io/docs/api-reference/components/delete-component.md) - [List Component Groups](https://docs.cachethq.io/docs/api-reference/component-groups/list-component-groups.md) - [Create Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/create-component-group.md) - [Delete Component Groups](https://docs.cachethq.io/docs/api-reference/component-groups/delete-component-groups.md) - [Get Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/get-component-group.md) - [Update Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/update-component-group.md) - [Delete Component Group](https://docs.cachethq.io/docs/api-reference/component-groups/delete-component-group.md) - [List Incidents](https://docs.cachethq.io/docs/api-reference/incidents/list-incidents.md) - [Create Incident](https://docs.cachethq.io/docs/api-reference/incidents/create-incident.md) - [Delete Incidents](https://docs.cachethq.io/docs/api-reference/incidents/delete-incidents.md) - [Get Incident](https://docs.cachethq.io/docs/api-reference/incidents/get-incident.md) - [Update Incident](https://docs.cachethq.io/docs/api-reference/incidents/update-incident.md) - [Delete Incident](https://docs.cachethq.io/docs/api-reference/incidents/delete-incident.md) - [List Incident Updates](https://docs.cachethq.io/docs/api-reference/incident-updates/list-incident-updates.md) - [Create Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/create-incident-update.md) - [Get Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/get-incident-update.md) - [Update Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/update-incident-update.md) - [Delete Incident Update](https://docs.cachethq.io/docs/api-reference/incident-updates/delete-incident-update.md) - [List Incident Templates](https://docs.cachethq.io/docs/api-reference/incident-templates/list-incident-templates.md) - [Create Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/create-incident-template.md) - [Delete Incident Templates](https://docs.cachethq.io/docs/api-reference/incident-templates/delete-incident-templates.md) - [Get Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/get-incident-template.md) - [Update Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/update-incident-template.md) - [Delete Incident Template](https://docs.cachethq.io/docs/api-reference/incident-templates/delete-incident-template.md) - [List Metrics](https://docs.cachethq.io/docs/api-reference/metrics/list-metrics.md) - [Create Metric](https://docs.cachethq.io/docs/api-reference/metrics/create-metric.md) - [Delete Metrics](https://docs.cachethq.io/docs/api-reference/metrics/delete-metrics.md) - [Get Metric](https://docs.cachethq.io/docs/api-reference/metrics/get-metric.md) - [Update Metric](https://docs.cachethq.io/docs/api-reference/metrics/update-metric.md) - [Delete Metric](https://docs.cachethq.io/docs/api-reference/metrics/delete-metric.md) - [List Metric Points](https://docs.cachethq.io/docs/api-reference/metric-points/list-metric-points.md) - [Create Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/create-metric-point.md) - [Get Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/get-metric-point.md) - [Delete Metric Point](https://docs.cachethq.io/docs/api-reference/metric-points/delete-metric-point.md) - [List Schedules](https://docs.cachethq.io/docs/api-reference/schedules/list-schedules.md) - [Create Schedule](https://docs.cachethq.io/docs/api-reference/schedules/create-schedule.md) - [Delete Schedules](https://docs.cachethq.io/docs/api-reference/schedules/delete-schedules.md) - [Get Schedule](https://docs.cachethq.io/docs/api-reference/schedules/get-schedule.md) - [Update Schedule](https://docs.cachethq.io/docs/api-reference/schedules/update-schedule.md) - [Delete Schedule](https://docs.cachethq.io/docs/api-reference/schedules/delete-schedule.md) - [List Schedule Updates](https://docs.cachethq.io/docs/api-reference/schedule-updates/list-schedule-updates.md) - [Create Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/create-schedule-update.md) - [Get Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/get-schedule-update.md) - [Update Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/update-schedule-update.md) - [Delete Schedule Update](https://docs.cachethq.io/docs/api-reference/schedule-updates/delete-schedule-update.md) - [List Subscribers](https://docs.cachethq.io/docs/api-reference/subscribers/list-subscribers.md) - [Create Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/create-subscriber.md) - [Get Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/get-subscriber.md) - [Update Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/update-subscriber.md) - [Delete Subscriber](https://docs.cachethq.io/docs/api-reference/subscribers/delete-subscriber.md) ## OpenAPI Specs - [openapi](/docs/api-reference/openapi.json) ## Optional - [Blog](https://blog.cachethq.io) - [Sponsor Cachet](https://docs.cachethq.io/sponsor) - [Blog](https://blog.cachethq.io)