README

The official Upsun SDK for PHP. This SDK provides a PHP interface that maps to the Upsun CLI commands.

For more information, read the documentation.

Caution

This project is currently in Beta, meaning features and APIs may evolve over time.

Please report bugs or request new features by creating a GitHub issue.

Installation

Install the SDK via Composer:

composer require upsun/upsun-sdk-php

Then include Composer's autoloader in your PHP application:

require __DIR__ . '/vendor/autoload.php';

Authentication

You will need an Upsun API token to use this SDK. Store it securely, preferably in an environment variable.

use Upsun\UpsunConfig;
use Upsun\UpsunClient;

$config = new UpsunConfig(apiToken: getenv('UPSUN_API_TOKEN'));
$client = new UpsunClient($config);

Usage

Example: List organizations

$organizations = $client->organizations->list();

Example: List projects in an organization

$projects = $client->organizations->listProjects('<organizationId>');

Example: Get a project

$project = $client->projects->get('<projectId>');

Example: Create a project in a specific organization

$project = $client->projects->create(
    '<organizationId>',
    'eu-5.platform.sh',
    'Project title',
    'main',
);

Example: Update a project

$response = $client->projects->update(
    projectId: '<projectId>',
    title: 'new Title',
    description: 'Description'
);

Example: Delete a project

$client->projects->delete('<projectId>');

Development

Clone the repository and install dependencies:

git clone git@github.com:upsun/upsun-sdk-php.git
composer install

Architecture of this SDK

The SDK is built as follows:

• From the JSON specs of our API
• Using @openapitools/openapi-generator-cli
• Which generates:
  • PHP Models (in src/Model/)
  • PHP APIs (in src/Api/)
• Higher-level PHP (Facade) oriented Tasks (in src/Core/Tasks/)

Regenerating API & Model classes

API and Model classes are generated using openapi-generator-cli from the Upsun OpenAPI spec.

composer run spec:install
composer run spec:full

Contributing

Contributions are welcome!
Please open a pull request or an issue for any improvements, bug fixes, or new features.

Full SDK Docs

To see the full SDK docs, for all API and Model classes, please see the following link

Tests

To run the tests, use:

composer install
composer run test

License

This project is licensed under the MIT License. See the LICENSE file for details.