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/pelican-client/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: http
$config = Pelican\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pelican\Client\Api\DatabaseHostApi(
    // 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
);

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

API Endpoints

All URIs are relative to https://game.prepaid-host.com/api/application

Class	Method	HTTP request	Description
DatabaseHostApi	applicationDatabasehosts	GET /database-hosts	List database hosts
DatabaseHostApi	applicationDatabasehostsView	GET /database-hosts/{databaseHost}	View database host
DatabaseHostApi	databaseHostDelete	DELETE /database-hosts/{databaseHost}	Delete database host
DatabaseHostApi	databaseHostStore	POST /database-hosts	Create database host
DatabaseHostApi	databaseHostUpdate	PATCH /database-hosts/{databaseHost}	Update database host
EggApi	applicationEggsEggs	GET /eggs	List eggs
EggApi	applicationEggsEggsExport	GET /eggs/{egg}/export	Export egg
EggApi	applicationEggsEggsView	GET /eggs/{egg}	View egg
MountApi	applicationMounts	GET /mounts	List mounts
MountApi	applicationMountsEggs	POST /mounts/{mount}/eggs	Assign eggs to mount
MountApi	applicationMountsNodes	POST /mounts/{mount}/nodes	Assign nodes to mount
MountApi	applicationMountsServers	POST /mounts/{mount}/servers	Assign servers to mount
MountApi	applicationMountsView	GET /mounts/{mount}	View mount
MountApi	mountDelete	DELETE /mounts/{mount}	Delete mount
MountApi	mountDeleteEgg	DELETE /mounts/{mount}/eggs/{egg_id}	Unassign egg from mount
MountApi	mountDeleteNode	DELETE /mounts/{mount}/nodes/{node_id}	Unassign node from mount
MountApi	mountDeleteServer	DELETE /mounts/{mount}/servers/{server_id}	Unassign server from mount
MountApi	mountGetEggs	GET /mounts/{mount}/eggs	List assigned eggs
MountApi	mountGetNodes	GET /mounts/{mount}/nodes	List assigned nodes
MountApi	mountGetServers	GET /mounts/{mount}/servers	List assigned servers
MountApi	mountStore	POST /mounts	Create mount
MountApi	mountUpdate	PATCH /mounts/{mount}	Update mount
NodeApi	applicationNodes	GET /nodes	List nodes
NodeApi	applicationNodesView	GET /nodes/{node}	View node
NodeApi	nodeDelete	DELETE /nodes/{node}	Delete node
NodeApi	nodeStore	POST /nodes	Create node
NodeApi	nodeUpdate	PATCH /nodes/{node}	Update node
NodeApi	nodesNodeConfiguration	GET /nodes/{node}/configuration	Get node configuration
NodeApi	nodesNodeDeployment	GET /nodes/deployable	Get deployable nodes
NodeAllocationApi	allocationStore	POST /nodes/{node}/allocations	Create allocation
NodeAllocationApi	applicationAllocations	GET /nodes/{node}/allocations	List allocations
NodeAllocationApi	applicationAllocationsView	DELETE /nodes/{node}/allocations/{allocation}	Delete allocation
RoleApi	applicationRoles	GET /roles	List roles
RoleApi	applicationRolesView	GET /roles/{role}	View role
RoleApi	roleDelete	DELETE /roles/{role}	Delete role
RoleApi	roleStore	POST /roles	Create role
RoleApi	roleUpdate	PATCH /roles/{role}	Update role
ServerApi	applicationServers	GET /servers	List servers
ServerApi	applicationServersBuild	PATCH /servers/{server}/build	Update build
ServerApi	applicationServersDetails	PATCH /servers/{server}/details	Update details
ServerApi	applicationServersExternal	GET /servers/external/{external_id}	View server (external id)
ServerApi	applicationServersReinstall	POST /servers/{server}/reinstall	Reinstall
ServerApi	applicationServersServerDelete0	DELETE /servers/{server}/{force}	Delete server
ServerApi	applicationServersServerDelete1	DELETE /servers/{server}	Delete server
ServerApi	applicationServersStartup	PATCH /servers/{server}/startup	Update startup
ServerApi	applicationServersSuspend	POST /servers/{server}/suspend	Suspsend
ServerApi	applicationServersTransfer	POST /servers/{server}/transfer	Start transfer
ServerApi	applicationServersTransferCancel	POST /servers/{server}/transfer/cancel	Cancel transfer
ServerApi	applicationServersUnsuspend	POST /servers/{server}/unsuspend	Unsuspsend
ServerApi	applicationServersView	GET /servers/{server}	View server
ServerApi	serverStore	POST /servers	Create server
ServerDatabaseApi	applicationServersDatabases	GET /servers/{server}/databases	List databases
ServerDatabaseApi	applicationServersDatabasesView	GET /servers/{server}/databases/{database}	View database
ServerDatabaseApi	databaseDelete	DELETE /servers/{server}/databases/{database}	Delete database
ServerDatabaseApi	databaseResetPassword	POST /servers/{server}/databases/{database}/reset-password	Reset password
ServerDatabaseApi	databaseStore	POST /servers/{server}/databases	Create database
UserApi	applicationUsers	GET /users	List users
UserApi	applicationUsersExternal	GET /users/external/{externalId}	View user (external id)
UserApi	applicationUsersView	GET /users/{user}	View user
UserApi	userAssignRoles	PATCH /users/{user}/roles/assign	Assign role to user
UserApi	userDelete	DELETE /users/{user}	Delete user
UserApi	userRemoveRoles	PATCH /users/{user}/roles/remove	Unassign role from user
UserApi	userStore	POST /users	Create user
UserApi	userUpdate	PATCH /users/{user}	Update user

Models

Authorization

Authentication schemes defined for the API:

http

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: 1.0
- Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

c-sakel / pelican-client

Maintainers

Details