PHPackages                             jaeger-app/rest-client - 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 & Networking](/categories/http)
4. /
5. jaeger-app/rest-client

AbandonedArchivedLibrary[HTTP & Networking](/categories/http)

jaeger-app/rest-client
======================

A simple REST client to interact with Jaeger based installations in a RESTful manner

0.1.1(9y ago)16612MITPHPPHP >=5.4.0

Since Apr 19Pushed 9y ago1 watchersCompare

[ Source](https://github.com/jaeger-app/rest-client)[ Packagist](https://packagist.org/packages/jaeger-app/rest-client)[ RSS](/packages/jaeger-app-rest-client/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (5)Versions (4)Used By (2)

Jaeger REST Client
==================

[](#jaeger-rest-client)

[![Build Status](https://camo.githubusercontent.com/20451969e50cfafea03918670cf159c142ce1eaf3776c763c41a72418a16636e/68747470733a2f2f7472617669732d63692e6f72672f6a61656765722d6170702f726573742d636c69656e742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/jaeger-app/rest-client)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/b171e35f87485d9ea0cc5f08d63de6b71a0a815e0923e2e464de32929e24fee6/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a61656765722d6170702f726573742d636c69656e742f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/jaeger-app/rest-client/?branch=master)[![Author](https://camo.githubusercontent.com/125fbdac4bce1d0b560eb4a34b10e11849db5b79150219c1118cac66a4630297/687474703a2f2f696d672e736869656c64732e696f2f62616467652f617574686f722d406d697468726136322d626c75652e7376673f7374796c653d666c61742d737175617265)](https://twitter.com/mithra62)[![GitHub license](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](https://raw.githubusercontent.com/jaeger-app/bootstrap/master/LICENSE)

A simple REST client to interact with Jaeger REST API installations.

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

[](#installation)

Add `jaeger-app/rest-client` as a requirement to `composer.json`:

```
$ composer require jaeger-app/rest-client
```

Simple Example
--------------

[](#simple-example)

```
use \JaegerApp\Rest\Client;

$client = new Client();
$backups = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->get('/backups');
```

Authentication
--------------

[](#authentication)

Jaeger uses HMAC-SHA authentication which is a simple key / secret paradigm to create hashed signatures. You can get/set your api key and secret, as well as the API URL endpoint, from your individual Jaeger installations.

Error Handling
--------------

[](#error-handling)

If anything goes wrong with a request the library will return an [ApiProblem](http://tools.ietf.org/html/draft-nottingham-http-problem-07 "ApiProblem") object. Here's an example:

```
use \JaegerApp\Rest\Client;
use \JaegerApp\Rest\ApiProblem;

$client = new Client();
$result = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->get('/myendpoint');

if($result instanceof ApiProblem)
{
    if($result->getStatus() == 403) {
        //authentication issue
    }

	$result->getTitle() //API problem response title
	$result->getDetail() //API problem response details

}
```

Hal Responses
-------------

[](#hal-responses)

For all successful responses from the Jaeger API, the library will return an instance of `\JaegerApp\Rest\Client\Hal` object which is a wrapper for [\\Nocarrier\\Hal](https://github.com/blongden/hal).

```
use \JaegerApp\Rest\Client;
use \JaegerApp\Rest\Hal;

$client = new Client();
$result = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->get('/myendpoint');

if($result instanceof Hal)
{
    $data = $result->getData();
    $resources = $result->getResources();
}
```

Examples
--------

[](#examples)

Since Jaeger follows the \[Richardson Maturity Model\](Richardson Maturity Model) there are helper methods available for each HTTP verb. Below are some simple use case examples and their implementations

### Take a Backup

[](#take-a-backup)

```
use \JaegerApp\Rest\Client;

$client = new Client();
$result = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->post('/myendpoint');
```

### Update Settings

[](#update-settings)

```
use \JaegerApp\Rest\Client;

$client = new Client();
$settings = array('working_directory' => '/path/to/working_directory');
$update = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->put('/settings', $settings);
```

### Get Settings

[](#get-settings)

```
use \JaegerApp\Rest\Client;

$client = new Client();
$settings = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->get('/settings');
```

### Get Storage Locations

[](#get-storage-locations)

```
use \JaegerApp\Rest\Client;

$client = new Client();
$storage_locations = $client->setApiKey($api_key)
                 ->setApiSecret($api_secret)
                 ->setSiteUrl($api_endpoint_url)
                 ->get('/storage');
```

###  Health Score

25

—

LowBetter than 36% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity50

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 ~99 days

Total

2

Last Release

3618d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/042722642fab9b3e2f7b0711428b40053a2be0d6a1b752e50e7a7fffd06fb712?d=identicon)[mithra62](/maintainers/mithra62)

---

Top Contributors

[![eric-lamb62](https://avatars.githubusercontent.com/u/1008036?v=4)](https://github.com/eric-lamb62 "eric-lamb62 (50 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jaeger-app-rest-client/health.svg)

```
[![Health](https://phpackages.com/badges/jaeger-app-rest-client/health.svg)](https://phpackages.com/packages/jaeger-app-rest-client)
```

###  Alternatives

[educoder/pest

A proper REST client for PHP.

355699.8k16](/packages/educoder-pest)[chuyskywalker/rolling-curl

Rolling-Curl: A non-blocking, non-dos multi-curl library for PHP

207455.8k6](/packages/chuyskywalker-rolling-curl)[async-request/async-request

Asynchronous cURL library for PHP with reasonable API

2467.8k](/packages/async-request-async-request)[unikent/curl

Laravel Curl Helper Library.

1242.6k](/packages/unikent-curl)

PHPackages © 2026

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