PHPackages                             mlackman/upcloud-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. mlackman/upcloud-php-api

ActiveLibrary[API Development](/categories/api)

mlackman/upcloud-php-api
========================

UpCloud PHP API

v1.0.0(8y ago)09proprietaryPHPPHP >=5.5

Since Jan 15Pushed 8y ago1 watchersCompare

[ Source](https://github.com/mlackman/upcloud-php-api)[ Packagist](https://packagist.org/packages/mlackman/upcloud-php-api)[ Docs](https://github.com/UpCloudLtd/upcloud-php-api)[ RSS](/packages/mlackman-upcloud-php-api/feed)WikiDiscussions master Synced 2d ago

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

UpCloud PHP API client library
==============================

[](#upcloud-php-api-client-library)

[![Build Status](https://camo.githubusercontent.com/8d7db7d1695ba978b770c5345bd3f6eb777e4cb43dd39c7f536c3d36b15ce93e/68747470733a2f2f7472617669732d63692e6f72672f5570436c6f75644c74642f7570636c6f75642d7068702d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/UpCloudLtd/upcloud-php-api)

This PHP API client library provides integration with the UpCloud API allowing operations used to manage resources on UpCloud. The client is a web service interface that uses HTTPS to connect to the API. The API follows the principles of a RESTful web service wherever possible.

The base URL for all API operations is  and require basic authentication using UpCloud username and password. We recommend [creating a subaccount](https://www.upcloud.com/support/server-tags-and-group-accounts/) dedicated for the API communication for security purposes. This allows you to restrict API access by servers, storages, and tags ensuring you will never accidentally affect critical systems.

Table of content
----------------

[](#table-of-content)

- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Issues](#issues)
- [License](#license)

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

[](#requirements)

Using this library requires the PHP version 5.5 and later.

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

[](#installation)

### Composer

[](#composer)

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

```
{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/upcloudltd/upcloud-php-api.git"
    }
  ],
  "require": {
    "upcloudltd/upcloud-php-api": "*@dev"
  }
}

```

Then run `composer install`

### Manual installation

[](#manual-installation)

Download the files and include `autoload.php`:

```
    require_once('/path/to//vendor/autoload.php');
```

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Usage
-----

[](#usage)

Please follow the [installation procedure](#installation--usage) and then run the following (**NOTE**: In real production applications you should use for example ENV variables instead of inserting credentials directly to code and to version control):

```