README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: bearerAuth
$config = CoolifyPHP\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new CoolifyPHP\Client\Api\ApplicationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_dockercompose_application_request = new \CoolifyPHP\Client\Model\CreateDockercomposeApplicationRequest(); // \CoolifyPHP\Client\Model\CreateDockercomposeApplicationRequest | Application object that needs to be created.

try {
    $result = $apiInstance->createDockercomposeApplication($create_dockercompose_application_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->createDockercomposeApplication: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://app.coolify.io/api/v1

Class	Method	HTTP request	Description
ApplicationsApi	createDockercomposeApplication	POST /applications/dockercompose	Create (Docker Compose)
ApplicationsApi	createDockerfileApplication	POST /applications/dockerfile	Create (Dockerfile)
ApplicationsApi	createDockerimageApplication	POST /applications/dockerimage	Create (Docker Image)
ApplicationsApi	createEnvByApplicationUuid	POST /applications/{uuid}/envs	Create Env
ApplicationsApi	createPrivateDeployKeyApplication	POST /applications/private-deploy-key	Create (Private - Deploy Key)
ApplicationsApi	createPrivateGithubAppApplication	POST /applications/private-github-app	Create (Private - GH App)
ApplicationsApi	createPublicApplication	POST /applications/public	Create (Public)
ApplicationsApi	deleteApplicationByUuid	DELETE /applications/{uuid}	Delete
ApplicationsApi	deleteEnvByApplicationUuid	DELETE /applications/{uuid}/envs/{env_uuid}	Delete Env
ApplicationsApi	getApplicationByUuid	GET /applications/{uuid}	Get
ApplicationsApi	getApplicationLogsByUuid	GET /applications/{uuid}/logs	Get application logs.
ApplicationsApi	listApplications	GET /applications	List
ApplicationsApi	listEnvsByApplicationUuid	GET /applications/{uuid}/envs	List Envs
ApplicationsApi	restartApplicationByUuid	GET /applications/{uuid}/restart	Restart
ApplicationsApi	startApplicationByUuid	GET /applications/{uuid}/start	Start
ApplicationsApi	stopApplicationByUuid	GET /applications/{uuid}/stop	Stop
ApplicationsApi	updateApplicationByUuid	PATCH /applications/{uuid}	Update
ApplicationsApi	updateEnvByApplicationUuid	PATCH /applications/{uuid}/envs	Update Env
ApplicationsApi	updateEnvsByApplicationUuid	PATCH /applications/{uuid}/envs/bulk	Update Envs (Bulk)
DatabasesApi	createDatabaseClickhouse	POST /databases/clickhouse	Create (Clickhouse)
DatabasesApi	createDatabaseDragonfly	POST /databases/dragonfly	Create (DragonFly)
DatabasesApi	createDatabaseKeydb	POST /databases/keydb	Create (KeyDB)
DatabasesApi	createDatabaseMariadb	POST /databases/mariadb	Create (MariaDB)
DatabasesApi	createDatabaseMongodb	POST /databases/mongodb	Create (MongoDB)
DatabasesApi	createDatabaseMysql	POST /databases/mysql	Create (MySQL)
DatabasesApi	createDatabasePostgresql	POST /databases/postgresql	Create (PostgreSQL)
DatabasesApi	createDatabaseRedis	POST /databases/redis	Create (Redis)
DatabasesApi	deleteDatabaseByUuid	DELETE /databases/{uuid}	Delete
DatabasesApi	getDatabaseByUuid	GET /databases/{uuid}	Get
DatabasesApi	listDatabases	GET /databases	List
DatabasesApi	restartDatabaseByUuid	GET /databases/{uuid}/restart	Restart
DatabasesApi	startDatabaseByUuid	GET /databases/{uuid}/start	Start
DatabasesApi	stopDatabaseByUuid	GET /databases/{uuid}/stop	Stop
DatabasesApi	updateDatabaseByUuid	PATCH /databases/{uuid}	Update
DefaultApi	disableApi	GET /disable	Disable API
DefaultApi	enableApi	GET /enable	Enable API
DefaultApi	healthcheck	GET /health	Healthcheck
DefaultApi	version	GET /version	Version
DeploymentsApi	deployByTagOrUuid	GET /deploy	Deploy
DeploymentsApi	getDeploymentByUuid	GET /deployments/{uuid}	Get
DeploymentsApi	listDeployments	GET /deployments	List
DeploymentsApi	listDeploymentsByAppUuid	GET /deployments/applications/{uuid}	List application deployments
PrivateKeysApi	createPrivateKey	POST /security/keys	Create
PrivateKeysApi	deletePrivateKeyByUuid	DELETE /security/keys/{uuid}	Delete
PrivateKeysApi	getPrivateKeyByUuid	GET /security/keys/{uuid}	Get
PrivateKeysApi	listPrivateKeys	GET /security/keys	List
PrivateKeysApi	updatePrivateKey	PATCH /security/keys	Update
ProjectsApi	createProject	POST /projects	Create
ProjectsApi	deleteProjectByUuid	DELETE /projects/{uuid}	Delete
ProjectsApi	getEnvironmentByNameOrUuid	GET /projects/{uuid}/{environment_name_or_uuid}	Environment
ProjectsApi	getProjectByUuid	GET /projects/{uuid}	Get
ProjectsApi	listProjects	GET /projects	List
ProjectsApi	updateProjectByUuid	PATCH /projects/{uuid}	Update
ResourcesApi	listResources	GET /resources	List
ServersApi	createServer	POST /servers	Create
ServersApi	deleteServerByUuid	DELETE /servers/{uuid}	Delete
ServersApi	getDomainsByServerUuid	GET /servers/{uuid}/domains	Domains
ServersApi	getResourcesByServerUuid	GET /servers/{uuid}/resources	Resources
ServersApi	getServerByUuid	GET /servers/{uuid}	Get
ServersApi	listServers	GET /servers	List
ServersApi	updateServerByUuid	PATCH /servers/{uuid}	Update
ServersApi	validateServerByUuid	GET /servers/{uuid}/validate	Validate
ServicesApi	createEnvByServiceUuid	POST /services/{uuid}/envs	Create Env
ServicesApi	createService	POST /services	Create service
ServicesApi	deleteEnvByServiceUuid	DELETE /services/{uuid}/envs/{env_uuid}	Delete Env
ServicesApi	deleteServiceByUuid	DELETE /services/{uuid}	Delete
ServicesApi	getServiceByUuid	GET /services/{uuid}	Get
ServicesApi	listEnvsByServiceUuid	GET /services/{uuid}/envs	List Envs
ServicesApi	listServices	GET /services	List
ServicesApi	restartServiceByUuid	GET /services/{uuid}/restart	Restart
ServicesApi	startServiceByUuid	GET /services/{uuid}/start	Start
ServicesApi	stopServiceByUuid	GET /services/{uuid}/stop	Stop
ServicesApi	updateEnvByServiceUuid	PATCH /services/{uuid}/envs	Update Env
ServicesApi	updateEnvsByServiceUuid	PATCH /services/{uuid}/envs/bulk	Update Envs (Bulk)
ServicesApi	updateServiceByUuid	PATCH /services/{uuid}	Update
TeamsApi	getCurrentTeam	GET /teams/current	Authenticated Team
TeamsApi	getCurrentTeamMembers	GET /teams/current/members	Authenticated Team Members
TeamsApi	getMembersByTeamId	GET /teams/{id}/members	Members
TeamsApi	getTeamById	GET /teams/{id}	Get
TeamsApi	listTeams	GET /teams	List

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.1
- Generator version: 7.14.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpClientCodegen

fozbek / coolify-php-sdk

Maintainers

Details