Laravel Servers API
The Servers API from Laravel — 28 operation(s) for servers.
Operations 46
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which servers does my Forge organization have running?”
“Can I filter my server list by region, PHP version or database type?”
Tell an agent
List all servers in organization {organization}.
Find servers in {organization} running PHP {php_version} in region {region}.
Ask an LLM
“How do I provision a new server through Laravel Forge?”
“Can I create a server on my own custom VPS instead of a cloud provider?”
Tell an agent
Create a server named {name} on {provider} running Ubuntu {ubuntu_version} in organization {organization}.
Provision a {type} server called {name} on {provider} with Ubuntu {ubuntu_version} and PHP {php_version} in {organization}.
Ask an LLM
“Which of my servers have been archived?”
“Where can I see servers I archived but did not delete?”
Tell an agent
List the archived servers in organization {organization}.
Show me everything archived in {organization}, sorted by {sort}.
Ask an LLM
“Can I archive a server instead of deleting it?”
“What happens to a server when I archive it in Forge?”
Tell an agent
Archive server {server_id} in organization {organization}.
Move server {server_id} into the archive.
Ask an LLM
“How do I bring an archived server back into use?”
“Do I need to regenerate the server key before unarchiving a server?”
Tell an agent destructive · confirm first
Unarchive server {server} in organization {organization}.
Restore archived server {server} back to my active servers.
POST
/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/actions
Restart, stop or start a server background process · Perform an action on a server background process
#
Ask an LLM
“How do I restart a daemon running at the server level?”
“Can I stop a background process on a server without deleting it?”
Tell an agent
Restart background process {backgroundProcess} on server {server} in {organization}.
Run the {action} action on background process {backgroundProcess} of server {server}.
POST
/orgs/{organization}/servers/{server}/actions
Reboot or power-cycle a server · Create server action
#
Ask an LLM
“How do I reboot a whole server from the API?”
“Can I power-cycle a server that has stopped responding?”
Tell an agent
Reboot server {server} in organization {organization}.
Run the {action} action on server {server}.
POST
/orgs/{organization}/servers/{server}/services/nginx/actions
Reboot or stop Nginx on a server · Perform Nginx action
#
Ask an LLM
“How do I restart Nginx on one of my servers?”
“Can I stop the Nginx service on a server?”
Tell an agent
Reboot Nginx on server {server} in {organization}.
Run the {action} action on the Nginx service of server {server}.
POST
/orgs/{organization}/servers/{server}/services/postgres/actions
Reboot or stop Postgres on a server · Perform Postgres action
#
Ask an LLM
“How do I restart PostgreSQL on a Forge server?”
“Can I stop the Postgres service running on my server?”
Tell an agent
Reboot Postgres on server {server} in {organization}.
Run the {action} action on the Postgres service of server {server}.
POST
/orgs/{organization}/servers/{server}/services/redis/actions
Reboot Redis on a server · Perform Redis action
#
Ask an LLM
“How do I restart the Redis service on a server?”
“Is there a way to reboot Redis without rebooting the whole machine?”
Tell an agent
Reboot Redis on server {server} in {organization}.
Run the {action} action on the Redis service of server {server}.
POST
/orgs/{organization}/servers/{server}/services/mysql/actions
Reboot or stop MySQL on a server · Perform MySQL action
#
Ask an LLM
“How do I restart MySQL on my Forge server?”
“Can I stop the MySQL service on a server?”
Tell an agent
Reboot MySQL on server {server} in {organization}.
Run the {action} action on the MySQL service of server {server}.
POST
/orgs/{organization}/servers/{server}/services/php/actions
Restart or reload PHP-FPM for a PHP version · Perform PHP action
#
Ask an LLM
“How do I gracefully reload PHP-FPM for one PHP version?”
“Can I reboot PHP-FPM for PHP 8.3 only, leaving other versions alone?”
Tell an agent
Reload PHP-FPM {version} on server {server} in {organization}.
Run the {action} action on PHP-FPM {version} on server {server}.
POST
/orgs/{organization}/servers/{server}/services/supervisor/actions
Reboot Supervisor on a server · Perform Supervisor action
#
Ask an LLM
“How do I restart the Supervisor service that runs my queue workers?”
“Can I reboot Supervisor on a server through the API?”
Tell an agent
Reboot Supervisor on server {server} in {organization}.
Run the {action} action on the Supervisor service of server {server}.
Ask an LLM
“What are the details of a specific server in my organization?”
“Where can I see one server's provider, size and IP address?”
Tell an agent
Show server {server} in organization {organization}.
Get the details of server {server}.
PUT
/orgs/{organization}/servers/{server}
Rename a server or change its IP, timezone or tags · Update server
#
Ask an LLM
“How do I rename a server or change its tags?”
“Can I update the IP address or timezone Forge has on record for a server?”
Tell an agent
Rename server {server} in {organization} to {name}.
Set the timezone of server {server} to {timezone}.
Ask an LLM
“How do I delete a server I no longer need?”
“Can I remove a server from Forge but keep it running at the cloud provider?”
Tell an agent destructive · confirm first
Delete server {server} from organization {organization}.
Remove server {server} from Forge only, preserve at provider: {preserve_at_provider}.
GET
/orgs/{organization}/servers/{server}/network
See which servers share a server's network · Get server network
#
Ask an LLM
“Which servers are in the same network as this server?”
“How can I check a server's private network peers?”
Tell an agent
Show the network of server {server} in {organization}.
List the servers networked with server {server}.
PUT
/orgs/{organization}/servers/{server}/network
Set which servers a server can network with · Update server network
#
Ask an LLM
“How do I let two of my servers talk to each other over the network?”
“Can I replace a server's network with a new list of servers?”
Tell an agent
Sync the network of server {server} in {organization} to servers {servers}.
Connect server {server} to servers {servers} on its network.
GET
/orgs/{organization}/servers/{server}/events
List a server's event history · List server events
#
Ask an LLM
“What has happened on this server recently?”
“Can I see which server events were started by a particular user?”
Tell an agent
List events for server {server} in {organization}.
Show events on server {server} initiated by {initiated_by}.
Ask an LLM
“What are the details of a single event on my server?”
“Who ran a specific server event and when?”
Tell an agent
Show event {event} on server {server} in {organization}.
Get server event {event} for server {server}.
GET
/orgs/{organization}/servers/{server}/events/{event}/output
Get the output of a server event · Get server event output
#
Ask an LLM
“Where can I read the console output from a server event?”
“How do I see why a provisioning step on my server failed?”
Tell an agent
Show the output of event {event} on server {server} in {organization}.
Fetch the log output for server event {event} on {server}.
GET
/orgs/{organization}/servers/{server}/php/cli-version
Check a server's default PHP CLI version · Get PHP CLI version
#
Ask an LLM
“Which PHP version runs when I type php on the command line of my server?”
“What is the CLI default PHP version on a server?”
Tell an agent
Show the PHP CLI version on server {server} in {organization}.
Tell me which PHP version the CLI uses on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/cli-version
Change a server's default PHP CLI version · Update PHP CLI version
#
Ask an LLM
“How do I switch the command-line PHP version on a server?”
“Can the CLI use a different PHP version than my sites?”
Tell an agent
Set the PHP CLI version on server {server} in {organization} to {php_version}.
Make PHP {php_version} the command-line default on server {server}.
GET
/orgs/{organization}/servers/{server}/php/site-version
Check a server's default PHP version for sites · Get PHP site version
#
Ask an LLM
“Which PHP version do new sites on my server use by default?”
“What is the site default PHP version on a server?”
Tell an agent
Show the default site PHP version on server {server} in {organization}.
Tell me which PHP version new sites get on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/site-version
Change a server's default PHP version for sites · Update PHP site version
#
Ask an LLM
“How do I change the default PHP version for sites on a server?”
“Can I make new sites on a server use PHP 8.4 by default?”
Tell an agent
Set the default site PHP version on server {server} in {organization} to {php_version}.
Make PHP {php_version} the site default on server {server}.
GET
/orgs/{organization}/servers/{server}/php/versions
List PHP versions installed on a server · List PHP versions for server
#
Ask an LLM
“Which PHP versions are installed on my server?”
“Can I filter a server's PHP versions by install status?”
Tell an agent
List installed PHP versions on server {server} in {organization}.
Show PHP versions on server {server} with status {status}.
POST
/orgs/{organization}/servers/{server}/php/versions
Install a PHP version on a server · Install new PHP version
#
Ask an LLM
“How do I install an additional PHP version on a server?”
“Can I install a new PHP version and make it the CLI default at the same time?”
Tell an agent
Install PHP {version} on server {server} in {organization}.
Install PHP {version} on server {server} and make it the site default: {site_default}.
GET
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}
Get an installed PHP version · Get PHP version
#
Ask an LLM
“What is the status of a specific PHP version on my server?”
“Is a given PHP version fully installed on a server?”
Tell an agent
Show PHP version {phpVersion} on server {server} in {organization}.
Get the install details for PHP {phpVersion} on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}
Patch an installed PHP version to its latest release · Update installed PHP version
#
Ask an LLM
“How do I upgrade an installed PHP version to the newest patch release?”
“Can I apply the latest PHP security patch on a server?”
Tell an agent
Update PHP {phpVersion} on server {server} in {organization} to the latest patch.
Apply the newest patch release of PHP {phpVersion} on server {server}.
DELETE
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}
Uninstall a PHP version from a server · Delete installed PHP version
#
Ask an LLM
“How do I uninstall an old PHP version from my server?”
“Can I remove a PHP version that no site uses anymore?”
Tell an agent destructive · confirm first
Uninstall PHP {phpVersion} from server {server} in {organization}.
Remove PHP {phpVersion} from server {server}.
GET
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/fpm
Read a PHP version's FPM config · Get PHP version FPM config
#
Ask an LLM
“Where can I read the php.ini that PHP-FPM uses for a version?”
“What does the FPM configuration look like for PHP on my server?”
Tell an agent
Show the FPM config for PHP {phpVersion} on server {server} in {organization}.
Get the PHP-FPM ini for PHP {phpVersion} on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/fpm
Edit a PHP version's FPM config · Update PHP version FPM config
#
Ask an LLM
“How do I change the php.ini used by PHP-FPM on a server?”
“Can I raise memory_limit for web requests only, not the CLI?”
Tell an agent
Replace the FPM config of PHP {phpVersion} on server {server} in {organization} with {config}.
Write {config} as the PHP-FPM ini for PHP {phpVersion} on {server}.
GET
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/cli
Read a PHP version's CLI config · Get PHP version CLI config
#
Ask an LLM
“Where can I see the php.ini used by command-line PHP?”
“What settings does the CLI php.ini have for a version on my server?”
Tell an agent
Show the CLI config for PHP {phpVersion} on server {server} in {organization}.
Get the command-line php.ini for PHP {phpVersion} on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/cli
Edit a PHP version's CLI config · Update PHP version CLI config
#
Ask an LLM
“How do I change the php.ini used by artisan and other CLI commands?”
“Can I edit the command-line PHP configuration for one version?”
Tell an agent
Replace the CLI config of PHP {phpVersion} on server {server} in {organization} with {config}.
Write {config} as the command-line php.ini for PHP {phpVersion} on {server}.
GET
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/pool
Read a PHP-FPM pool config · Get PHP version pool config
#
Ask an LLM
“Where can I see the PHP-FPM pool settings like pm.max_children?”
“Can I view the FPM pool config for a specific system user?”
Tell an agent
Show the worker pool settings (pm.max_children etc.) of PHP {phpVersion} on {server} in {organization}.
Get the PHP {phpVersion} pool config for user {user} on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/versions/{phpVersion}/configs/pool
Edit a PHP-FPM pool config · Update PHP version pool config
#
Ask an LLM
“How do I tune PHP-FPM worker counts on my server?”
“Can I change the FPM pool config for one system user only?”
Tell an agent
Update the worker pool settings of PHP {phpVersion} on {server} in {organization} to {config}.
Write pool config {config} for user {user} on PHP {phpVersion} of server {server}.
GET
/orgs/{organization}/servers/{server}/php/max-upload-size
Check a server's PHP max upload size · Get server PHP max upload size
#
Ask an LLM
“What is the largest file PHP will accept as an upload on my server?”
“How big can uploads be on a server right now?”
Tell an agent
Show the PHP max upload size on server {server} in {organization}.
Tell me the upload size limit for PHP on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/max-upload-size
Change a server's PHP max upload size · Update server PHP max upload size
#
Ask an LLM
“How do I let users upload larger files to my server?”
“Can I raise the PHP upload limit in megabytes?”
Tell an agent
Set the PHP max upload size on server {server} in {organization} to {max_upload_size}.
Raise the upload limit on server {server} to {max_upload_size} MB.
GET
/orgs/{organization}/servers/{server}/php/max-execution-time
Check a server's PHP max execution time · Get server PHP max execution time
#
Ask an LLM
“How long can a PHP script run before it times out on my server?”
“What is the max_execution_time on a server?”
Tell an agent
Show the PHP max execution time on server {server} in {organization}.
Tell me the PHP script timeout on server {server}.
PUT
/orgs/{organization}/servers/{server}/php/max-execution-time
Change a server's PHP max execution time · Update server PHP max execution time
#
Ask an LLM
“How do I give long-running PHP requests more time before timing out?”
“Can I change max_execution_time across a server?”
Tell an agent
Set the PHP max execution time on server {server} in {organization} to {max_execution_time} seconds.
Let PHP scripts on server {server} run for up to {max_execution_time} seconds.
GET
/orgs/{organization}/servers/{server}/php/opcache
Check whether OPcache is enabled on a server · Get server PHP OPcache status
#
Ask an LLM
“Is PHP OPcache turned on for my server?”
“What is the current OPcache status on a server?”
Tell an agent
Show the OPcache status of server {server} in {organization}.
Check if OPcache is enabled on server {server}.
POST
/orgs/{organization}/servers/{server}/php/opcache
Enable PHP OPcache on a server · Create PHP OPcache config
#
Ask an LLM
“How do I turn on OPcache to speed up PHP on my server?”
“Can I enable OPcache through the API?”
Tell an agent
Enable OPcache on server {server} in {organization}.
Turn on PHP OPcache for server {server}.
DELETE
/orgs/{organization}/servers/{server}/php/opcache
Disable PHP OPcache on a server · Delete PHP OPcache config
#
Ask an LLM
“How do I turn OPcache off on a server while debugging?”
“Can I disable PHP OPcache for a server?”
Tell an agent destructive · confirm first
Disable OPcache on server {server} in {organization}.
Turn off PHP OPcache for server {server}.
Ask an LLM
“Which servers can a particular team access?”
“What servers have been shared with my team?”
Tell an agent
List servers shared with team {team} in organization {organization}.
Show the servers team {team} has access to.
POST
/orgs/{organization}/teams/{team}/servers
Share a server with a team · Create a new server share
#
Ask an LLM
“How do I give a team access to one of my servers?”
“Can I share a single server with another team?”
Tell an agent
Share server {server_id} with team {team} in {organization}.
Give team {team} access to server {server_id}.
DELETE
/orgs/{organization}/teams/{team}/servers/{server}
Stop sharing a server with a team · Delete a server share
#
Ask an LLM
“How do I revoke a team's access to a server?”
“Can I unshare a server from a team without deleting it?”
Tell an agent destructive · confirm first
Unshare server {server} from team {team} in {organization}.
Remove team {team}'s access to server {server}.
Documentation
📖
Documentation
https://forge.laravel.com/docs/api-reference/introduction
📖
APIReference
https://forge.laravel.com/docs/api-reference/introduction
📖
Documentation
https://cloud.laravel.com/docs/api/authentication
📖
APIReference
https://cloud.laravel.com/docs/api/authentication