README

Laravel Forge - API Documentation

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 OAuth2 access token for authorization: oauth2
$config = Dimer47\LaravelForgeSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Dimer47\LaravelForgeSdk\Api\BackgroundProcessesApi(
    // 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
);
$organization = 'organization_example'; // string | The organization slug
$server = 56; // int | The server ID
$background_process = 56; // int | The background process ID

try {
    $apiInstance->organizationsServersBackgroundProcessesDestroy($organization, $server, $background_process);
} catch (Exception $e) {
    echo 'Exception when calling BackgroundProcessesApi->organizationsServersBackgroundProcessesDestroy: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://forge.laravel.com/api

Class	Method	HTTP request	Description
BackgroundProcessesApi	organizationsServersBackgroundProcessesDestroy	DELETE /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}	Delete background process
BackgroundProcessesApi	organizationsServersBackgroundProcessesIndex	GET /orgs/{organization}/servers/{server}/background-processes	List background processes
BackgroundProcessesApi	organizationsServersBackgroundProcessesLogShow	GET /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/log	Get background process log
BackgroundProcessesApi	organizationsServersBackgroundProcessesShow	GET /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}	Get background process
BackgroundProcessesApi	organizationsServersBackgroundProcessesStore	POST /orgs/{organization}/servers/{server}/background-processes	Create background process
BackgroundProcessesApi	organizationsServersBackgroundProcessesUpdate	PUT /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}	Update background process
BackupsApi	organizationsServersDatabaseBackupsDestroy	DELETE /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}	Delete backup configuration
BackupsApi	organizationsServersDatabaseBackupsIndex	GET /orgs/{organization}/servers/{server}/database/backups	List backup configurations
BackupsApi	organizationsServersDatabaseBackupsInstancesDestroy	DELETE /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}	Delete backup
BackupsApi	organizationsServersDatabaseBackupsInstancesIndex	GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances	List backups
BackupsApi	organizationsServersDatabaseBackupsInstancesRestoresStore	POST /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}/restores	Create a database restore from backup
BackupsApi	organizationsServersDatabaseBackupsInstancesShow	GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}	Get backup
BackupsApi	organizationsServersDatabaseBackupsInstancesStore	POST /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances	Create backup
BackupsApi	organizationsServersDatabaseBackupsShow	GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}	Get backup configuration
BackupsApi	organizationsServersDatabaseBackupsStore	POST /orgs/{organization}/servers/{server}/database/backups	Create backup configuration
BackupsApi	organizationsServersDatabaseBackupsUpdate	PUT /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}	Update backup configuration
CommandsApi	organizationsServersSitesCommandsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/commands/{command}	Delete command
CommandsApi	organizationsServersSitesCommandsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/commands	List commands
CommandsApi	organizationsServersSitesCommandsOutputShow	GET /orgs/{organization}/servers/{server}/sites/{site}/commands/{command}/output	Get command output
CommandsApi	organizationsServersSitesCommandsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/commands/{command}	Get command
CommandsApi	organizationsServersSitesCommandsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/commands	Create command
DatabasesApi	organizationsServersDatabasePasswordUpdate	PUT /orgs/{organization}/servers/{server}/database/password	Update the password for the database
DatabasesApi	organizationsServersDatabaseSchemasDestroy	DELETE /orgs/{organization}/servers/{server}/database/schemas/{database}	Delete database schema
DatabasesApi	organizationsServersDatabaseSchemasIndex	GET /orgs/{organization}/servers/{server}/database/schemas	List database schemas
DatabasesApi	organizationsServersDatabaseSchemasShow	GET /orgs/{organization}/servers/{server}/database/schemas/{database}	Get database schema
DatabasesApi	organizationsServersDatabaseSchemasStore	POST /orgs/{organization}/servers/{server}/database/schemas	Create database schema
DatabasesApi	organizationsServersDatabaseSchemasSynchronizationsStore	POST /orgs/{organization}/servers/{server}/database/schemas/synchronizations	Update database schemas
DatabasesApi	organizationsServersDatabaseUsersDestroy	DELETE /orgs/{organization}/servers/{server}/database/users/{databaseUser}	Delete database user
DatabasesApi	organizationsServersDatabaseUsersIndex	GET /orgs/{organization}/servers/{server}/database/users	List database users
DatabasesApi	organizationsServersDatabaseUsersShow	GET /orgs/{organization}/servers/{server}/database/users/{databaseUser}	Get database user
DatabasesApi	organizationsServersDatabaseUsersStore	POST /orgs/{organization}/servers/{server}/database/users	Create database user
DatabasesApi	organizationsServersDatabaseUsersUpdate	PUT /orgs/{organization}/servers/{server}/database/users/{databaseUser}	Update database user
DeploymentsApi	organizationsServersSitesDeployKeyDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/deploy-key	Delete deploy key
DeploymentsApi	organizationsServersSitesDeployKeyShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deploy-key	Get deploy key
DeploymentsApi	organizationsServersSitesDeployKeyStore	POST /orgs/{organization}/servers/{server}/sites/{site}/deploy-key	Create deploy key
DeploymentsApi	organizationsServersSitesDeploymentsDeployHookShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook	Get the deployment trigger URL
DeploymentsApi	organizationsServersSitesDeploymentsDeployHookUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook	Update deployment trigger URL
DeploymentsApi	organizationsServersSitesDeploymentsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments	List deployments
DeploymentsApi	organizationsServersSitesDeploymentsLogShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}/log	Get deployment output
DeploymentsApi	organizationsServersSitesDeploymentsPushToDeployDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy	Delete push to deploy configuration
DeploymentsApi	organizationsServersSitesDeploymentsPushToDeployStore	POST /orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy	Create push to deploy configuration
DeploymentsApi	organizationsServersSitesDeploymentsScriptShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/script	Get deployment script
DeploymentsApi	organizationsServersSitesDeploymentsScriptUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/deployments/script	Update deployment script
DeploymentsApi	organizationsServersSitesDeploymentsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}	Get deployment
DeploymentsApi	organizationsServersSitesDeploymentsStatusDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/deployments/status	Update deployment state
DeploymentsApi	organizationsServersSitesDeploymentsStatusShow	GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/status	Get deployment status
DeploymentsApi	organizationsServersSitesDeploymentsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/deployments	Create deployment
DeploymentsApi	organizationsServersSitesWebhooksDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}	Delete site webhook
DeploymentsApi	organizationsServersSitesWebhooksIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/webhooks	List site webhooks
DeploymentsApi	organizationsServersSitesWebhooksShow	GET /orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}	Get site webhook
DeploymentsApi	organizationsServersSitesWebhooksStore	POST /orgs/{organization}/servers/{server}/sites/{site}/webhooks	Create site webhook
FirewallRulesApi	organizationsServersFirewallRulesDestroy	DELETE /orgs/{organization}/servers/{server}/firewall-rules/{rule}	Delete server firewall rule
FirewallRulesApi	organizationsServersFirewallRulesIndex	GET /orgs/{organization}/servers/{server}/firewall-rules	List server firewall rules
FirewallRulesApi	organizationsServersFirewallRulesShow	GET /orgs/{organization}/servers/{server}/firewall-rules/{rule}	Get server firewall rule
FirewallRulesApi	organizationsServersFirewallRulesStore	POST /orgs/{organization}/servers/{server}/firewall-rules	Create server firewall rule
IntegrationsApi	organizationsServersSitesIntegrationsHorizonDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon	Delete Laravel Horizon integration
IntegrationsApi	organizationsServersSitesIntegrationsHorizonShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon	Get Laravel Horizon integration status
IntegrationsApi	organizationsServersSitesIntegrationsHorizonStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon	Create Laravel Horizon integration
IntegrationsApi	organizationsServersSitesIntegrationsInertiaShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia	Get Inertia integration status
IntegrationsApi	organizationsServersSitesIntegrationsInertiaStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia	Create Inertia integration
IntegrationsApi	organizationsServersSitesIntegrationsLaravelMaintenanceDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance	Delete Laravel Maintenance integration
IntegrationsApi	organizationsServersSitesIntegrationsLaravelMaintenanceShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance	Get Laravel Maintenance integration status
IntegrationsApi	organizationsServersSitesIntegrationsLaravelMaintenanceStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance	Create Laravel Maintenance integration
IntegrationsApi	organizationsServersSitesIntegrationsLaravelSchedulerDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler	Delete Laravel Scheduler integration job
IntegrationsApi	organizationsServersSitesIntegrationsLaravelSchedulerShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler	Get Laravel Scheduler integration job
IntegrationsApi	organizationsServersSitesIntegrationsLaravelSchedulerStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler	Create Laravel Scheduler integration job
IntegrationsApi	organizationsServersSitesIntegrationsOctaneDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/octane	Delete Laravel Octane integration
IntegrationsApi	organizationsServersSitesIntegrationsOctaneShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/octane	Get Laravel Octane integration status
IntegrationsApi	organizationsServersSitesIntegrationsOctaneStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/octane	Create Laravel Octane integration
IntegrationsApi	organizationsServersSitesIntegrationsPulseDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse	Delete Laravel Pulse integration
IntegrationsApi	organizationsServersSitesIntegrationsPulseShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse	Get Laravel Pulse integration status
IntegrationsApi	organizationsServersSitesIntegrationsPulseStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse	Create Laravel Pulse integration
IntegrationsApi	organizationsServersSitesIntegrationsReverbDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb	Delete Laravel Reverb integration
IntegrationsApi	organizationsServersSitesIntegrationsReverbShow	GET /orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb	Get Laravel Reverb integration status
IntegrationsApi	organizationsServersSitesIntegrationsReverbStore	POST /orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb	Create Laravel Reverb integration
LogsApi	organizationsServersLogsDestroy	DELETE /orgs/{organization}/servers/{server}/logs/{key}	Delete server log content
LogsApi	organizationsServersLogsShow	GET /orgs/{organization}/servers/{server}/logs/{key}	Get server log content
MonitorsApi	organizationsServersMonitorsDestroy	DELETE /orgs/{organization}/servers/{server}/monitors/{monitor}	Delete server monitor
MonitorsApi	organizationsServersMonitorsIndex	GET /orgs/{organization}/servers/{server}/monitors	List server monitors
MonitorsApi	organizationsServersMonitorsShow	GET /orgs/{organization}/servers/{server}/monitors/{monitor}	Get server monitor
MonitorsApi	organizationsServersMonitorsStore	POST /orgs/{organization}/servers/{server}/monitors	Create server monitor
NginxApi	organizationsServersNginxTemplatesDestroy	DELETE /orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}	Delete Nginx template
NginxApi	organizationsServersNginxTemplatesIndex	GET /orgs/{organization}/servers/{server}/nginx/templates	List Nginx templates
NginxApi	organizationsServersNginxTemplatesShow	GET /orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}	Get Nginx template
NginxApi	organizationsServersNginxTemplatesStore	POST /orgs/{organization}/servers/{server}/nginx/templates	Create Nginx template
NginxApi	organizationsServersNginxTemplatesUpdate	PUT /orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}	Update Nginx template
OrganizationsApi	organizationsIndex	GET /orgs	List organizations
OrganizationsApi	organizationsServerCredentialsIndex	GET /orgs/{organization}/server-credentials	List server credentials
OrganizationsApi	organizationsServerCredentialsShow	GET /orgs/{organization}/server-credentials/{credential}	Get server credential
OrganizationsApi	organizationsServerCredentialsVpcsIndex	GET /orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs	List VPCs
OrganizationsApi	organizationsServerCredentialsVpcsShow	GET /orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs/{vpcId}	Get VPC
OrganizationsApi	organizationsServerCredentialsVpcsStore	POST /orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs	Create a new VPC
OrganizationsApi	organizationsShow	GET /orgs/{organization}	Get organization
ProvidersApi	providersIndex	GET /providers	List providers
ProvidersApi	providersRegionsIndex	GET /providers/{provider}/regions	List provider regions
ProvidersApi	providersRegionsShow	GET /providers/{provider}/regions/{providerRegion}	Get provider region
ProvidersApi	providersRegionsSizesIndex	GET /providers/{provider}/regions/{providerRegion}/sizes	List provider region sizes
ProvidersApi	providersRegionsSizesShow	GET /providers/{provider}/regions/{providerRegion}/sizes/{providerSize}	Get provider region size
ProvidersApi	providersShow	GET /providers/{provider}	Get provider
ProvidersApi	providersSizesIndex	GET /providers/{provider}/sizes	List provider sizes
ProvidersApi	providersSizesShow	GET /providers/{provider}/sizes/{providerSize}	Get provider size
RecipesApi	forgeRecipesIndex	GET /forge-recipes	List Forge's recipes
RecipesApi	forgeRecipesRunsStore	POST /forge-recipes/{forgeRecipe}/runs	Create Forge recipe run
RecipesApi	forgeRecipesShow	GET /forge-recipes/{forgeRecipe}	Get Forge recipe
RecipesApi	organizationRecipesStore	POST /orgs/{organization}/recipes	Create recipe
RecipesApi	organizationsRecipesDestroy	DELETE /orgs/{organization}/recipes/{recipe}	Delete recipe
RecipesApi	organizationsRecipesIndex	GET /orgs/{organization}/recipes	List organization recipes
RecipesApi	organizationsRecipesRunsIndex	GET /orgs/{organization}/recipes/{recipe}/runs	List recipe runs
RecipesApi	organizationsRecipesRunsShow	GET /orgs/{organization}/recipes/{recipe}/runs/{log}	Get recipe run
RecipesApi	organizationsRecipesRunsStore	POST /orgs/{organization}/recipes/{recipe}/runs	Create recipe run
RecipesApi	organizationsRecipesShow	GET /orgs/{organization}/recipes/{recipe}	Get recipe
RecipesApi	organizationsRecipesUpdate	PUT /orgs/{organization}/recipes/{recipe}	Update recipe
RecipesApi	organizationsTeamsRecipesDestroy	DELETE /orgs/{organization}/teams/{team}/recipes/{recipe}	Delete a recipe share
RecipesApi	organizationsTeamsRecipesIndex	GET /orgs/{organization}/teams/{team}/recipes	List team recipes
RecipesApi	organizationsTeamsRecipesStore	POST /orgs/{organization}/teams/{team}/recipes	Share recipe with the team
RedirectRulesApi	organizationsServersSitesRedirectRulesDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}	Delete site redirect rule
RedirectRulesApi	organizationsServersSitesRedirectRulesIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/redirect-rules	List site redirect rules
RedirectRulesApi	organizationsServersSitesRedirectRulesShow	GET /orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}	Get site redirect rule
RedirectRulesApi	organizationsServersSitesRedirectRulesStore	POST /orgs/{organization}/servers/{server}/sites/{site}/redirect-rules	Create site redirect rule
RolesApi	organizationsRolesDestroy	DELETE /orgs/{organization}/roles/{role}	Delete role
RolesApi	organizationsRolesIndex	GET /orgs/{organization}/roles	List roles
RolesApi	organizationsRolesPermissionsIndex	GET /orgs/{organization}/roles/{role}/permissions	List role permissions
RolesApi	organizationsRolesShow	GET /orgs/{organization}/roles/{role}	Get role
RolesApi	organizationsRolesStore	POST /orgs/{organization}/roles	Create role
RolesApi	organizationsRolesUpdate	PUT /orgs/{organization}/roles/{role}	Update role
RolesApi	permissionsIndex	GET /permissions	List permissions
RolesApi	permissionsShow	GET /permissions/{permission}	Get permission
RolesApi	predefinedRolesIndex	GET /predefined-roles	List predefined roles
RolesApi	predefinedRolesShow	GET /predefined-roles/{role}	Get predefined role
SSHKeysApi	organizationsServersKeyShow	GET /orgs/{organization}/servers/{server}/key	Get server public SSH key
SSHKeysApi	organizationsServersKeyUpdate	PUT /orgs/{organization}/servers/{server}/key	Update server public SSH key
SSHKeysApi	organizationsServersSshKeysDestroy	DELETE /orgs/{organization}/servers/{server}/ssh-keys/{key}	Delete server SSH key
SSHKeysApi	organizationsServersSshKeysIndex	GET /orgs/{organization}/servers/{server}/ssh-keys	List server SSH keys
SSHKeysApi	organizationsServersSshKeysShow	GET /orgs/{organization}/servers/{server}/ssh-keys/{key}	Get server SSH key
SSHKeysApi	organizationsServersSshKeysStore	POST /orgs/{organization}/servers/{server}/ssh-keys	Create server SSH key
ScheduledJobsApi	organizationsServersScheduledJobsDestroy	DELETE /orgs/{organization}/servers/{server}/scheduled-jobs/{job}	Delete scheduled job
ScheduledJobsApi	organizationsServersScheduledJobsIndex	GET /orgs/{organization}/servers/{server}/scheduled-jobs	List server scheduled jobs
ScheduledJobsApi	organizationsServersScheduledJobsOutputsShow	GET /orgs/{organization}/servers/{server}/scheduled-jobs/{job}/output	Get scheduled job output
ScheduledJobsApi	organizationsServersScheduledJobsShow	GET /orgs/{organization}/servers/{server}/scheduled-jobs/{job}	Get scheduled job
ScheduledJobsApi	organizationsServersScheduledJobsStore	POST /orgs/{organization}/servers/{server}/scheduled-jobs	Create scheduled job
ScheduledJobsApi	organizationsServersSitesScheduledJobsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/scheduled-jobs/{job}	Delete site scheduled job
ScheduledJobsApi	organizationsServersSitesScheduledJobsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/scheduled-jobs	List site scheduled jobs
ScheduledJobsApi	organizationsServersSitesScheduledJobsOutputsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/scheduled-jobs/{job}/output	Get site scheduled job output
ScheduledJobsApi	organizationsServersSitesScheduledJobsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/scheduled-jobs/{job}	Get site scheduled job
ScheduledJobsApi	organizationsServersSitesScheduledJobsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/scheduled-jobs	Create site scheduled job
SecurityRulesApi	organizationsServersSitesSecurityRulesDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}	Delete site security rule
SecurityRulesApi	organizationsServersSitesSecurityRulesIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/security-rules	List site security rules
SecurityRulesApi	organizationsServersSitesSecurityRulesShow	GET /orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}	Get site security rule
SecurityRulesApi	organizationsServersSitesSecurityRulesStore	POST /orgs/{organization}/servers/{server}/sites/{site}/security-rules	Create site security rule
SecurityRulesApi	organizationsServersSitesSecurityRulesUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}	Update site security rule
ServerCredentialsApi	organizationsTeamsServerCredentialsDestroy	DELETE /orgs/{organization}/teams/{team}/server-credentials/{credential}	Delete a server credential share
ServerCredentialsApi	organizationsTeamsServerCredentialsIndex	GET /orgs/{organization}/teams/{team}/server-credentials	List team server credentials
ServerCredentialsApi	organizationsTeamsServerCredentialsStore	POST /orgs/{organization}/teams/{team}/server-credentials	Create a new server credential share
ServersApi	organizationsServersActionsStore	POST /orgs/{organization}/servers/{server}/actions	Create server action
ServersApi	organizationsServersArchivesDestroy	DELETE /orgs/{organization}/servers/archives/{server}	Delete archived server
ServersApi	organizationsServersArchivesIndex	GET /orgs/{organization}/servers/archives	List archived servers
ServersApi	organizationsServersArchivesStore	POST /orgs/{organization}/servers/archives	Create an archived server
ServersApi	organizationsServersBackgroundProcessesActionsStore	POST /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/actions	Perform an action on a server background process
ServersApi	organizationsServersDestroy	DELETE /orgs/{organization}/servers/{server}	Delete server
ServersApi	organizationsServersEventsIndex	GET /orgs/{organization}/servers/{server}/events	List server events
ServersApi	organizationsServersEventsOutputShow	GET /orgs/{organization}/servers/{server}/events/{event}/output	Get server event output
ServersApi	organizationsServersEventsShow	GET /orgs/{organization}/servers/{server}/events/{event}	Get server event
ServersApi	organizationsServersIndex	GET /orgs/{organization}/servers	List servers
ServersApi	organizationsServersNetworkShow	GET /orgs/{organization}/servers/{server}/network	Get server network
ServersApi	organizationsServersNetworkUpdate	PUT /orgs/{organization}/servers/{server}/network	Update server network
ServersApi	organizationsServersPhpCliVersionShow	GET /orgs/{organization}/servers/{server}/php/cli-version	Get PHP CLI version
ServersApi	organizationsServersPhpCliVersionUpdate	PUT /orgs/{organization}/servers/{server}/php/cli-version	Update PHP CLI version
ServersApi	organizationsServersPhpMaxExecutionTimeShow	GET /orgs/{organization}/servers/{server}/php/max-execution-time	Get server PHP max execution time
ServersApi	organizationsServersPhpMaxExecutionTimeUpdate	PUT /orgs/{organization}/servers/{server}/php/max-execution-time	Update server PHP max execution time
ServersApi	organizationsServersPhpMaxUploadSizeShow	GET /orgs/{organization}/servers/{server}/php/max-upload-size	Get server PHP max upload size
ServersApi	organizationsServersPhpMaxUploadSizeUpdate	PUT /orgs/{organization}/servers/{server}/php/max-upload-size	Update server PHP max upload size
ServersApi	organizationsServersPhpOpcacheDestroy	DELETE /orgs/{organization}/servers/{server}/php/opcache	Delete PHP OPcache config
ServersApi	organizationsServersPhpOpcacheShow	GET /orgs/{organization}/servers/{server}/php/opcache	Get server PHP OPcache status
ServersApi	organizationsServersPhpOpcacheStore	POST /orgs/{organization}/servers/{server}/php/opcache	Create PHP OPcache config
ServersApi	organizationsServersPhpSiteVersionShow	GET /orgs/{organization}/servers/{server}/php/site-version	Get PHP site version
ServersApi	organizationsServersPhpSiteVersionUpdate	PUT /orgs/{organization}/servers/{server}/php/site-version	Update PHP site version
ServersApi	organizationsServersPhpVersionsConfigsCliShow	GET /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/cli	Get PHP version CLI config
ServersApi	organizationsServersPhpVersionsConfigsCliUpdate	PUT /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/cli	Update PHP version CLI config
ServersApi	organizationsServersPhpVersionsConfigsFpmShow	GET /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/fpm	Get PHP version FPM config
ServersApi	organizationsServersPhpVersionsConfigsFpmUpdate	PUT /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/fpm	Update PHP version FPM config
ServersApi	organizationsServersPhpVersionsConfigsPoolShow	GET /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/pool	Get PHP version pool config
ServersApi	organizationsServersPhpVersionsConfigsPoolUpdate	PUT /orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/pool	Update PHP version pool config
ServersApi	organizationsServersPhpVersionsDestroy	DELETE /orgs/{organization}/servers/{server}/php/versions/{phpVersion}	Delete installed PHP version
ServersApi	organizationsServersPhpVersionsIndex	GET /orgs/{organization}/servers/{server}/php/versions	List PHP versions for server
ServersApi	organizationsServersPhpVersionsShow	GET /orgs/{organization}/servers/{server}/php/versions/{phpVersion}	Get PHP version
ServersApi	organizationsServersPhpVersionsStore	POST /orgs/{organization}/servers/{server}/php/versions	Install new PHP version
ServersApi	organizationsServersPhpVersionsUpdate	PUT /orgs/{organization}/servers/{server}/php/versions/{phpVersion}	Update installed PHP version
ServersApi	organizationsServersServicesMysqlActionsStore	POST /orgs/{organization}/servers/{server}/services/mysql/actions	Perform MySQL action
ServersApi	organizationsServersServicesNginxActionsStore	POST /orgs/{organization}/servers/{server}/services/nginx/actions	Perform Nginx action
ServersApi	organizationsServersServicesPhpActionsStore	POST /orgs/{organization}/servers/{server}/services/php/actions	Perform PHP action
ServersApi	organizationsServersServicesPostgresActionsStore	POST /orgs/{organization}/servers/{server}/services/postgres/actions	Perform Postgres action
ServersApi	organizationsServersServicesRedisActionsStore	POST /orgs/{organization}/servers/{server}/services/redis/actions	Perform Redis action
ServersApi	organizationsServersServicesSupervisorActionsStore	POST /orgs/{organization}/servers/{server}/services/supervisor/actions	Perform Supervisor action
ServersApi	organizationsServersShow	GET /orgs/{organization}/servers/{server}	Get server
ServersApi	organizationsServersStore	POST /orgs/{organization}/servers	Create server
ServersApi	organizationsServersUpdate	PUT /orgs/{organization}/servers/{server}	Update server
ServersApi	organizationsTeamsServersDestroy	DELETE /orgs/{organization}/teams/{team}/servers/{server}	Delete a server share
ServersApi	organizationsTeamsServersIndex	GET /orgs/{organization}/teams/{team}/servers	List team servers
ServersApi	organizationsTeamsServersStore	POST /orgs/{organization}/teams/{team}/servers	Create a new server share
SitesApi	organizationsServersSitesComposerCredentialsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}	Delete composer credentials for the site
SitesApi	organizationsServersSitesComposerCredentialsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/composer/credentials	Get composer credentials for the site
SitesApi	organizationsServersSitesComposerCredentialsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}	Get composer credential for the site
SitesApi	organizationsServersSitesComposerCredentialsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/composer/credentials	Create composer credentials for the site
SitesApi	organizationsServersSitesComposerCredentialsUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}	Update composer credentials for the site
SitesApi	organizationsServersSitesDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}	Delete site
SitesApi	organizationsServersSitesDomainsActionsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/actions	Create domain action
SitesApi	organizationsServersSitesDomainsCertificateShow	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificate	Get active domain certificate
SitesApi	organizationsServersSitesDomainsCertificatesActionsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}/actions	Create domain certificate action
SitesApi	organizationsServersSitesDomainsCertificatesActive	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/active	Get active domain certificate
SitesApi	organizationsServersSitesDomainsCertificatesDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}	Delete domain certificate
SitesApi	organizationsServersSitesDomainsCertificatesIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates	List domain certificates
SitesApi	organizationsServersSitesDomainsCertificatesShow	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}	Get domain certificate
SitesApi	organizationsServersSitesDomainsCertificatesStore	POST /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates	Create domain certificate
SitesApi	organizationsServersSitesDomainsConfigurations	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/configurations	Get domain DNS configuration
SitesApi	organizationsServersSitesDomainsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}	Delete domain
SitesApi	organizationsServersSitesDomainsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/domains	List domains
SitesApi	organizationsServersSitesDomainsNginxShow	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx	Get domain Nginx configuration
SitesApi	organizationsServersSitesDomainsNginxUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx	Update domain Nginx configuration
SitesApi	organizationsServersSitesDomainsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}	Get domain
SitesApi	organizationsServersSitesDomainsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/domains	Create domain
SitesApi	organizationsServersSitesDomainsUpdate	PATCH /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}	Update domain
SitesApi	organizationsServersSitesEnvironmentShow	GET /orgs/{organization}/servers/{server}/sites/{site}/environment	Get .env content
SitesApi	organizationsServersSitesEnvironmentUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/environment	Update .env content
SitesApi	organizationsServersSitesHealthcheckShow	GET /orgs/{organization}/servers/{server}/sites/{site}/healthcheck	Get healthcheck endpoint
SitesApi	organizationsServersSitesHealthcheckUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/healthcheck	Update healthcheck endpoint
SitesApi	organizationsServersSitesHeartbeatsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}	Delete heartbeat
SitesApi	organizationsServersSitesHeartbeatsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/heartbeats	List heartbeats
SitesApi	organizationsServersSitesHeartbeatsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}	Get heartbeat
SitesApi	organizationsServersSitesHeartbeatsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/heartbeats	Create heartbeat
SitesApi	organizationsServersSitesHeartbeatsUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}	Update heartbeat
SitesApi	organizationsServersSitesIndex	GET /orgs/{organization}/servers/{server}/sites	List sites for server
SitesApi	organizationsServersSitesLoadBalancingNodesIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes	List load balancing nodes
SitesApi	organizationsServersSitesLoadBalancingNodesUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes	Update load balancing nodes
SitesApi	organizationsServersSitesLogsApplicationDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/logs/application	Delete site log content
SitesApi	organizationsServersSitesLogsApplicationShow	GET /orgs/{organization}/servers/{server}/sites/{site}/logs/application	Get site log content
SitesApi	organizationsServersSitesLogsNginxAccessDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access	Delete Nginx access log content
SitesApi	organizationsServersSitesLogsNginxAccessShow	GET /orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access	Get Nginx access log content
SitesApi	organizationsServersSitesLogsNginxErrorDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error	Delete Nginx error log content
SitesApi	organizationsServersSitesLogsNginxErrorShow	GET /orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error	Get Nginx error log content
SitesApi	organizationsServersSitesNginxShow	GET /orgs/{organization}/servers/{server}/sites/{site}/nginx	Get Nginx configuration
SitesApi	organizationsServersSitesNginxUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/nginx	Update Nginx configuration
SitesApi	organizationsServersSitesNpmCredentialsDestroy	DELETE /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}	Delete npm credentials for the site
SitesApi	organizationsServersSitesNpmCredentialsIndex	GET /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials	Get NPM credentials for the site
SitesApi	organizationsServersSitesNpmCredentialsShow	GET /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}	Get NPM credential for the site
SitesApi	organizationsServersSitesNpmCredentialsStore	POST /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials	Create NPM credentials for the site
SitesApi	organizationsServersSitesNpmCredentialsUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}	Update NPM credentials for the site
SitesApi	organizationsServersSitesStore	POST /orgs/{organization}/servers/{server}/sites	Create site
SitesApi	organizationsServersSitesStoreOnBalancer	POST /orgs/{organization}/servers/{server}/sites/balancer	Create site on a load balancer
SitesApi	organizationsServersSitesUpdate	PUT /orgs/{organization}/servers/{server}/sites/{site}	Update site
SitesApi	organizationsSitesIndex	GET /orgs/{organization}/sites	List sites for Organization
SitesApi	organizationsSitesShow	GET /orgs/{organization}/sites/{site}	Get site
SitesApi	sitesIndex	GET /sites	List sites
StorageProvidersApi	organizationsStorageProvidersDestroy	DELETE /orgs/{organization}/storage-providers/{storageConfiguration}	Delete storage provider
StorageProvidersApi	organizationsStorageProvidersIndex	GET /orgs/{organization}/storage-providers	List storage providers
StorageProvidersApi	organizationsStorageProvidersShow	GET /orgs/{organization}/storage-providers/{storageConfiguration}	Get storage provider
StorageProvidersApi	organizationsStorageProvidersStore	POST /orgs/{organization}/storage-providers	Create storage provider
StorageProvidersApi	organizationsStorageProvidersUpdate	PUT /orgs/{organization}/storage-providers/{storageConfiguration}	Update storage provider
TeamsApi	organizationsTeamsDestroy	DELETE /orgs/{organization}/teams/{team}	Delete team
TeamsApi	organizationsTeamsIndex	GET /orgs/{organization}/teams	List teams
TeamsApi	organizationsTeamsInvitesDestroy	DELETE /orgs/{organization}/teams/{team}/invites/{invitation}	Delete team invitation
TeamsApi	organizationsTeamsInvitesIndex	GET /orgs/{organization}/teams/{team}/invites	List team invitations
TeamsApi	organizationsTeamsInvitesShow	GET /orgs/{organization}/teams/{team}/invites/{invitation}	Get team invitation
TeamsApi	organizationsTeamsInvitesStore	POST /orgs/{organization}/teams/{team}/invites	Create team invite
TeamsApi	organizationsTeamsMembersDestroy	DELETE /orgs/{organization}/teams/{team}/members/{user}	Delete team member
TeamsApi	organizationsTeamsMembersIndex	GET /orgs/{organization}/teams/{team}/members	List team members
TeamsApi	organizationsTeamsMembersShow	GET /orgs/{organization}/teams/{team}/members/{user}	Get team member
TeamsApi	organizationsTeamsMembersUpdate	PUT /orgs/{organization}/teams/{team}/members/{user}	Update team member
TeamsApi	organizationsTeamsShow	GET /orgs/{organization}/teams/{team}	Get team
TeamsApi	organizationsTeamsStore	POST /orgs/{organization}/teams	Create team
TeamsApi	organizationsTeamsUpdate	PUT /orgs/{organization}/teams/{team}	Update team
UserApi	me	GET /me	Get user
UserApi	userShow	GET /user	Get user

