PHPackages                             openstatus/sdk-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. openstatus/sdk-php

ActiveLibrary[Logging & Monitoring](/categories/logging)

openstatus/sdk-php
==================

Official PHP SDK for Openstatus

v0.1.0(1mo ago)10MITPHPPHP >=8.4CI passing

Since May 28Pushed 1mo agoCompare

[ Source](https://github.com/openstatusHQ/sdk-php)[ Packagist](https://packagist.org/packages/openstatus/sdk-php)[ Docs](https://github.com/openstatusHQ/sdk-php)[ GitHub Sponsors](https://github.com/openstatusHQ)[ RSS](/packages/openstatus-sdk-php/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (9)Versions (2)Used By (0)

Openstatus PHP SDK
==================

[](#openstatus-php-sdk)

[![License: MIT](https://camo.githubusercontent.com/fdf2982b9f5d7489dcf44570e714e3a15fce6253e0cc6b5aa61a075aac2ff71b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d79656c6c6f772e737667)](https://opensource.org/licenses/MIT)[![PHP 8.4+](https://camo.githubusercontent.com/e7fb02d4dba7ebc18300495e44eda0d0f1e5e176b17b0ad8542e31cf06735e73/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e342532422d3737374242342e737667)](https://www.php.net/)

Official PHP SDK for [Openstatus](https://openstatus.dev) — the open-source status page with uptime monitoring.

Table of Contents
-----------------

[](#table-of-contents)

- [Features](#features)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Authentication](#authentication)
- [SDK Reference](#sdk-reference)
    - [Monitor Service](#monitor-service)
    - [Health Service](#health-service)
    - [Status Report Service](#status-report-service)
    - [Status Page Service](#status-page-service)
    - [Maintenance Service](#maintenance-service)
    - [Notification Service](#notification-service)
- [Reference](#reference)
    - [Monitor Options](#monitor-options)
    - [Assertions](#assertions)
    - [Regions](#regions)
    - [Enums](#enums)
    - [Working with int64 fields](#working-with-int64-fields)
- [Error Handling](#error-handling)
- [Framework integration](#framework-integration)
- [Related](#related)

Features
--------

[](#features)

### Monitoring

[](#monitoring)

- **HTTP Monitoring** — monitor websites and APIs with customizable assertions.
- **TCP Monitoring** — check database connections and other TCP services.
- **DNS Monitoring** — verify DNS records and resolution.
- **Global Regions** — monitor from 28 locations worldwide.

### Status Page

[](#status-page)

- **Status Pages** — create and manage public status pages with custom domains.
- **Page Components** — add monitor-based or static components with grouping.
- **Subscribers** — manage email subscriptions for status updates.
- **Status Reports** — manage incident reports with update timelines.
- **Maintenance Windows** — schedule and manage planned maintenance periods.

### Notifications

[](#notifications)

- **12 providers** — Slack, Discord, Email, PagerDuty, Opsgenie, Telegram, and more.
- **Webhook Support** — custom webhooks with headers for any integration.
- **Monitor Alerts** — get notified when monitors go down or recover.

### Developer Experience

[](#developer-experience)

- **Type-safe** — strongly-typed request/response messages generated from Openstatus protobuf schemas (`buf.build/openstatus/api`).
- **PSR-18 transport** — bring your own HTTP client, or use the bundled Guzzle implementation.
- **No proto toolchain needed** — pre-generated PHP classes ship with the package; `composer require` is all you need.

Installation
------------

[](#installation)

Requires PHP 8.4 or later.

```
composer require openstatus/sdk-php
```

Quick Start
-----------

[](#quick-start)

```