PHPackages                             swichers/acsf-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. swichers/acsf-client

AbandonedArchivedLibrary[API Development](/categories/api)

swichers/acsf-client
====================

A Client library for Acquia's ACSF platform.

1.0.3(5y ago)8108.1k8[3 issues](https://github.com/swichers/acsf-client/issues)[1 PRs](https://github.com/swichers/acsf-client/pulls)GPL-3.0-or-laterPHPPHP >=7.2

Since Oct 3Pushed 5y ago1 watchersCompare

[ Source](https://github.com/swichers/acsf-client)[ Packagist](https://packagist.org/packages/swichers/acsf-client)[ RSS](/packages/swichers-acsf-client/feed)WikiDiscussions develop Synced 3d ago

READMEChangelog (4)Dependencies (10)Versions (7)Used By (0)

Acquia Cloud Site Factory Client Library
========================================

[](#acquia-cloud-site-factory-client-library)

> A Symfony-based PHP library for working with the ACSF platform.

[![License: GPL v3](https://camo.githubusercontent.com/48bf9b56d44f38db53ce21294cf0b9487d0a3734ab3ba1fe4c69858ae20db2c1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c76332d626c75652e737667)](https://www.gnu.org/licenses/gpl-3.0)[![Build Status](https://camo.githubusercontent.com/a94d82fc05aaed62584a1c6a5566df565599a77d0ec05fe48f7756b4f4e08030/68747470733a2f2f7472617669732d63692e636f6d2f73776963686572732f616373662d636c69656e742e7376673f746f6b656e3d4c6d36675151577342736e7a6f476168324a5859266272616e63683d6d6173746572)](https://travis-ci.com/swichers/acsf-client)[![Codacy Quality](https://camo.githubusercontent.com/9e277fd0994393fcb603ee344af19a20c9bf4394749a102bdb0723fe0587ab6e/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f6638363030626465346636383463663938623832353563383134643735336333)](https://www.codacy.com/manual/swichers/acsf-client)[![Codacy Coverage](https://camo.githubusercontent.com/9ed9cc7e5dada76a39ea9489bb0469be7ee23601e19f9803e0f2f0be43453963/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f436f7665726167652f6638363030626465346636383463663938623832353563383134643735336333)](https://www.codacy.com/manual/swichers/acsf-client)

Acquia Cloud Site Factory is a hosting platform provided by Acquia. The goal of this library is to wrap the ACSF API in such a way that it becomes trivial to leverage it in PHP applications. This library is a significant boon when it comes to streamlining interactions with ACSF. Usage of this library will, among other things, facilitate a much quicker and less error prone deployment process.

**Caution:** Test coverage in this library is around validation of calls to the API, and is not testing interaction with the actual ACSF API. Not all wrapped endpoints have been validated as properly implemented, and live calls to the API may have unexpected results. Review all scripts and calls for proper behavior before executing against a live environment.

Why use this project?
---------------------

[](#why-use-this-project)

You may already be familiar with projects such as [ACSF Tools](https://github.com/acquia/acsf-tools) or the [Acquia CLI](https://github.com/acquia/cli) and be wondering what this project has to offer over those.

FeatureACSF ClientACSF ToolsAcquia CLIPHP library✅❌❌Supports Site Factory✅✅❌Supports Acquia Cloud❌❌✅Complete implementation of ACSF API✅❌❌Complete implementation of Cloud API❌❌✅Can bundle with codebase✅✅❌Can be standalone✅✅✅Designed for scripting✅❌❌Designed for specific tasks❌✅❌The primary use case for this project is creating custom PHP scripts for automating your development and management workflows within ACSF. Anything that you can do within the ACSF UI should be accomplishable through this library.

[![Backporting sites to dev demonstration](https://user-images.githubusercontent.com/5890607/66103462-b6579d00-e56a-11e9-88c3-bc10936afb94.gif)](https://user-images.githubusercontent.com/5890607/66103462-b6579d00-e56a-11e9-88c3-bc10936afb94.gif)

Common tasks that you can use this library to automate:

- Regular complete backups with custom names
- Regular backup pruning for backups meeting certain criteria
- Bbackports/staging to lower environments along with code deploys
- Production deployments, including backups, backports, and deployments
- Recreating domains on lower environments after backports
- Starting a deployment from your CI system

The [examples](examples/) folder contains several scripts that show some common tasks. They can serve as a starting point to build much more complex workflows custom tailored to your project.

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

[](#installation)

**Requirements**

- PHP >= 7.2
- [API access to ACSF](https://docs.acquia.com/site-factory/extend/api/#obtaining-your-api-key)
- Composer for dependency installs

Installation should be straightforward when using composer.

```
composer require swichers/acsf-client
```

Usage
-----

[](#usage)

Many starter scripts are available in the [examples](examples/) folder.

```