PHPackages                             checkitonus/cachet-api - 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. [API Development](/categories/api)
4. /
5. checkitonus/cachet-api

ActiveLibrary[API Development](/categories/api)

checkitonus/cachet-api
======================

PHP Implementation of the Cachet API

1.0.12(5y ago)841.3k↓33.3%2MITPHPPHP >=5.6.0CI passing

Since Jul 25Pushed 8mo ago2 watchersCompare

[ Source](https://github.com/checkitonus/php-cachet-api)[ Packagist](https://packagist.org/packages/checkitonus/cachet-api)[ RSS](/packages/checkitonus-cachet-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (13)Used By (0)

Cachet SDK
==========

[](#cachet-sdk)

[![CheckItOn.Us Logo](https://camo.githubusercontent.com/e04a3331de03c212c6d1463fc13fbb8a815f662676ccff8f65ce4de5a3dd8c43/68747470733a2f2f7777772e636865636b69746f6e2e75732f696d672f6d6f6e6f2d6c6f676f2e706e67)](https://www.checkiton.us)

[![Build Status](https://camo.githubusercontent.com/3ca7e7a73cfd32eaf7d4bec5ac63379d27f693819eedab24d38155c21ed8d7ce/68747470733a2f2f7472617669732d63692e6f72672f636865636b69746f6e75732f7068702d6361636865742d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/checkitonus/php-cachet-api)

Easy to use Cachet API implementation.

Installation
============

[](#installation)

```
$ composer require checkitonus/cachet-api

```

```
{
    "require": {
        "checkitonus/cachet-api": "~1"
    }
}

```

Then, in your PHP file, all you need to do is require the autoloader:

```
require_once 'vendor/autoload.php';

use CheckItOnUs\Cachet\Server;

$server = new Server([
    'api_key' => 'API-KEY',
    'base_url' => 'https://demo.cachethq.io', // The base URL for the Cachet installation
]);

// Should return pong
echo $server->ping();
```

API Components
==============

[](#api-components)

Once installed, you will have access to several objects all of which will hit the API and retrieve the data as needed.

Please Note: Although all of these samples are using the `Component` class, they are available for the following objects:

- CheckItOnUs\\Cachet\\Component
- CheckItOnUs\\Cachet\\ComponentGroup
- CheckItOnUs\\Cachet\\Incident
- CheckItOnUs\\Cachet\\IncidentUpdate (In development - Cachet 2.4 feature)

```
require_once 'vendor/autoload.php';

use CheckItOnUs\Cachet\Server;
use CheckItOnUs\Cachet\Component;

$server = new Server([
    'api_key' => 'API-KEY',
    'base_url' => 'https://demo.cachethq.io', // The base URL for the Cachet installation
]);

// Find a component based on the name
$component = Component::on($server)->findByName('API');

// Find a component based on the ID
$component = Component::on($server)->findById(1);

// Find all components
Component::on($server)->all();
```

CRUD Operations
---------------

[](#crud-operations)

### Creation

[](#creation)

```
require_once 'vendor/autoload.php';

use CheckItOnUs\Cachet\Server;
use CheckItOnUs\Cachet\Component;

$server = new Server([
    'api_key' => 'API-KEY',
    'base_url' => 'https://demo.cachethq.io', // The base URL for the Cachet installation
]);

// Fluent API
$component = (new Component($server))
                ->setName('Name Here')
                ->setStatus(Component::OPERATIONAL)
                ->create();
```

### Update

[](#update)

```
require_once 'vendor/autoload.php';

use CheckItOnUs\Cachet\Server;
use CheckItOnUs\Cachet\Component;

$server = new Server([
    'api_key' => 'API-KEY',
    'base_url' => 'https://demo.cachethq.io', // The base URL for the Cachet installation
]);

// Fluent API
Component::on($server)
    ->findById(1)
    ->setName('Name Here')
    ->setStatus(Component::OPERATIONAL)
    ->update();
```

### Delete

[](#delete)

```
require_once 'vendor/autoload.php';

use CheckItOnUs\Cachet\Server;
use CheckItOnUs\Cachet\Component;

$server = new Server([
    'api_key' => 'API-KEY',
    'base_url' => 'https://demo.cachethq.io', // The base URL for the Cachet installation
]);

// Fluent API
Component::on($server)
    ->findById(1)
    ->delete();
```

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance43

Moderate activity, may be stable

Popularity34

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 96.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~98 days

Recently: every ~224 days

Total

12

Last Release

2141d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6c1a37465afdee14b2740a387deaae40ac376e38015db7af98f90b7fd97fed22?d=identicon)[awjudd](/maintainers/awjudd)

---

Top Contributors

[![awjudd](https://avatars.githubusercontent.com/u/1910996?v=4)](https://github.com/awjudd "awjudd (26 commits)")[![freezy-sk](https://avatars.githubusercontent.com/u/661637?v=4)](https://github.com/freezy-sk "freezy-sk (1 commits)")

### Embed Badge

![Health badge](/badges/checkitonus-cachet-api/health.svg)

```
[![Health](https://phpackages.com/badges/checkitonus-cachet-api/health.svg)](https://phpackages.com/packages/checkitonus-cachet-api)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.2M720](/packages/statamic-cms)[ashallendesign/laravel-exchange-rates

A wrapper package for interacting with the exchangeratesapi.io API.

485677.8k](/packages/ashallendesign-laravel-exchange-rates)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[vluzrmos/slack-api

Wrapper for Slack.com WEB API.

102589.1k3](/packages/vluzrmos-slack-api)[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[webgriffe/sylius-akeneo-plugin

Plugin allowing to import products data from Akeneo PIM to your Sylius store.

2477.8k](/packages/webgriffe-sylius-akeneo-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)