PHPackages                             nikoutel/tritonsysteminfoapi - 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. [HTTP &amp; Networking](/categories/http)
4. /
5. nikoutel/tritonsysteminfoapi

ActiveProject[HTTP &amp; Networking](/categories/http)

nikoutel/tritonsysteminfoapi
============================

A Restful API to get the representations of system information and metrics.

v0.1.1(6y ago)37[3 PRs](https://github.com/nikoutel/TritonSystemInfoAPI/pulls)MPL-2.0PHPPHP &gt;=7.1.3

Since Jul 25Pushed 4y ago1 watchersCompare

[ Source](https://github.com/nikoutel/TritonSystemInfoAPI)[ Packagist](https://packagist.org/packages/nikoutel/tritonsysteminfoapi)[ RSS](/packages/nikoutel-tritonsysteminfoapi/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (7)Used By (0)

TritonSystemInfoAPI
===================

[](#tritonsysteminfoapi)

**A Restful API to get the representations of system information and metrics.**

Get system information (like *OS*, *hostname*, *public IPs*, *services status*), metrics (like *CPU usage*, *free memory*, *web server load*), and even configurations (like *apache2.conf* and *php.ini*) with an easy to navigate and configurable RESTfull web-service, made with Lumen.

`Triton` adopts the `HAL` *(Hypertext Application Language)* convention for representing resources and their relations with hypermedia links.
Resources are formatted in JSON and have the media type `"application/hal+json"`

Only the `GET` http method is implemented, other methods are not allowed.

### Status

[](#status)

*Current status:* **It works on my machine!**
*Meaning:* It is still under development, and for now only `Debian Gnu/Linux` systems with `systemd` are supported.
It should work on other `Debian` based systems (with `systemd`) but they are not fully tested yet.

### Warning!!

[](#warning)

This will expose critical information about your system! *Use it wisely!*

### Information/metrics - Endpoints

[](#informationmetrics---endpoints)

- System
    - Information - `/api/system/info`
    - Load average - `/api/system/load`
    - CPU - `/api/system/cpu`
        - Info - `/api/system/cpu/info`
        - Extended info - `/api/system/cpu/extended-info`
        - Usage (%) - `/api/system/cpu/usage`
    - Network - `/api/system/network`
        - Info - `/api/system/network/info`
        - Usage (KiB/Sec) - `/api/system/network/usage`
    - Memory - `/api/system/memory`
        - Usage - `/api/system/memory/usage`
    - Disk - `/api/system/disk`
        - Info - `/api/system/disk/info`
        - Usage - `/api/system/disk/usage`
- Services - `/api/services`
    - {Service} - e.g. `/api/services/apache2`, `/api/services/mysql`
        - Info - e.g. `/api/services/apache2/info`
        - Status - e.g. `/api/services/apache2/status`
        - Load - e.g. `/api/services/apache2/load`
        - Config - e.g. `/api/services/apache2/config`
            - {Config} - e.g. `/api/services/apache2/config/sites-enabled`, `/api/services/mysql/mysql/config/my.conf`
- Software - `/api/system/software`
    - php - `/api/system/software/php`
        - phpinfo - `/api/system/software/php/phpinfo`
        - Config - `/api/system/software/php/config`
            - {Config} - e.g. `/api/system/software/php/config/php.ini`, `/api/system/software/php/config/php.ini-cli`

### Services

[](#services)

An environment variable (`ALLOWED_SERVICES`) defined in the `.env` file, controls which services are allowed to be processed.
Any other service will result in a 404 error.

### Configs

[](#configs)

Similar, an environment variable (`ALLOWED_CONF`), controls which configurations are allowed.

Dynamically defined allowed services, which also have allowed configurations defined, must be included in the `TYPES_WITH_SEC_PARAMETER` environment variable, and their configurations must be defined with the `ALLOWED_CONF{service_name}` (e.g. `ALLOWED_CONFAPACHE2`) environment variable.

Configuration paths are defined via the `PATH_{conf_name}` variable (e.g. `PATH_MYCNF=/etc/mysql/my.cnf`).

Requirements
------------

[](#requirements)

- PHP 7.1.3 (min)

Install
-------

[](#install)

**composer:**

*As standalone:*

```
composer create-project nikoutel/tritonsysteminfoapi

```

*As library:*

```
composer require nikoutel/tritonsysteminfoapi

```

### Configuration

[](#configuration)

Create an `.env` configuration file (if not available) according to `.env.example`.

The .env file stores environment variables for the application.

*Environment variable names consist solely of uppercase letters, digits, and the '\_' (underscore) (IEEE Std 1003.1-2001)*

License
-------

[](#license)

This software is licensed under the [MPL](http://www.mozilla.org/MPL/2.0/) 2.0:

```
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at http://mozilla.org/MPL/2.0/.

```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~59 days

Total

2

Last Release

2420d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/26b8ff0aae33318299950ec6d4e7808d97b7483ea1969f8f50155fa6fcb77583?d=identicon)[nikoutel](/maintainers/nikoutel)

---

Top Contributors

[![nikoutel](https://avatars.githubusercontent.com/u/3975133?v=4)](https://github.com/nikoutel "nikoutel (95 commits)")

---

Tags

apacheapiconfigurationcpudiskhaljsonmemorynetworkrestservicesystemjsonapiconfigurationrestmemoryhalserviceCPUsystemnetworkapachedisk

### Embed Badge

![Health badge](/badges/nikoutel-tritonsysteminfoapi/health.svg)

```
[![Health](https://phpackages.com/badges/nikoutel-tritonsysteminfoapi/health.svg)](https://phpackages.com/packages/nikoutel-tritonsysteminfoapi)
```

###  Alternatives

[jsor/hal-client

A lightweight client for consuming and manipulating Hypertext Application Language (HAL) resources.

2425.9k1](/packages/jsor-hal-client)[serpapi/google-search-results-php

Get Google, Bing, Baidu, Ebay, Yahoo, Yandex, Home depot, Naver, Apple, Duckduckgo, Youtube search results via SerpApi.com

69114.3k](/packages/serpapi-google-search-results-php)[api-platform/laravel

API Platform support for Laravel

59126.4k5](/packages/api-platform-laravel)[ismaeltoe/osms

PHP library wrapper of the Orange SMS API.

4540.0k](/packages/ismaeltoe-osms)[elao/json-http-form-bundle

Adds support of JSON requests for Forms

356.0k](/packages/elao-json-http-form-bundle)[jarischaefer/hal-api

Enhances your HATEOAS experience by automating common tasks.

291.4k](/packages/jarischaefer-hal-api)

PHPackages © 2026

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