Models

Authorization

Authentication schemes defined for the API:

http

Type: Bearer authentication

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://forge.laravel.com/oauth/authorize
Scopes:
- organization:view: Allow members to view the organization
- organization:manage: Allow members to manage the organization
- organization:delete: Allow members to delete the organization
- server:view: Allow members to view servers
- server:create: Allow members to create servers
- server:delete: Allow members to delete servers
- server:archive: Allow members to archive servers
- server:transfer: Allow members to transfer servers to another Forge account
- server:manage-meta: Allow members to change server settings such as name and IP address
- server:manage-packages: Allow members to configure and remove server and site package authentication
- server:manage-php: Allow members to install and change PHP installations
- server:manage-logs: Allow members to clear server and site logs
- server:manage-network: Allow members to change the server‘s firewall
- server:manage-nginx-templates: Allow members to manage Nginx templates
- server:manage-services: Allow members to start, stop and restart services
- server:manage-password: Allow members to reset the sudo password
- server:create-keys: Allow members to add SSH keys to servers
- server:delete-keys: Allow members to remove SSH keys from servers
- server:create-monitors: Allow members to create server monitors
- server:delete-monitors: Allow members to delete server monitors
- server:create-databases: Allow members to create databases and database users
- server:delete-databases: Allow members to delete databases and database users
- server:create-backups: Allow members to create database backup configurations
- server:delete-backups: Allow members to delete database backup configurations
- server:create-daemons: Allow members to create daemons
- server:delete-daemons: Allow members to delete daemons
- server:create-schedulers: Allow members to create scheduled jobs
- server:delete-schedulers: Allow members to delete scheduled jobs
- server:web-terminal: Allow members to start web terminal sessions
- site:create: Allow members to create sites
- site:delete: Allow members to delete sites
- site:meta: Allow members to update site meta data such as domain name and aliases
- site:manage-commands: Allow members to run arbitrary commands from the site‘s root directory
- site:manage-deploys: Allow members to deploy the site and update the deployment script
- site:manage-nginx: Allow members to manage the site‘s Nginx configuration file
- site:manage-project: Allow members to install Git repositories, phpMyAdmin and WordPress applications
- site:manage-environment: Allow members to update the site‘s environment file
- site:manage-notifications: Allow members to configure deployment notifications
- site:manage-queues: Allow members to configure queue workers
- site:manage-redirects: Allow members to configure URL redirects
- site:manage-security: Allow members to configure HTTP Basic Authentication
- site:manage-ssl: Allow members to configure SSL and Let‘s Encrypt certificates
- site:manage-integrations: Allow members to manage site integrations
- site:manage-heartbeats: Allow members to manage heartbeats
- credential:view: Allow members to view credentials
- credential:manage: Allow members to manage credentials
- team:view: Allow members to view teams
- team:create: Allow members to create teams
- team:delete: Allow members to delete teams and team members
- recipe:view: Allow members to view recipes
- recipe:manage: Allow members to manage recipes
- billing:manage: Allow members to manage the organization's subscription
- storage:manage: Allow members to manage the organization's storage providers.
- integrations:manage: Allow members to manage the organization's integrations
- user:view: Allow members to view user details
- resources:view: Allow members to view resources
- resources:create-databases: Allow members to create managed database clusters
- resources:delete-databases: Allow members to delete managed database clusters
- resources:manage-databases: Allow members to manage managed database cluster settings

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

dimer47 / laravel-forge-sdk

Maintainers

Package info

Statistics

Security