Laravel Forge SDK

https://github.com/laravel/forge-sdk
Admin
The official Laravel Forge PHP SDK provides an expressive interface for interacting with Forge's API...
Tokens:213,601
Snippets:1,388
Trust Score:9.7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### PHP Version Management: list, install, and configure PHP versions

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

List available PHP versions, install a specific version, and manage per-version configuration (FPM, CLI, pool).

```php
$versions = $forge->phpVersions($organizationSlug, $serverId);
$phpVersion = $forge->installPhpVersion($organizationSlug, $serverId, ['version' => 'php84']);

// Per-version configuration
$forge->phpFpm($organizationSlug, $serverId, $phpVersionId);
$forge->updatePhpFpm($organizationSlug, $serverId, $phpVersionId, $data);
$forge->phpCli($organizationSlug, $serverId, $phpVersionId);
$forge->phpPool($organizationSlug, $serverId, $phpVersionId);
```

--------------------------------

### Forge Recipes: list, get, and run recipes

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Retrieve all Forge recipes, get a specific recipe by ID, and create a recipe run.

```php
$forgeRecipes = $forge->forgeRecipes();
$forgeRecipe = $forge->forgeRecipe($recipeId);
$forge->createForgeRecipeRun($recipeId, $data);
```

--------------------------------

### Install Laravel Forge SDK

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Use Composer to install the SDK into your project.

```bash
composer require laravel/forge-sdk
```

--------------------------------

### installPhpVersion

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Installs a new PHP version on a server.

```APIDOC
## POST .../php/versions

### Description
Installs a new PHP version on a server.

### Method
POST

### Endpoint
.../php/versions

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization slug.
- **serverId** (int) - Required - The server ID.

#### Request Body
- **data** (array) - Required - The data for the new PHP version, e.g. `['version' => 'php84']`.

### Request Example
{
  "version": "php84"
}

### Response
#### Success Response (200)
No content.
```

--------------------------------

### Output Example of Coverage Statistics

Source: https://github.com/laravel/forge-sdk/blob/4.x/tests/OpenAPI/README.md

Example output showing coverage statistics for the Organizations API.

```text
=== Organizations API Coverage ===
Total Endpoints: 7
Mapped to SDK: 7 (100%)
With Tests: 7 (100%)
==================================
```

--------------------------------

### Handle Database Creation Timeout

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDatabases.md

Demonstrates how to catch a TimeoutException when waiting for a database to reach the 'installed' status.

```php
try {
    $db = $forge->createDatabase($org, $serverId, $data, true);
} catch (\Laravel\Forge\Exceptions\TimeoutException $e) {
    // inspect $e->output() for the last polled resource data
}
```

--------------------------------

### siteEnvironment($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the environment file for a site.

