PHPackages                             art-of-wifi/unifi-cloud-api-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. [API Development](/categories/api)
4. /
5. art-of-wifi/unifi-cloud-api-client

ActiveLibrary[API Development](/categories/api)

art-of-wifi/unifi-cloud-api-client
==================================

A PHP client for the Official UniFi Cloud API

v1.0.5(1y ago)21380↓50%4MITPHPPHP >=8.1

Since Jul 24Pushed 8mo ago2 watchersCompare

[ Source](https://github.com/Art-of-WiFi/UniFi-Cloud-API-client)[ Packagist](https://packagist.org/packages/art-of-wifi/unifi-cloud-api-client)[ Docs](https://github.com/Art-of-WiFi/UniFi-Cloud-API-client)[ RSS](/packages/art-of-wifi-unifi-cloud-api-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)Dependencies (2)Versions (7)Used By (0)

API client class for Official UniFi Cloud API
=============================================

[](#api-client-class-for-official-unifi-cloud-api)

A PHP class that provides access to Ubiquiti's official [UniFi Cloud API](https://developer.ui.com/unifi-api/)for their [Site Manager](https://unifi.ui.com) platform.

Introduction
------------

[](#introduction)

This client provides a modern and convenient way to interact with the official UniFi Cloud API using PHP. It uses Guzzle for HTTP requests and supports various operations to interact with UniFi deployments programmatically.

This client supports the official UniFi Cloud API up to version **0.1**.

### Important Note

[](#important-note)

This is **not** a replacement for our original API Client which offers more functions and endpoints, but does not support connections through unifi.ui.com:

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

[](#requirements)

- a server with:
    - PHP **8.1** or higher installed.
    - the **php-curl** module installed and enabled.
- direct network connectivity between this server and  where the UniFi Cloud API is hosted.
- an API key that can be obtained as follows:
    - Sign in to the UniFi Site Manager at .
    - From the left navigation bar, click on **API**.
    - Click **Create API Key**.
    - Copy the key and store it securely, as it will only be displayed once.
    - Click **Done** to ensure the key is hashed and securely stored.

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

[](#installation)

The package needs to be installed using Composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-cloud-api-client)for easy inclusion in your projects by executing the following command from your project directory:

```
composer require art-of-wifi/unifi-cloud-api-client
```

Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you don't have Composer installed already.

---

Developer Documentation
=======================

[](#developer-documentation)

Usage
-----

[](#usage)

Below is a basic example of how to use the UniFi Cloud API Client:

```