Download the PHP package openstatus/sdk-php without Composer

Openstatus PHP SDK

Official PHP SDK for Openstatus — the open-source status page with uptime monitoring.

Table of Contents

• Features
• Installation
• Quick Start
• Authentication
• SDK Reference
  • Monitor Service
  • Health Service
  • Status Report Service
  • Status Page Service
  • Maintenance Service
  • Notification Service
• Reference
  • Monitor Options
  • Assertions
  • Regions
  • Enums
  • Working with int64 fields
• Error Handling
• Framework integration
• Related

Features

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 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

• 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

• 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

Requires PHP 8.4 or later.

Quick Start

Authentication

All API requests require an API key. Get yours from the Openstatus dashboard.

Recommended: configure the client once

Alternative: per-call headers

Every service method accepts an optional second argument: an array of headers merged into the request. Useful for tracing IDs or one-off overrides.

Environment Variables

If apiKey is not passed in ClientOptions, the SDK falls back to OPENSTATUS_API_KEY. Same for baseUrl / OPENSTATUS_API_URL.

SDK Reference

All examples below assume:

Monitor Service

Manage HTTP, TCP, and DNS monitors.

createHTTPMonitor(request)

Create an HTTP/HTTPS monitor.

updateHTTPMonitor(request)

Update an existing HTTP monitor.

createTCPMonitor(request) / updateTCPMonitor(request)

Monitor TCP services.

createDNSMonitor(request) / updateDNSMonitor(request)

Monitor DNS records.

getMonitor(request)

Fetch a single monitor (returns a MonitorConfig discriminated by type).

listMonitors(request)

List all monitors in the workspace, grouped by type.

triggerMonitor(request)

Manually run a monitor immediately. Rate-limited by the synthetic-checks quota.

deleteMonitor(request)

getMonitorStatus(request)

Per-region status snapshot.

getMonitorSummary(request)

Aggregated latency percentiles and request counts.

listMonitorHTTPResponseLogs(request)

Recent HTTP response log entries with pagination.

getMonitorHTTPResponseLog(request)

Single log entry with full headers and body assertions.

Health Service

check(request)

Returns the API's serving status. No authentication required — useful as a liveness check.

Status Report Service

Manage incident reports with a lifecycle: investigating → identified → monitoring → resolved.

createStatusReport(request)

getStatusReport(request) / listStatusReports(request) / updateStatusReport(request) / deleteStatusReport(request)

addStatusReportUpdate(request)

Status Page Service

Manage public status pages with components, component groups, and subscribers.

createStatusPage(request)

getStatusPage(request) / listStatusPages(request) / updateStatusPage(request) / deleteStatusPage(request)

getStatusPageContent(request) / getOverallStatus(request)

Components

Add a monitor-backed component or a static component, update it, remove it.

Component groups

Subscribers

Maintenance Service

Schedule planned maintenance windows. Subscribers can be notified automatically.

Notification Service

Configure notification channels and check usage limits.

Other methods:

Reference

Monitor Options

Assertions

Assertions are evaluated against each check response. All matching assertions must pass for a check to be successful.

Regions

28 regions are available via the Region enum:

Enums

All enums emitted by the protobuf compiler are plain classes with const int values. The generated value getters return int; use the static name() helper to convert to a string.

Notable enums you'll encounter:

• Openstatus\Monitor\V1\HTTPMethod
• Openstatus\Monitor\V1\Periodicity
• Openstatus\Monitor\V1\Region
• Openstatus\Monitor\V1\MonitorStatus
• Openstatus\Monitor\V1\NumberComparator
• Openstatus\Monitor\V1\StringComparator
• Openstatus\Monitor\V1\TimeRange
• Openstatus\Monitor\V1\HTTPResponseLogRequestStatus
• Openstatus\Monitor\V1\HTTPResponseLogTrigger
• Openstatus\Health\V1\CheckResponse\ServingStatus
• Openstatus\Status_report\V1\StatusReportStatus
• Openstatus\Status_page\V1\OverallStatus
• Openstatus\Status_page\V1\PageAccessType
• Openstatus\Status_page\V1\PageTheme
• Openstatus\Status_page\V1\PageComponentType
• Openstatus\Notification\V1\NotificationProvider
• Openstatus\Notification\V1\OpsgenieRegion

Working with int64 fields

int64 fields (timestamps, percentiles, latencies measured in nanoseconds) return int|string from getters because protoc-gen-php falls back to strings on 32-bit platforms to avoid silent overflow.

On 64-bit PHP — the default on macOS and Linux — the value is always an int. If you need to be safe across both platforms:

The setter accepts either, so passing an int directly works.

Error Handling

All Connect RPC errors raise Openstatus\Sdk\Exception\OpenstatusException (or a subclass). The exception carries the Connect error code, HTTP status, parsed details array, and raw response body.

Framework integration

Symfony

Register the client as a service in config/services.yaml:

Inject into any controller or service:

Laravel

In a service provider's register() method:

Resolve from the container:

Custom PSR-18 client

Bring your own HTTP client (Symfony HttpClient, Saloon, Mock, etc.). Anything implementing Psr\Http\Client\ClientInterface works.

Pair with a custom PSR-3 logger to log every request/response at DEBUG:

Related

• Openstatus — open-source status pages and uptime monitoring.
• Openstatus API docs
• Openstatus Node SDK
• Openstatus Proto schema

License

MIT — see LICENSE.