PHPackages                             vdauchy/docker-php-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. vdauchy/docker-php-api

ActiveLibrary[API Development](/categories/api)

vdauchy/docker-php-api
======================

1.40(4y ago)1353[1 PRs](https://github.com/vdauchy/docker-php-api/pulls)proprietaryPHPPHP >=5.5

Since Sep 24Pushed 4y ago1 watchersCompare

[ Source](https://github.com/vdauchy/docker-php-api)[ Packagist](https://packagist.org/packages/vdauchy/docker-php-api)[ Docs](http://swagger.io)[ RSS](/packages/vdauchy-docker-php-api/feed)WikiDiscussions develop Synced 1mo ago

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

OpenAPIClient-php
=================

[](#openapiclient-php)

The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.

Most of the client's commands map directly to API endpoints (e.g. `docker ps`is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.

Errors
======

[](#errors)

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

```
{
  \"message\": \"page not found\"
}

```

Versioning
==========

[](#versioning)

The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned.

If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release.

Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.

The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons.

Authentication
==============

[](#authentication)

Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)(JSON) string with the following structure:

```
{
  \"username\": \"string\",
  \"password\": \"string\",
  \"email\": \"string\",
  \"serveraddress\": \"string\"
}

```

The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required.

If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials:

```
{
  \"identitytoken\": \"9cbaf023786cd7...\"
}

```

Installation & Usage
------------------------

[](#installation--usage)

### Requirements

[](#requirements)

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

### Composer

[](#composer)

To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:

```
{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/vdauchy/docker-php-api.git"
    }
  ],
  "require": {
    "vdauchy/docker-php-api": "^1.41"
  }
}
```

Then run `composer install`

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```