```APIDOC
## siteEnvironment($organizationSlug, $serverId, $siteId)

### Description
Gets the environment file for a site.

### Method
PHP SDK method

### Endpoint
`$forge->siteEnvironment($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the environment file content.

### Example
```php
$env = $forge->siteEnvironment($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### Create a new server using createServer

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Example of creating a server on DigitalOcean with specific configuration parameters.

```php
$server = $forge->createServer($organizationSlug, [
    'provider' => ServerProviders::DIGITAL_OCEAN,
    'credential_id' => 1,
    'name' => 'web-01',
    'type' => ServerTypes::APP,
    'size' => '01',
    'php_version' => InstallableServices::PHP_84,
    'region' => 'ams2',
]);
```

--------------------------------

### Full recipe lifecycle usage example

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesRecipes.md

Demonstrates creating a recipe, running it on servers, and iterating through the resulting recipe runs.

```php
$recipe = $forge->createRecipe($organizationSlug, [
    'name' => 'reload-nginx',
    'user' => 'forge',
    'script' => "sudo systemctl reload nginx\n",
]);

// Run it against a set of servers
$forge->createRecipeRun($organizationSlug, $recipe->id, [
    'servers' => $serverIds,
]);

// Inspect runs
$runs = $forge->recipeRuns($organizationSlug, $recipe->id);

foreach ($runs->lazy() as $run) {
    echo $run->status . ' ' . ($run->output ?? '');
}
```

--------------------------------

### Retrieve site list usage example

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesSites.md

Demonstrates how to fetch sites for a specific server and iterate through them to access environment variables.

```php
$sites = $forge->serverSites($organizationSlug, $serverId);

foreach ($sites->lazy() as $site) {
    $env = $forge->siteEnvironment($organizationSlug, $serverId, $site->id);
    // ...
}
```

--------------------------------

### siteNginx($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Nginx configuration for a site.

```APIDOC
## siteNginx($organizationSlug, $serverId, $siteId)

### Description
Gets the Nginx configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->siteNginx($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Nginx configuration content.

### Example
```php
$nginx = $forge->siteNginx($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### phpVersions

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Retrieves a paginated list of PHP versions installed on a server.

```APIDOC
## GET .../php/versions

### Description
Retrieves a paginated list of PHP versions installed on a server.

### Method
GET

### Endpoint
.../php/versions

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization slug.
- **serverId** (int) - Required - The server ID.

#### Query Parameters
- **query** (array) - Optional - Additional query parameters for pagination.

### Response
#### Success Response (200)
- **data** (array) - List of PHP versions.

#### Response Example
{
  "data": []
}
```

--------------------------------

### Manual Pagination

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/CursorPaginator.md

Example of manually fetching pages using the nextPage() method in a loop.

```php
$page = $forge->recipes($organizationSlug);

while ($page !== null) {
    foreach ($page->items() as $recipe) {
        // ...
    }

    $page = $page->nextPage();
}
```

--------------------------------

### Get deployment log

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDeployments.md

Retrieves the log output for a specific deployment.

```php
$output = $forge->deploymentLog($organizationSlug, $serverId, $siteId, $deploymentId);
```

--------------------------------

### Handling TimeoutException

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/errors.md

Example of catching a TimeoutException when creating a server and accessing the last state output.

```php
try {
    $server = $forge->createServer($organizationSlug, $data);
} catch (\Laravel\Forge\Exceptions\TimeoutException $e) {
    $lastState = $e->output();
    // poll manually or surface to the user
}
```

--------------------------------

### Site Commands

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Methods to list, retrieve, create, and get output for site commands.

```APIDOC
## Site Commands

### Description
Methods to manage site commands on a Forge site.

### Methods
- `$forge->commands($organizationSlug, $serverId, $siteId)` - List all commands for a site.
- `$forge->command($organizationSlug, $serverId, $siteId, $commandId)` - Retrieve a specific command.
- `$forge->createCommand($organizationSlug, $serverId, $siteId, $data)` - Create a new command.
- `$forge->commandOutput($organizationSlug, $serverId, $siteId, $commandId)` - Get the output of a command.

### Parameters
- `$organizationSlug` (string) - Required - The organization slug.
- `$serverId` (int) - Required - The server ID.
- `$siteId` (int) - Required - The site ID.
- `$commandId` (int) - Required - The command ID.
- `$data` (array) - Required - Data for creating a command, e.g., `['command' => 'php artisan migrate']`.

### Example
```php
$commands = $forge->commands($organizationSlug, $serverId, $siteId);
$command = $forge->command($organizationSlug, $serverId, $siteId, $commandId);
$forge->createCommand($organizationSlug, $serverId, $siteId, [
    'command' => 'php artisan migrate'
]);
$output = $forge->commandOutput($organizationSlug, $serverId, $siteId, $commandId);
```
```

--------------------------------

### Iterate Current Page

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/CursorPaginator.md

Example of iterating over the items on the current page using a foreach loop.

```php
foreach ($forge->servers($organizationSlug) as $server) {
    echo $server->name;
}
```

--------------------------------

### Update Array Functions for CursorPaginator

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Before and after examples showing how to adapt array_map() calls when list methods return CursorPaginator instead of arrays. Use ->items() to get the underlying array.

```php
// Before
$names = array_map(fn($s) => $s->name, $forge->servers());
```

```php
// After
$names = array_map(fn($s) => $s->name, $forge->servers($org)->items());
```

--------------------------------

### retry() polling loop example

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/MakesHttpRequests.md

Shows how to use the retry() method to poll until a resource reaches a desired state. The callback returns the resource when it is 'installed', otherwise null to keep polling. Throws TimeoutException if the timeout elapses.

```php
$site = $forge->retry($forge->getTimeout(), function () use ($forge, $org, $serverId, $siteId) {
    $site = $forge->organizationSite($org, $siteId);
    return $site->status === 'installed' ? $site : null;
});
```

--------------------------------

### Usage example for team and server credential management

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesTeams.md

Shows how to create a team, invite a member, share a server, and share server credentials using the Forge SDK.

```php
$team = $forge->createTeam($organizationSlug, ['name' => 'Platform']);

$forge->createTeamInvitation($organizationSlug, $team->id, [
    'email' => 'dev@example.com',
]);

$forge->createTeamServersShare($organizationSlug, $team->id, ['server_id' => 123]);
$forge->createTeamServerCredentialsShare($organizationSlug, $team->id, [
    'credentials' => [1, 2],
]);
```

--------------------------------

### Create and Manage Background Processes

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesBackgroundProcesses.md

Demonstrates creating a background process, fetching its log, and executing a command on a specific site.

```php
$process = $forge->createBackgroundProcess($organizationSlug, $serverId, [
    'command' => 'php artisan queue:work',
    'user' => 'forge',
]);

$log = $forge->backgroundProcessLog($organizationSlug, $serverId, $process->id);

$forge->createCommand($organizationSlug, $serverId, $siteId, [
    'command' => 'php artisan migrate --force',
]);
```

--------------------------------

### Server credentials and VPC methods

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Shows methods for listing and retrieving server credentials, and for listing and creating VPCs.

```php
$credentials = $forge->serverCredentials($organizationSlug);
$credential = $forge->serverCredential($organizationSlug, $credentialId);

$vpcs = $forge->vpcs($organizationSlug, $credentialId, $region);
$forge->createVpc($organizationSlug, $credentialId, $region, $data);
```

--------------------------------

### Get Organization

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesOrganizations.md

Retrieves a specific organization by its slug.

```php
$org = $forge->organization($organizationSlug);
echo $org->name;
```

--------------------------------

### Handle server creation timeout

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Example of setting a custom timeout and catching a TimeoutException to retrieve the server if creation takes longer than expected.

```php
try {
    $server = $forge->setTimeout(180)->createServer($organizationSlug, $data, true);
} catch (\Laravel\Forge\Exceptions\TimeoutException $e) {
    $server = $forge->server($organizationSlug, $e->output()['id'] ?? null);
}
```

--------------------------------

### List, create, and delete team server shares

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Shows how to use the teamServers, createTeamServersShare, and deleteTeamServersShare methods. The create method expects an array with 'server_id' and returns a hydrated Server with team_id context.

```php
$servers = $forge->teamServers($organizationSlug, $teamId);
$forge->createTeamServersShare($organizationSlug, $teamId, ['server_id' => 123]);
$forge->deleteTeamServersShare($organizationSlug, $teamId, 123);
```

--------------------------------

### get(string $uri, array $query = []): mixed

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/MakesHttpRequests.md

Performs a GET request to the specified API path. The query parameters are passed as query-string parameters. Returns the decoded JSON body as an array, a raw string if the body is not valid JSON, or null for an empty body.

```APIDOC
## GET [API Path]

### Description
Performs a GET request to the specified API path. The query parameters are passed as query-string parameters. Returns the decoded JSON body as an array, a raw string if the body is not valid JSON, or null for an empty body.

### Method
GET

### Endpoint
[API path relative to https://forge.laravel.com/api/]

### Parameters
#### Path Parameters
- **uri** (string) - Required - API path relative to https://forge.laravel.com/api/, e.g. orgs/my-org/servers.

#### Query Parameters
- **query** (array) - Optional - Query-string parameters (cursor pagination passes page[cursor] here).

### Response
#### Success Response (200)
- **body** (mixed) - Decoded JSON body as array, raw string if not valid JSON, or null for empty body.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### Usage example: webhook, deployments, delete deploy key

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDeployments.md

Shows a typical workflow: creating a webhook, listing deployments, and deleting a deploy key.

```php
$forge->createWebhook($organizationSlug, $serverId, $siteId, [
    'url' => 'https://example.com/hooks/forge',
]);

$deployments = $forge->deployments($organizationSlug, $serverId, $siteId);

$forge->deleteDeployKey($organizationSlug, $serverId, $siteId);
```

--------------------------------

### sitePhp($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the PHP version for a site.

```APIDOC
## sitePhp($organizationSlug, $serverId, $siteId)

### Description
Gets the PHP version for a site.

### Method
PHP SDK method

### Endpoint
`$forge->sitePhp($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the PHP version.

### Example
```php
$phpVersion = $forge->sitePhp($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### Create a deployment

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDeployments.md

Creates a new deployment for a site. Returns a hydrated Deployment object.

```php
$deployment = $forge->createDeployment($organizationSlug, $serverId, $siteId);
```

--------------------------------

### Deploy key methods

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Shows how to retrieve, create, and delete a deploy key for a site. If the site already has a deploy key, createDeployKey() returns the existing one.

```php
$deployKey = $forge->deployKey($organizationSlug, $serverId, $siteId);
$deployKey = $forge->createDeployKey($organizationSlug, $serverId, $siteId);
$forge->deleteDeployKey($organizationSlug, $serverId, $siteId);

echo $deployKey->key; // the public SSH deploy key
```

--------------------------------

### Create a Database

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDatabases.md

Creates a new database on the specified server using the provided configuration data.

```php
$database = $forge->createDatabase($organizationSlug, $serverId, [
    'name' => 'example_db',
    'user' => 'forge',
]);
```

--------------------------------

### getInertia($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Inertia configuration for a site.

```APIDOC
## getInertia($organizationSlug, $serverId, $siteId)

### Description
Gets the Inertia configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getInertia($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Inertia configuration object.

### Example
```php
$inertia = $forge->getInertia($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### InstallableServices

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/types.md

Constant class providing string values for php_version and database_type fields in createServer payloads.

```APIDOC
## InstallableServices

### Description
Constant class with string values for `php_version` and `database_type` fields of `createServer` payloads.

### Constants
- `PHP_56` = `'php56'`
- `PHP_70` = `'php70'`
- `PHP_71` = `'php71'`
- `PHP_72` = `'php72'`
- `PHP_73` = `'php73'`
- `PHP_74` = `'php74'`
- `PHP_80` = `'php80'`
- `PHP_81` = `'php81'`
- `PHP_82` = `'php82'`
- `PHP_83` = `'php83'`
- `PHP_84` = `'php84'`
- `PHP_85` = `'php85'`
- `MYSQL` = `'mysql'`
- `MYSQL_8` = `'mysql8'`
- `MARIADB` = `'mariadb'`
- `MARIADB_106` = `'mariadb106'`
- `MARIADB_1011` = `'mariadb1011'`
- `POSTGRES` = `'postgres'`
- `POSTGRES_13` = `'postgres13'`
- `POSTGRES_14` = `'postgres14'`
- `POSTGRES_15` = `'postgres15'`
- `POSTGRES_16` = `'postgres16'`
- `POSTGRES_17` = `'postgres17'`

### Usage
Accepted by `php_version` and `database_type` fields of `createServer` payloads.
```

--------------------------------

### getPulse($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Pulse configuration for a site.

```APIDOC
## getPulse($organizationSlug, $serverId, $siteId)

### Description
Gets the Pulse configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getPulse($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Pulse configuration object.

### Example
```php
$pulse = $forge->getPulse($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### getReverb($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Reverb configuration for a site.

```APIDOC
## getReverb($organizationSlug, $serverId, $siteId)

### Description
Gets the Reverb configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getReverb($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Reverb configuration object.

### Example
```php
$reverb = $forge->getReverb($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### enablePushToDeploy

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDeployments.md

Enables push-to-deploy for a site.

```APIDOC
## POST orgs/{organizationSlug}/servers/{serverId}/sites/{siteId}/deployments/push-to-deploy

### Description
Enables push-to-deploy for a site.

### Method
POST

### Endpoint
orgs/{organizationSlug}/servers/{serverId}/sites/{siteId}/deployments/push-to-deploy

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization slug.
- **serverId** (int) - Required - The server ID.
- **siteId** (int) - Required - The site ID.

#### Request Body
- **data** (array) - Required - The data to enable push-to-deploy.

### Response
#### Success Response (200)
- Returns void.

#### Response Example
```json
{}
```

--------------------------------

### Usage example: reboot a server

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesServers.md

Demonstrates creating a Forge instance and rebooting a server via the Server resource. The reboot method delegates to createServerAction().

```php
$forge = new Laravel\Forge\Forge($token);

$server = $forge->server($organizationSlug, $serverId);
$server->reboot(); // delegates to createServerAction()
```

--------------------------------

### getOctane($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Octane configuration for a site.

```APIDOC
## getOctane($organizationSlug, $serverId, $siteId)

### Description
Gets the Octane configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getOctane($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Octane configuration object.

### Example
```php
$octane = $forge->getOctane($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### getHorizon($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Horizon configuration for a site.

```APIDOC
## getHorizon($organizationSlug, $serverId, $siteId)

### Description
Gets the Horizon configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getHorizon($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the Horizon configuration object.

### Example
```php
$horizon = $forge->getHorizon($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### Retrieve and iterate providers and resolve size details

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesProviders.md

Demonstrates how to fetch a list of providers using the providers() method and resolve specific size details for server creation using providerRegionSize().

```php
$providers = $forge->providers();

foreach ($providers->lazy() as $provider) {
    echo $provider->name . ' (' . $provider->slug . ')';
}

// Resolve a concrete size for the createServer() payload
$size = $forge->providerRegionSize($providerId, $regionId, $sizeId);

echo $size->code;   // size code for createServer() 'size' field
echo $size->cpus;   // CPU count
echo $size->ram;    // RAM in MB
```

--------------------------------

### GET orgs/{slug}/servers/archives

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves a paginated list of archived servers.

```APIDOC
## GET orgs/{slug}/servers/archives

### Description
Retrieves a paginated list of archived servers.

### Method
GET

### Endpoint
orgs/{slug}/servers/archives

### Parameters
#### Path Parameters
- **slug** (string) - Required - The organization slug.

### Response
#### Success Response (200)
- **data** (array) - List of Server objects.
- **links** (object) - Pagination links.
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "archived-server"
    }
  ],
  "links": {},
  "meta": {}
}
```

--------------------------------

### Manage PHP Versions and Configurations

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Methods for listing, installing, and configuring PHP versions, CLI settings, and OPcache on a Forge server.

```php
// List installed PHP versions
$versions = $forge->phpVersions($organizationSlug, $serverId);

// Install a new PHP version
$forge->installPhpVersion($organizationSlug, $serverId, ['version' => 'php84']);

// Get/Update/Delete PHP version
$version = $forge->phpVersion($organizationSlug, $serverId, $phpVersion);
$forge->updatePhpVersion($organizationSlug, $serverId, $phpVersion, $data);
$forge->deletePhpVersion($organizationSlug, $serverId, $phpVersion);

// PHP configs
$fpmConfig = $forge->phpFpmConfig($organizationSlug, $serverId, $phpVersion);
$forge->updatePhpFpmConfig($organizationSlug, $serverId, $phpVersion, $content);

$cliConfig = $forge->phpCliConfig($organizationSlug, $serverId, $phpVersion);
$forge->updatePhpCliConfig($organizationSlug, $serverId, $phpVersion, $content);

$poolConfig = $forge->phpPoolConfig($organizationSlug, $serverId, $phpVersion);
$forge->updatePhpPoolConfig($organizationSlug, $serverId, $phpVersion, $content);

// PHP CLI/Site versions
$cliVersion = $forge->phpCliVersion($organizationSlug, $serverId);
$forge->updatePhpCliVersion($organizationSlug, $serverId, ['version' => 'php84']);

$siteVersion = $forge->phpSiteVersion($organizationSlug, $serverId);
$forge->updatePhpSiteVersion($organizationSlug, $serverId, ['version' => 'php84']);

// PHP settings
$maxUploadSize = $forge->phpMaxUploadSize($organizationSlug, $serverId);
$forge->updatePhpMaxUploadSize($organizationSlug, $serverId, ['size' => '256M']);

$maxExecutionTime = $forge->phpMaxExecutionTime($organizationSlug, $serverId);
$forge->updatePhpMaxExecutionTime($organizationSlug, $serverId, ['time' => '60']);

// OPcache
$opcache = $forge->phpOpcache($organizationSlug, $serverId);
$forge->createPhpOpcache($organizationSlug, $serverId, $data);
$forge->deletePhpOpcache($organizationSlug, $serverId);
```

--------------------------------

### GET orgs/{slug}/servers/{serverId}

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves a single server by its ID.

```APIDOC
## GET orgs/{slug}/servers/{serverId}

### Description
Retrieves a single server by its ID.

### Method
GET

### Endpoint
orgs/{slug}/servers/{serverId}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The organization slug.
- **serverId** (integer) - Required - The server ID.

### Response
#### Success Response (200)
- **data** (object) - The Server object.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "production"
  }
}
```

--------------------------------

### GET permissions

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Lists all permissions. Returns a cursor-paginated collection of Permission resources.

```APIDOC
## GET permissions

### Description
Lists all permissions.

### Method
GET

### Endpoint
permissions

### Parameters
#### Query Parameters
- **page[cursor]** (string) - Optional - Cursor for pagination.
- **per_page** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **data** (array) - List of Permission resources.
- **meta** (object) - Pagination metadata including `next_cursor` and `per_page`.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "server:create"
    }
  ],
  "meta": {
    "next_cursor": "...",
    "per_page": 15
  }
}
```

--------------------------------

### Config services.php for Forge token

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/LaravelIntegration.md

Example configuration for the services.forge.token key, typically placed in config/services.php, using the FORGE_API_TOKEN environment variable.

```php
'services' => [
    'forge' => [
        'token' => env('FORGE_API_TOKEN'),
    ],
],
```

--------------------------------

### GET me

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves the current user's information. Returns a User resource.

```APIDOC
## GET me

### Description
Retrieves the current user's information.

### Method
GET

### Endpoint
me

### Response
#### Success Response (200)
- **User** (object) - The current user resource.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com"
  }
}
```

--------------------------------

### Server management methods

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Shows how to update a server's settings, get the list of servers a server can communicate with, and update the network by setting which server IDs the server can reach.

```php
// Update a server's settings
$server = $forge->updateServer($organizationSlug, $serverId, $data);

// Get the list of servers this server can communicate with
$servers = $forge->network($organizationSlug, $serverId); // Server[]

// Update the network (set which server IDs this server can reach)
$forge->updateNetwork($organizationSlug, $serverId, ['servers' => [2, 3, 4]]);
```

--------------------------------

### Server Events

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Methods to list, retrieve, and get output for server events.

```APIDOC
## Server Events

### Description
Methods to manage server events.

### Methods
- `$forge->serverEvents($organizationSlug, $serverId)` - List all server events.
- `$forge->serverEvent($organizationSlug, $serverId, $eventId)` - Retrieve a specific server event.
- `$forge->serverEventOutput($organizationSlug, $serverId, $eventId)` - Get the output of a server event.

### Parameters
- `$organizationSlug` (string) - Required - The organization slug.
- `$serverId` (int) - Required - The server ID.
- `$eventId` (int) - Required - The server event ID.

### Example
```php
$events = $forge->serverEvents($organizationSlug, $serverId);
$event = $forge->serverEvent($organizationSlug, $serverId, $eventId);
$output = $forge->serverEventOutput($organizationSlug, $serverId, $eventId);
```
```

--------------------------------

### worker($organizationSlug, $serverId, $siteId, $workerId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets a specific worker for a site.

```APIDOC
## worker($organizationSlug, $serverId, $siteId, $workerId)

### Description
Gets a specific worker for a site.

### Method
PHP SDK method

### Endpoint
`$forge->worker($organizationSlug, $serverId, $siteId, $workerId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.
- **$workerId** (int) - Required - The worker ID.

### Response
Returns the worker object.

### Example
```php
$worker = $forge->worker($organizationSlug, $serverId, $siteId, $workerId);
```
```

--------------------------------

### Storage provider methods

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Shows methods for listing, retrieving, creating, updating, and deleting storage providers.

```php
$providers = $forge->storageProviders($organizationSlug);
$provider = $forge->storageProvider($organizationSlug, $storageProviderId);
$provider = $forge->createStorageProvider($organizationSlug, $data);
$provider = $forge->updateStorageProvider($organizationSlug, $storageProviderId, $data);
$forge->deleteStorageProvider($organizationSlug, $storageProviderId);
```

--------------------------------

### getScheduler($organizationSlug, $serverId, $siteId)

Source: https://github.com/laravel/forge-sdk/blob/4.x/README.md

Gets the Laravel scheduler configuration for a site.

```APIDOC
## getScheduler($organizationSlug, $serverId, $siteId)

### Description
Gets the Laravel scheduler configuration for a site.

### Method
PHP SDK method

### Endpoint
`$forge->getScheduler($organizationSlug, $serverId, $siteId)`

### Parameters
- **$organizationSlug** (string) - Required - The organization slug.
- **$serverId** (int) - Required - The server ID.
- **$siteId** (int) - Required - The site ID.

### Response
Returns the scheduler configuration object.

### Example
```php
$scheduler = $forge->getScheduler($organizationSlug, $serverId, $siteId);
```
```

--------------------------------

### createBackup

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDatabases.md

Creates a new backup instance for a backup configuration.

```APIDOC
## POST orgs/{organizationSlug}/servers/{serverId}/database/backups/{backupConfigurationId}/instances

### Description
Creates a new backup instance. No payload is required.

### Method
POST

### Endpoint
orgs/{organizationSlug}/servers/{serverId}/database/backups/{backupConfigurationId}/instances

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization slug.
- **serverId** (int) - Required - The server ID.
- **backupConfigurationId** (int) - Required - The backup configuration ID.

### Response
#### Success Response (200)
- **void** - No response body.
```

--------------------------------

### GET orgs/{organizationSlug}/teams/{teamId}

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesTeams.md

Retrieves a single team by its ID.

```APIDOC
## GET orgs/{organizationSlug}/teams/{teamId}

### Description
Returns a single Team object for the given team ID.

### Method
GET

### Endpoint
orgs/{organizationSlug}/teams/{teamId}

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization's slug.
- **teamId** (int) - Required - The ID of the team.

### Response
#### Success Response (200)
- Returns a Team object.

#### Response Example
```json
{
  "id": 1,
  "name": "Platform"
}
```
```

--------------------------------

### Teams, roles, and permissions methods

Source: https://github.com/laravel/forge-sdk/blob/4.x/UPGRADE-4.0.md

Shows methods for managing teams, team members, invitations, roles, permissions, and predefined roles.

```php
$teams = $forge->teams($organizationSlug);
$team = $forge->team($organizationSlug, $teamId);
$forge->createTeam($organizationSlug, $data);
$members = $forge->teamMembers($organizationSlug, $teamId);
$invitations = $forge->teamInvitations($organizationSlug, $teamId);

$roles = $forge->roles($organizationSlug);
$permissions = $forge->permissions();
$predefinedRoles = $forge->predefinedRoles();
```

--------------------------------

### createDeployKey

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesDeployments.md

Creates a deploy key for a site. Returns the existing key if one already exists.

```APIDOC
## POST orgs/{organizationSlug}/servers/{serverId}/sites/{siteId}/deploy-key

### Description
Creates a deploy key for a site. Returns the existing key if one already exists.

### Method
POST

### Endpoint
orgs/{organizationSlug}/servers/{serverId}/sites/{siteId}/deploy-key

### Parameters
#### Path Parameters
- **organizationSlug** (string) - Required - The organization slug.
- **serverId** (int) - Required - The server ID.
- **siteId** (int) - Required - The site ID.

### Response
#### Success Response (200)
- Returns a DeployKey instance.

#### Response Example
```json
{
  "id": 1,
  "name": "deploy-key"
}
```
```

--------------------------------

### GET orgs/{slug}/servers/{serverId}/network

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves the network configuration for a server.

```APIDOC
## GET orgs/{slug}/servers/{serverId}/network

### Description
Retrieves the network configuration for a server.

### Method
GET

### Endpoint
orgs/{slug}/servers/{serverId}/network

### Parameters
#### Path Parameters
- **slug** (string) - Required - The organization slug.
- **serverId** (integer) - Required - The server ID.

### Response
#### Success Response (200)
- **data** (array) - List of Server objects representing network configuration.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "eth0"
    }
  ]
}
```

--------------------------------

### POST orgs/{slug}/servers

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Creates a new server. If $wait is true, the SDK polls until the server is ready.

```APIDOC
## POST orgs/{slug}/servers

### Description
Creates a new server. If $wait is true, the SDK polls until the server is ready.

### Method
POST

### Endpoint
orgs/{slug}/servers

### Parameters
#### Path Parameters
- **slug** (string) - Required - The organization slug.

#### Request Body
- **data** (object) - Required - The server creation data.

### Request Example
{
  "name": "production",
  "region": "us-east-1"
}

### Response
#### Success Response (200)
- **data** (object) - The created Server object.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "production"
  }
}
```

--------------------------------

### Using ForgeManager to fetch servers

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/LaravelIntegration.md

Example of instantiating ForgeManager with an API token and calling a method that is forwarded to the underlying Forge instance.

```php
use Laravel\Forge\ForgeManager;

$forge = new ForgeManager($apiToken);
$servers = $forge->servers($organizationSlug); // forwarded to Forge::servers()
```

--------------------------------

### GET orgs/{slug}/servers

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves a paginated list of servers for the given organization.

```APIDOC
## GET orgs/{slug}/servers

### Description
Retrieves a paginated list of servers for the given organization.

### Method
GET

### Endpoint
orgs/{slug}/servers

### Parameters
#### Path Parameters
- **slug** (string) - Required - The organization slug.

### Response
#### Success Response (200)
- **data** (array) - List of Server objects.
- **links** (object) - Pagination links.
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "production"
    }
  ],
  "links": {},
  "meta": {}
}
```

--------------------------------

### Create a new site using createSite

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesSites.md

Creates a new site on a specified server within an organization. Returns a hydrated Site object immediately without waiting for provisioning.

```php
$site = $forge->createSite($organizationSlug, $serverId, [
    'domain' => 'example.com',
    'type' => 'php',
    'project_type' => 'php',
]);
```

--------------------------------

### GET forge-recipes

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Lists all Forge recipes. Returns a cursor-paginated collection of ForgeRecipe resources.

```APIDOC
## GET forge-recipes

### Description
Lists all Forge recipes.

### Method
GET

### Endpoint
forge-recipes

### Parameters
#### Query Parameters
- **page[cursor]** (string) - Optional - Cursor for pagination.
- **per_page** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **data** (array) - List of ForgeRecipe resources.
- **meta** (object) - Pagination metadata including `next_cursor` and `per_page`.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "Install PHP"
    }
  ],
  "meta": {
    "next_cursor": "...",
    "per_page": 15
  }
}
```

--------------------------------

### GET predefined-roles

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Lists all predefined roles. Returns a cursor-paginated collection of PredefinedRole resources.

```APIDOC
## GET predefined-roles

