Go API client for Laravel Forge

The Laravel Forge API allows you to create and interact with servers and sites on Laravel Forge through a simple REST API.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 0.0.3
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./forge"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	ActivateCertificate	Post /servers/{serverId}/sites/{siteId}/certificates/{id}/activate	Activate Certificate
DefaultApi	AddSiteAliases	Put /servers/{serverId}/sites/{siteId}/aliases	Add Site Aliases
DefaultApi	ChangeSitePHPVersion	Put /servers/{serverId}/sites/{siteId}/php	Change Site PHP Version
DefaultApi	CloningAnExistingCertificate	Post /servers/{serverId}/sites/{siteId}/certificates	Cloning An Existing Certificate
DefaultApi	CreateBackupConfiguration	Post /servers/{serverId}/backup-configs	Create Backup Configuration
DefaultApi	CreateDaemon	Post /servers/{serverId}/daemons	Create Daemon
DefaultApi	CreateDatabase	Post /servers/{serverId}/databases	Create Database
DefaultApi	CreateDatabaseUser	Post /servers/{serverId}/database-users	Create Database User
DefaultApi	CreateDeployKey	Post /servers/{serverId}/sites/{siteId}/deploy-key	Create Deploy Key
DefaultApi	CreateFirewallRule	Post /servers/{serverId}/firewall-rules	Create Firewall Rule
DefaultApi	CreateJob	Post /servers/{serverId}/jobs	Create Job
DefaultApi	CreateKey	Post /servers/{serverId}/keys	Create Key
DefaultApi	CreateMonitor	Post /servers/{serverId}/monitors	Create Monitor
DefaultApi	CreateRecipe	Post /recipes	Create Recipe
DefaultApi	CreateRedirectRule	Post /servers/{serverId}/sites/{siteId}/redirect-rules	Create Redirect Rule
DefaultApi	CreateSecurityRule	Post /servers/{serverId}/sites/{siteId}/security-rules	Create Security Rule
DefaultApi	CreateServer	Post /servers	Create Server
DefaultApi	CreateSite	Post /servers/{serverId}/sites	Create Site
DefaultApi	CreateTemplate	Post /servers/{serverId}/nginx/templates	Create Template
DefaultApi	CreateWebhook	Post /servers/{server_id}/sites/{site_id}/webhooks	Create Webhook
DefaultApi	CreateWorker	Post /servers/{serverId}/sites/{siteId}/workers	Create Worker
DefaultApi	DeleteBackup	Delete /servers/{serverId}/backup-configs/{backupConfigurationId}/backups/{backupId}	Delete Backup
DefaultApi	DeleteBackupConfiguration	Delete /servers/{serverId}/backup-configs/{backupConfigurationId}	Delete Backup Configuration
DefaultApi	DeleteCertificate	Delete /servers/{serverId}/sites/{siteId}/certificates/{id}	Delete Certificate
DefaultApi	DeleteDaemon	Delete /servers/{serverId}/daemons/{daemonId}	Delete Daemon
DefaultApi	DeleteDatabase	Delete /servers/{serverId}/databases/{databaseId}	Delete Database
DefaultApi	DeleteDatabaseUser	Delete /servers/{serverId}/database-users/{userId}	Delete Database User
DefaultApi	DeleteDeployKey	Delete /servers/{serverId}/sites/{siteId}/deploy-key	Delete Deploy Key
DefaultApi	DeleteFirewallRule	Delete /servers/{serverId}/firewall-rules/{ruleId}	Delete Firewall Rule
DefaultApi	DeleteJob	Delete /servers/{serverId}/jobs/{jobId}	Delete Job
DefaultApi	DeleteKey	Delete /servers/{serverId}/keys/{keyId}	Delete Key
DefaultApi	DeleteMonitor	Delete /servers/{serverId}/monitors/{monitorId}	Delete Monitor
DefaultApi	DeleteNginxTemplate	Delete /servers/{serverId}/nginx/templates/{templateId}	Delete Nginx Template
DefaultApi	DeleteRecipe	Delete /recipes/{recipeId}	Delete Recipe
DefaultApi	DeleteRedirectRule	Delete /servers/{serverId}/sites/{siteId}/redirect-rules/{id}	Delete Redirect Rule
DefaultApi	DeleteSecurityRule	Delete /servers/{serverId}/sites/{siteId}/security-rules/{id}	Delete Security Rule
DefaultApi	DeleteServer	Delete /servers/{id}	Delete Server
DefaultApi	DeleteSite	Delete /servers/{serverId}/sites/{siteId}	Delete Site
DefaultApi	DeleteWebhook	Delete /servers/{server_id}/sites/{site_id}/webhooks/{id}	Delete Webhook
DefaultApi	DeleteWorker	Delete /servers/{serverId}/sites/{siteId}/workers/{id}	Delete Worker
DefaultApi	DeployNow	Post /servers/{serverId}/sites/{siteId}/deployment/deploy	Deploy Now
DefaultApi	DisableOPCache	Delete /servers/{serverId}/php/opcache	Disable OPCache
DefaultApi	DisableQuickDeployment	Delete /servers/{serverId}/sites/{siteId}/deployment	Disable Quick Deployment
DefaultApi	EnableOPCache	Post /servers/{serverId}/php/opcache	Enable OPCache
DefaultApi	EnableQuickDeployment	Post /servers/{serverId}/sites/{siteId}/deployment	Enable Quick Deployment
DefaultApi	ExecuteCommand	Post /servers/{serverId}/sites/{siteId}/commands	Execute Command
DefaultApi	GetBackupConfiguration	Get /servers/{serverId}/backup-configs/{backupConfigurationId}	Get Backup Configuration
DefaultApi	GetCertificate	Get /servers/{serverId}/sites/{siteId}/certificates/{id}	Get Certificate
DefaultApi	GetCommand	Get /servers/{serverId}/sites/{siteId}/commands/{commandId}	Get Command
DefaultApi	GetCredentials	Get /credentials	Get Credentials
DefaultApi	GetDaemon	Get /servers/{serverId}/daemons/{daemonId}	Get Daemon
DefaultApi	GetDatabase	Get /servers/{serverId}/databases/{databaseId}	Get Database
DefaultApi	GetDatabaseUser	Get /servers/{serverId}/database-users/{userId}	Get Database User
DefaultApi	GetDeployment	Get /servers/{serverId}/sites/{siteId}/deployment-history/{deploymentId}	Get Deployment
DefaultApi	GetDeploymentLog	Get /servers/{serverId}/sites/{siteId}/deployment/log	Get Deployment Log
DefaultApi	GetDeploymentOutput	Get /servers/{serverId}/sites/{siteId}/deployment-history/{deploymentId}/output	Get Deployment Output
DefaultApi	GetDeploymentScript	Get /servers/{serverId}/sites/{siteId}/deployment/script	Get Deployment Script
DefaultApi	GetEnvFile	Get /servers/{serverId}/sites/{siteId}/env	Get .env File
DefaultApi	GetFirewallRule	Get /servers/{serverId}/firewall-rules/{ruleId}	Get Firewall Rule
DefaultApi	GetJob	Get /servers/{serverId}/jobs/{jobId}	Get Job
DefaultApi	GetKey	Get /servers/{serverId}/keys/{keyId}	Get Key
DefaultApi	GetLog	Get /servers/{serverId}/logs	Get Log
DefaultApi	GetMonitor	Get /servers/{serverId}/monitors/{monitorId}	Get Monitor
DefaultApi	GetNginxConfiguration	Get /servers/{serverId}/sites/{siteId}/nginx	Get Nginx Configuration
DefaultApi	GetNginxTemplate	Get /servers/{serverId}/nginx/templates/{templateId}	Get Nginx Template
DefaultApi	GetRecentEvents	Get /servers/events	Get Recent Events
DefaultApi	GetRecipe	Get /recipes/{recipeId}	Get Recipe
DefaultApi	GetRedirectRule	Get /servers/{serverId}/sites/{siteId}/redirect-rules/{id}	Get Redirect Rule
DefaultApi	GetRegions	Get /regions	Get Regions
DefaultApi	GetSecurityRule	Get /servers/{serverId}/sites/{siteId}/security-rules/{id}	Get Security Rule
DefaultApi	GetServer	Get /servers/{id}	Get Server
DefaultApi	GetSigningRequest	Get /servers/{serverId}/sites/{siteId}/certificates/{id}/csr	Get Signing Request
DefaultApi	GetSite	Get /servers/{serverId}/sites/{siteId}	Get Site
DefaultApi	GetUser	Get /user	Get User
DefaultApi	GetWebhook	Get /servers/{server_id}/sites/{site_id}/webhooks/{id}	Get Webhook
DefaultApi	GetWebhooks	Get /servers/{server_id}/sites/{site_id}/webhooks	Get Webhooks
DefaultApi	GetWorker	Get /servers/{serverId}/sites/{siteId}/workers/{id}	Get Worker
DefaultApi	InstallBlackfire	Post /servers/{id}/blackfire/install	Install Blackfire
DefaultApi	InstallCertificate	Post /servers/{serverId}/sites/{siteId}/certificates/{id}/install	Install Certificate
DefaultApi	InstallNewGitProject	Post /servers/{serverId}/sites/{siteId}/git	Install New Git Project
DefaultApi	InstallPHPVersion	Post /servers/{serverId}/php	Install PHP Version
DefaultApi	InstallPapertrail	Post /servers/{id}/papertrail/install	Install Papertrail
DefaultApi	InstallPhpMyAdmin	Post /servers/{serverId}/sites/{siteId}/phpmyadmin	Install phpMyAdmin
DefaultApi	InstallWordPress	Post /servers/{serverId}/sites/{siteId}/wordpress	Install WordPress
DefaultApi	ListBackupConfigurations	Get /servers/{serverId}/backup-configs	List Backup Configurations
DefaultApi	ListCertificates	Get /servers/{serverId}/sites/{siteId}/certificates	List Certificates
DefaultApi	ListCommandHistory	Get /servers/{serverId}/sites/{siteId}/commands	List Command History
DefaultApi	ListDaemons	Get /servers/{serverId}/daemons	List Daemons
DefaultApi	ListDatabaseUsers	Get /servers/{serverId}/database-users	List Database Users
DefaultApi	ListDatabases	Get /servers/{serverId}/databases	List Databases
DefaultApi	ListDeployments	Get /servers/{serverId}/sites/{siteId}/deployment-history	List Deployments
DefaultApi	ListFirewallRules	Get /servers/{serverId}/firewall-rules	List Firewall Rules
DefaultApi	ListJobs	Get /servers/{serverId}/jobs	List Jobs
DefaultApi	ListKeys	Get /servers/{serverId}/keys	List Keys
DefaultApi	ListMonitors	Get /servers/{serverId}/monitors	List Monitors
DefaultApi	ListNginxTemplates	Get /servers/{serverId}/nginx/templates/default	List Nginx Templates
DefaultApi	ListPHPVersions	Get /servers/{serverId}/php	List PHP Versions
DefaultApi	ListRecipes	Get /recipes	List Recipes
DefaultApi	ListRedirectRules	Get /servers/{serverId}/sites/{siteId}/redirect-rules	List Redirect Rules
DefaultApi	ListSecurityRules	Get /servers/{serverId}/sites/{siteId}/security-rules	List Security Rules
DefaultApi	ListServers	Get /servers	List Servers
DefaultApi	ListSites	Get /servers/{serverId}/sites	List Sites
DefaultApi	ListWorkers	Get /servers/{serverId}/sites/{siteId}/workers	List Workers
DefaultApi	LoadBalancing	Get /servers/{serverId}/sites/{siteId}/balancing	Load Balancing
DefaultApi	ObtainALetsEncryptCertificate	Post /servers/{serverId}/sites/{siteId}/certificates/letsencrypt	Obtain A LetsEncrypt Certificate
DefaultApi	ReactivateRevokedServer	Post /servers/{id}/reactivate	Reactivate revoked server
DefaultApi	RebootMySQL	Post /servers/{id}/mysql/reboot	Reboot MySQL
DefaultApi	RebootNginx	Post /servers/{id}/nginx/reboot	Reboot Nginx
DefaultApi	RebootPHP	Post /servers/{id}/php/reboot	Reboot PHP
DefaultApi	RebootPostgres	Post /servers/{id}/postgres/reboot	Reboot Postgres
DefaultApi	RebootServer	Post /servers/{id}/reboot	Reboot Server
DefaultApi	ReconnectRevokedServer	Post /servers/{id}/reconnect	Reconnect revoked server
DefaultApi	RemoveBlackfire	Delete /servers/{id}/blackfire/remove	Remove Blackfire
DefaultApi	RemovePapertrail	Delete /servers/{id}/papertrail/remove	Remove Papertrail
DefaultApi	RemoveProject	Delete /servers/{serverId}/sites/{siteId}/git	Remove Project
DefaultApi	ResetDeploymentStatus	Post /servers/{serverId}/sites/{siteId}/deployment/reset	Reset Deployment Status
DefaultApi	RestartDaemon	Post /servers/{serverId}/daemons/{daemonId}/restart	Restart Daemon
DefaultApi	RestartService	Post /servers/{id}/services/restart	Restart Service
DefaultApi	RestartWorker	Post /servers/{serverId}/sites/{siteId}/workers/{id}/restart	Restart Worker
DefaultApi	RestoreBackup	Post /servers/{serverId}/backup-configs/{backupConfigurationId}/backups/{backupId}	Restore Backup
DefaultApi	RevokeForgeAccessToServer	Post /servers/{id}/revoke	Revoke Forge access to server
DefaultApi	RunBackupConfiguration	Post /servers/{serverId}/backup-configs/{backupConfigurationId}	Run Backup Configuration
DefaultApi	RunRecipe	Post /recipes/{recipeId}/run	Run Recipe
DefaultApi	SiteLog	Get /servers/{serverId}/sites/{siteId}/logs	Site Log
DefaultApi	StartService	Post /servers/{id}/services/start	Start Service
DefaultApi	StopMySQL	Post /servers/{id}/mysql/stop	Stop MySQL
DefaultApi	StopNginx	Post /servers/{id}/nginx/stop	Stop Nginx
DefaultApi	StopPostgres	Post /servers/{id}/postgres/stop	Stop Postgres
DefaultApi	StopService	Post /servers/{id}/services/stop	Stop Service
DefaultApi	SyncDatabase	Post /servers/{serverId}/databases/sync	Sync Database
DefaultApi	TestNginx	Get /servers/{id}/nginx/test	Test Nginx
DefaultApi	UninstallPhpMyAdmin	Delete /servers/{serverId}/sites/{siteId}/phpmyadmin	Uninstall phpMyAdmin
DefaultApi	UninstallWordPress	Delete /servers/{serverId}/sites/{siteId}/wordpress	Uninstall WordPress
DefaultApi	UpdateBackupConfiguration	Put /servers/{serverId}/backup-configs/{backupConfigurationId}	Update Backup Configuration
DefaultApi	UpdateDatabasePassword	Put /servers/{serverId}/database-password	Update Database Password
DefaultApi	UpdateDatabaseUser	Put /servers/{serverId}/database-users/{userId}	Update Database User
DefaultApi	UpdateDeploymentScript	Put /servers/{serverId}/sites/{siteId}/deployment/script	Update Deployment Script
DefaultApi	UpdateEnvFile	Put /servers/{serverId}/sites/{siteId}/env	Update .env File
DefaultApi	UpdateLoadBalancing	Put /servers/{serverId}/sites/{siteId}/balancing	Update Load Balancing
DefaultApi	UpdateNginxConfiguration	Put /servers/{serverId}/sites/{siteId}/nginx	Update Nginx Configuration
DefaultApi	UpdateNginxTemplate	Put /servers/{serverId}/nginx/templates/{templateId}	Update Nginx Template
DefaultApi	UpdateRecipe	Put /recipes/{recipeId}	Update Recipe
DefaultApi	UpdateRepository	Put /servers/{serverId}/sites/{siteId}/git	Update Repository
DefaultApi	UpdateServer	Put /servers/{id}	Update Server
DefaultApi	UpdateSite	Put /servers/{serverId}/sites/{siteId}	Update Site
DefaultApi	UpgradePHPPatchVersion	Post /servers/{serverId}/php/update	Upgrade PHP Patch Version

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
api		api
docs		docs
.gitignore		.gitignore
.travis.yml		.travis.yml
README.md		README.md
api_default.go		api_default.go
client.go		client.go
configuration.go		configuration.go
git_push.sh		git_push.sh
model_add_site_aliases.go		model_add_site_aliases.go
model_backup.go		model_backup.go
model_certificate.go		model_certificate.go
model_change_site_php_version.go		model_change_site_php_version.go
model_cloning_an_existing_certificate.go		model_cloning_an_existing_certificate.go
model_command.go		model_command.go
model_create_backup_configuration.go		model_create_backup_configuration.go
model_create_certificate.go		model_create_certificate.go
model_create_daemon.go		model_create_daemon.go
model_create_database.go		model_create_database.go
model_create_database_user.go		model_create_database_user.go
model_create_firewall_rule.go		model_create_firewall_rule.go
model_create_job.go		model_create_job.go
model_create_key.go		model_create_key.go
model_create_monitor.go		model_create_monitor.go
model_create_recipe.go		model_create_recipe.go
model_create_redirect_rule.go		model_create_redirect_rule.go
model_create_security_rule.go		model_create_security_rule.go
model_create_server.go		model_create_server.go
model_create_site.go		model_create_site.go
model_create_template.go		model_create_template.go
model_create_worker.go		model_create_worker.go
model_credential.go		model_credential.go
model_daemon.go		model_daemon.go
model_database.go		model_database.go
model_deployment.go		model_deployment.go
model_execute_command.go		model_execute_command.go
model_get_recent_events.go		model_get_recent_events.go
model_inline_response_200.go		model_inline_response_200.go
model_inline_response_200_1.go		model_inline_response_200_1.go
model_install_blackfire.go		model_install_blackfire.go
model_install_certificate.go		model_install_certificate.go
model_install_new_git_project.go		model_install_new_git_project.go
model_install_papertrail.go		model_install_papertrail.go
model_install_php_my_admin.go		model_install_php_my_admin.go
model_install_word_press.go		model_install_word_press.go
model_installing_an_existing_certificate.go		model_installing_an_existing_certificate.go
model_job.go		model_job.go
model_key.go		model_key.go
model_monitor.go		model_monitor.go
model_node.go		model_node.go
model_reboot_php.go		model_reboot_php.go
model_recipe.go		model_recipe.go
model_redirect_rule.go		model_redirect_rule.go
model_regions.go		model_regions.go
model_restore_backup.go		model_restore_backup.go
model_rule.go		model_rule.go
model_run_recipe.go		model_run_recipe.go
model_security_rule.go		model_security_rule.go
model_server.go		model_server.go
model_site.go		model_site.go
model_template.go		model_template.go
model_update_backup_configuration.go		model_update_backup_configuration.go
model_update_database_password.go		model_update_database_password.go
model_update_database_user.go		model_update_database_user.go
model_update_deployment_script.go		model_update_deployment_script.go
model_update_env_file.go		model_update_env_file.go
model_update_load_balancing.go		model_update_load_balancing.go
model_update_nginx_configuration.go		model_update_nginx_configuration.go
model_update_recipe.go		model_update_recipe.go
model_update_repository.go		model_update_repository.go
model_update_server.go		model_update_server.go
model_update_site.go		model_update_site.go
model_user.go		model_user.go
model_webhook.go		model_webhook.go
model_worker.go		model_worker.go
response.go		response.go

madewithlove/forge-go-sdk

Folders and files

Latest commit

History