SDK to talk with API

v3.1.0 2019-02-12 17:52 UTC

This package is auto-updated.

Last update: 2020-02-11 16:03:01 UTC



This table shows this SDK compatibility regarding Guzzle version:

SDK Version Guzzle Version
1.x >=4, <6
2.x 6


This library can be installed with composer:

composer require sensiolabs/consul-php-sdk


The simple way to use this SDK, is to instantiate the service factory:

$sf = new SensioLabs\Consul\ServiceFactory();

Then, a service could be retrieve from this factory:

$kv = $sf->get(\SensioLabs\Consul\Services\KVInterface::class);

Then, a service expose few methods mapped from the consul API:

$kv->put('test/foo/bar', 'bazinga');
$kv->get('test/foo/bar', ['raw' => true]);

All services methods follow the same convention:

$response = $service->method($mandatoryArgument, $someOptions);
  • All API mandatory arguments are placed as first;
  • All API optional arguments are directly mapped from $someOptions;
  • All methods return raw guzzle response.

So if you want to acquire an exclusive lock:

// Start a session
$sessionId = $session->create()->json()['ID'];

// Lock a key / value with the current session
$lockAcquired = $kv->put('tests/session/a-lock', 'a value', ['acquire' => $sessionId])->json();

if (false === $lockAcquired) {

    echo "The lock is already acquire by another node.\n";

echo "Do you jobs here....";
echo "End\n";


Available services

  • agent
  • catalog
  • health
  • kv
  • session

Some utilities

  • Lock handler: Simple class that implement a distributed lock