### Description
Lists all predefined roles.

### Method
GET

### Endpoint
predefined-roles

### Parameters
#### Query Parameters
- **page[cursor]** (string) - Optional - Cursor for pagination.
- **per_page** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **data** (array) - List of PredefinedRole resources.
- **meta** (object) - Pagination metadata including `next_cursor` and `per_page`.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "admin"
    }
  ],
  "meta": {
    "next_cursor": "...",
    "per_page": 15
  }
}
```

--------------------------------

### GET providers/{id}

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves a specific provider by its ID. Returns a Provider resource.

```APIDOC
## GET providers/{id}

### Description
Retrieves a specific provider by its ID.

### Method
GET

### Endpoint
providers/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The provider ID.

### Response
#### Success Response (200)
- **Provider** (object) - The provider resource.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "DigitalOcean"
  }
}
```

--------------------------------

### Create a recipe using createRecipe

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/ManagesRecipes.md

Creates a new recipe within an organization by providing the name, user, and script.

```php
$recipe = $forge->createRecipe($organizationSlug, [
    'name' => 'deploy-nginx',
    'user' => 'forge',
    'script' => "sudo systemctl reload nginx\n",
]);
```

--------------------------------

### GET providers

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Lists all server providers. Returns a cursor-paginated collection of Provider resources.

```APIDOC
## GET providers

### Description
Lists all server providers.

### Method
GET

### Endpoint
providers

### Parameters
#### Query Parameters
- **page[cursor]** (string) - Optional - Cursor for pagination.
- **per_page** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **data** (array) - List of Provider resources.
- **meta** (object) - Pagination metadata including `next_cursor` and `per_page`.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "DigitalOcean"
    }
  ],
  "meta": {
    "next_cursor": "...",
    "per_page": 15
  }
}
```

--------------------------------

### GET user

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/endpoints.md

Retrieves the authenticated user's information. Returns a User resource.

```APIDOC
## GET user

### Description
Retrieves the authenticated user's information.

### Method
GET

### Endpoint
user

### Response
#### Success Response (200)
- **User** (object) - The authenticated user resource.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com"
  }
}
```

--------------------------------

### Initialize Forge with Custom Guzzle Client

Source: https://github.com/laravel/forge-sdk/blob/4.x/_autodocs/api-reference/Forge.md

Instantiating the Forge client with a custom Guzzle client instance.

```php
use GuzzleHttp\Client;

$forge = new Laravel\Forge\Forge(
    $apiToken,
    new Client(['timeout' => 10]) // custom transport
);
```
Tokens:
Raw