PHPackages piurafunk/docker-php - 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. piurafunk/docker-php ActiveLibrary[HTTP & Networking](/categories/http) piurafunk/docker-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 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 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.40) is used. For example, calling `/info` is the same as calling `/v1.40/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 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 Base64 encoded (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..." } ``` v1.40(6y ago)09unlicensePHPPHP >=7.1CI failing Since Mar 4Pushed 6y agoCompare [ Source](https://github.com/piurafunk/docker-php)[ Packagist](https://packagist.org/packages/piurafunk/docker-php)[ Docs](https://openapi-generator.tech)[ RSS](/packages/piurafunk-docker-php/feed)WikiDiscussions master Synced 6d ago READMEChangelogDependencies (4)Versions (2)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.40) is used. For example, calling `/info` is the same as calling `/v1.40/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 Base64 encoded (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...\" } ``` This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.40 - Build package: org.openapitools.codegen.languages.PhpClientCodegen Requirements ------------ [](#requirements) PHP 5.5 and later Installation & Usage ------------------------ [](#installation--usage) ### Composer [](#composer) To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: ``` { "repositories": [ { "type": "vcs", "url": "https://github.com/piurafunk/docker-php.git" } ], "require": { "piurafunk/docker-php": "*@dev" } } ``` Then run `composer install` ### Manual Installation [](#manual-installation) Download the files and include `autoload.php`: ``` require_once('/path/to/OpenAPIClient-php/vendor/autoload.php'); ``` Tests ----- [](#tests) To run the unit tests: ``` composer install ./vendor/bin/phpunit ``` Getting Started --------------- [](#getting-started) Please follow the [installation procedure](#installation--usage) and then run the following: ```