### GET /orgs/{organization}/servers/{server}/php/versions
Source: https://forge.laravel.com/api/docs.openapi
List all PHP versions installed on the server
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **page[size]** (integer, query, optional): The number of results that will be returned per page.
- **page[cursor]** (string, query, optional): The cursor to start the pagination from.
- **filter[status]** (string, query, optional)
- **filter[version]** (string, query, optional)
- **sort** (array (string (created_at|-created_at|updated_at|-updated_at|status|-status|version|-version)), query, optional)
### Responses
#### 200 - Paginated set of `PhpVersionResource`
- **data** (array (PhpVersionResource)) (required)
Array items:
- **id** (string) (required)
- **type** (string (phpVersions)) (required) ("phpVersions")
- **attributes** (object)
- **version** (string (5.6|7.0|7.1|7.2|7.3|7.4|8.0|8.1|8.2|8.3|8.4|8.5|5)) (required) ("5.6"|"7.0"|"7.1"|"7.2"|"7.3"|"7.4"|"8.0"|"8.1"|"8.2"|"8.3"|"8.4"|"8.5"|"5")
- **binary_name** (string) (required)
- **status** (string) (required)
- **created_at** (string (date-time)) (required)
- **updated_at** (string (date-time)) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
- **links** (object) (required)
- **first** (string)
- **last** (string)
- **prev** (string)
- **next** (string)
- **meta** (object) (required)
- **path** (string,null) (required): Base path for paginator generated URLs.
- **per_page** (integer) (required): Number of items shown per page.
- **next_cursor** (string,null) (required): The "cursor" that points to the next set of items.
- **prev_cursor** (string,null) (required): The "cursor" that points to the previous set of items.
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/php/versions?page[size]=30&page[cursor]=string&filter[status]=string&filter[version]=string&sort=item1,item2"
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/php/versions/{phpVersion}
Source: https://forge.laravel.com/api/docs.openapi
Show the PHP version which has been installed on the server
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **phpVersion** (integer, path, required): The php version ID
### Responses
#### 200 - `PhpVersionResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (phpVersions)) (required) ("phpVersions")
- **attributes** (object)
- **version** (string (5.6|7.0|7.1|7.2|7.3|7.4|8.0|8.1|8.2|8.3|8.4|8.5|5)) (required) ("5.6"|"7.0"|"7.1"|"7.2"|"7.3"|"7.4"|"8.0"|"8.1"|"8.2"|"8.3"|"8.4"|"8.5"|"5")
- **binary_name** (string) (required)
- **status** (string) (required)
- **created_at** (string (date-time)) (required)
- **updated_at** (string (date-time)) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/php/versions/{phpVersion}"
```
```
--------------------------------
### Schema: BackgroundProcessAction
Source: https://forge.laravel.com/api/docs.openapi
| |
|---|
| `restart`
Restart the background process |
| `stop`
Stop the background process |
| `start`
Start the background process |
| `empty-log`
Empty the background process log |
```markdown
## Schema: BackgroundProcessAction
| |
|---|
| `restart`
Restart the background process |
| `stop`
Stop the background process |
| `start`
Start the background process |
| `empty-log`
Empty the background process log |
**Type:** string
```
--------------------------------
### GET /forge-recipes/{forgeRecipe}
Source: https://forge.laravel.com/api/docs.openapi
Show the Forge recipe.
Processing mode: sync
```markdown
### Parameters
- **forgeRecipe** (integer, path, required): The forge recipe ID
### Responses
#### 200 - `ForgeRecipeResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (forgeRecipes)) (required) ("forgeRecipes")
- **attributes** (object)
- **name** (string) (required)
- **user** (string) (required)
- **info** (string) (required)
- **script** (string) (required)
- **created_at** (string,null) (required)
- **updated_at** (string,null) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/forge-recipes/{forgeRecipe}"
```
```
--------------------------------
### GET /orgs/{organization}/recipes
Source: https://forge.laravel.com/api/docs.openapi
Show all recipes for the organization.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **page[size]** (integer, query, optional): The number of results that will be returned per page.
- **page[cursor]** (string, query, optional): The cursor to start the pagination from.
### Responses
#### 200 - Paginated set of `RecipeResource`
- **data** (array (RecipeResource)) (required)
Array items:
- **id** (string) (required)
- **type** (string (recipes)) (required) ("recipes")
- **attributes** (object)
- **name** (string) (required): The name of the Recipe.
- **script** (string) (required): The script that should be executed.
- **user** (string) (required): The user that the Recipe should be executed as.
- **created_at** (string (date-time)) (required): The date the Recipe was created.
- **updated_at** (string (date-time)) (required): The date the Recipe was last updated.
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
- **links** (object) (required)
- **first** (string)
- **last** (string)
- **prev** (string)
- **next** (string)
- **meta** (object) (required)
- **path** (string,null) (required): Base path for paginator generated URLs.
- **per_page** (integer) (required): Number of items shown per page.
- **next_cursor** (string,null) (required): The "cursor" that points to the next set of items.
- **prev_cursor** (string,null) (required): The "cursor" that points to the previous set of items.
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/recipes?page[size]=30&page[cursor]=string"
```
```
--------------------------------
### GET /forge-recipes
Source: https://forge.laravel.com/api/docs.openapi
Show all Forge provided recipes.
Processing mode: sync
```markdown
### Parameters
- **page[size]** (integer, query, optional): The number of results that will be returned per page.
- **page[cursor]** (string, query, optional): The cursor to start the pagination from.
### Responses
#### 200 - Paginated set of `ForgeRecipeResource`
- **data** (array (ForgeRecipeResource)) (required)
Array items:
- **id** (string) (required)
- **type** (string (forgeRecipes)) (required) ("forgeRecipes")
- **attributes** (object)
- **name** (string) (required)
- **user** (string) (required)
- **info** (string) (required)
- **script** (string) (required)
- **created_at** (string,null) (required)
- **updated_at** (string,null) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
- **links** (object) (required)
- **first** (string)
- **last** (string)
- **prev** (string)
- **next** (string)
- **meta** (object) (required)
- **path** (string,null) (required): Base path for paginator generated URLs.
- **per_page** (integer) (required): Number of items shown per page.
- **next_cursor** (string,null) (required): The "cursor" that points to the next set of items.
- **prev_cursor** (string,null) (required): The "cursor" that points to the previous set of items.
#### 403 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/forge-recipes?page[size]=30&page[cursor]=string"
```
```
--------------------------------
### POST /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances
Source: https://forge.laravel.com/api/docs.openapi
Manually create a backup for the server.
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **backupConfiguration** (integer, path, required): The backup configuration ID
### Responses
#### 202 - response
Empty response body
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X POST "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances"
```
```
--------------------------------
### POST /orgs/{organization}/servers/{server}/php/versions
Source: https://forge.laravel.com/api/docs.openapi
Install a new PHP version on the server
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
### Request Body
**Content-Type:** application/json
- **version** (string (php5|php56-old|php56|php70|php71|php72|php73|php74|php80|php81|php82|php83|php84|php85)) (required) ("php5"|"php56-old"|"php56"|"php70"|"php71"|"php72"|"php73"|"php74"|"php80"|"php81"|"php82"|"php83"|"php84"|"php85")
- **cli_default** (boolean)
- **site_default** (boolean)
### Responses
#### 202 - response
Empty response body
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
#### 422 - response
- **message** (string) (required): Errors overview.
- **errors** (object) (required): A detailed description of each field that failed validation.
### Example Usage
```bash
curl -X POST "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/php/versions" \
-H "Content-Type: application/json" \
-d '{
"version": "value",
"cli_default": "true",
"site_default": "true"
}'
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/configurations
Source: https://forge.laravel.com/api/docs.openapi
Show the DNS configuration instructions for a domain.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **site** (integer, path, required): The site ID
- **domainRecord** (integer, path, required): The domain record ID
### Responses
#### 200 - Array of `DomainRecordConfigurationResource`
- **data** (array (DomainRecordConfigurationResource)) (required)
Array items:
- **id** (string) (required)
- **type** (string) (required)
- **attributes** (object)
- **type** (string (A|CNAME|TXT)) (required): The type of DNS record. ("A"|"CNAME"|"TXT")
- **name** (string) (required): The name of the DNS record.
- **value** (string) (required): The value (IP address, CNAME target, TXT value) of the DNS record.
- **ttl** (integer,null) (required): The recommended TTL (Time to Live) for the DNS record, in seconds.
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/configurations"
```
```
--------------------------------
### GET /orgs/{organization}/servers/archives
Source: https://forge.laravel.com/api/docs.openapi
Get all archived servers for the organization.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **page[size]** (integer, query, optional): The number of results that will be returned per page.
- **page[cursor]** (string, query, optional): The cursor to start the pagination from.
- **sort** (array (string (created_at|-created_at|updated_at|-updated_at)), query, optional)
### Responses
#### 200 - Paginated set of `ServerResource`
- **data** (array (ServerResource)) (required)
Array items:
- **id** (string) (required)
- **type** (string (servers)) (required) ("servers")
- **attributes** (object)
- **id** (integer) (required)
- **credential_id** (integer,null) (required)
- **name** (string) (required)
- **slug** (string) (required)
- **type** (string (app|web|loadbalancer|database|cache|worker|meilisearch|openclaw)) (required) ("app"|"web"|"loadbalancer"|"database"|"cache"|"worker"|"meilisearch"|"openclaw")
- **ubuntu_version** (string,null) (required)
- **ssh_port** (integer) (required)
- **provider** (string) (required)
- **identifier** (string,null) (required)
- **size** (string) (required)
- **region** (string) (required)
- **php_version** (string,null) (required)
- **php_cli_version** (string,null) (required)
- **opcache_status** (string,null) (required)
- **database_type** (string,null) (required)
- **db_status** (string,null) (required)
- **redis_status** (string,null) (required)
- **ip_address** (string,null) (required)
- **private_ip_address** (string,null) (required)
- **revoked** (boolean) (required)
- **created_at** (string (date-time)) (required): The date and time the server was created.
- **updated_at** (string (date-time)) (required): The date and time the server was last updated.
- **connection_status** (string) (required)
- **timezone** (string) (required)
- **local_public_key** (string,null) (required)
- **is_ready** (boolean) (required)
- **relationships** (object)
- **tags** (object)
- **data** (array (TagResourceIdentifier)) (required)
Array items:
- **type** (string (tags)) (required) ("tags")
- **id** (string) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
- **links** (object) (required)
- **first** (string)
- **last** (string)
- **prev** (string)
- **next** (string)
- **meta** (object) (required)
- **path** (string,null) (required): Base path for paginator generated URLs.
- **per_page** (integer) (required): Number of items shown per page.
- **next_cursor** (string,null) (required): The "cursor" that points to the next set of items.
- **prev_cursor** (string,null) (required): The "cursor" that points to the previous set of items.
- **included** (array (TagResource))
Array items:
- **id** (string) (required)
- **type** (string (tags)) (required) ("tags")
- **attributes** (object)
- **name** (string) (required)
- **created_at** (string (date-time)) (required): The date and time the tag was created.
- **updated_at** (string (date-time)) (required): The date and time the tag was last updated.
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/archives?page[size]=30&page[cursor]=string&sort=item1,item2"
```
```
--------------------------------
### POST /orgs/{organization}/servers/{server}/database/backups
Source: https://forge.laravel.com/api/docs.openapi
Create a new backup configuration for the server.
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
### Request Body
**Content-Type:** application/json
- **storage_provider_id** (integer) (required)
- **name** (string,null)
- **bucket** (string,null)
- **directory** (string,null)
- **frequency** (string (hourly|daily|weekly|custom)) (required) ("hourly"|"daily"|"weekly"|"custom")
- **day** (string (0|1|2|3|4|5|6)) ("0"|"1"|"2"|"3"|"4"|"5"|"6")
- **time** (string (00:00|00:30|01:00|01:30|02:00|02:30|03:00|03:30|04:00|04:30|05:00|05:30|06:00|06:30|07:00|07:30|08:00|08:30|09:00|09:30|10:00|10:30|11:00|11:30|12:00|12:30|13:00|13:30|14:00|14:30|15:00|15:30|16:00|16:30|17:00|17:30|18:00|18:30|19:00|19:30|20:00|20:30|21:00|21:30|22:00|22:30|23:00|23:30)) ("00:00"|"00:30"|"01:00"|"01:30"|"02:00"|"02:30"|"03:00"|"03:30"|"04:00"|"04:30"|"05:00"|"05:30"|"06:00"|"06:30"|"07:00"|"07:30"|"08:00"|"08:30"|"09:00"|"09:30"|"10:00"|"10:30"|"11:00"|"11:30"|"12:00"|"12:30"|"13:00"|"13:30"|"14:00"|"14:30"|"15:00"|"15:30"|"16:00"|"16:30"|"17:00"|"17:30"|"18:00"|"18:30"|"19:00"|"19:30"|"20:00"|"20:30"|"21:00"|"21:30"|"22:00"|"22:30"|"23:00"|"23:30")
- **cron** (string)
- **retention** (integer) (required)
- **notification_email** (string,null)
- **database_ids** (array (integer)) (required)
### Responses
#### 202 - response
Empty response body
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
#### 422 - response
- **message** (string) (required): Errors overview.
- **errors** (object) (required): A detailed description of each field that failed validation.
### Example Usage
```bash
curl -X POST "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/database/backups" \
-H "Content-Type: application/json" \
-d '{
"storage_provider_id": "0",
"name": "value",
"bucket": "value",
"directory": "value",
"frequency": "value",
"day": "0",
"time": "00:00",
"cron": "string",
"retention": "0",
"notification_email": "value",
"database_ids": [
"0"
]
}'
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/key
Source: https://forge.laravel.com/api/docs.openapi
Get the public SSH key for the server.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
### Responses
#### 200 - `ServerKeyResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (serverKeys)) (required) ("serverKeys")
- **attributes** (object)
- **public_key** (string) (required)
- **fingerprint** (string) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/key"
```
```
--------------------------------
### PUT /orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Source: https://forge.laravel.com/api/docs.openapi
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **site** (integer, path, required): The site ID
- **registry** (string, path, required)
### Request Body
**Content-Type:** application/json
- **registry** (string) (required)
- **token** (string) (required)
- **scopes** (array,null)
### Responses
#### 202 - response
Empty response body
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
#### 422 - response
- **message** (string) (required): Errors overview.
- **errors** (object) (required): A detailed description of each field that failed validation.
### Example Usage
```bash
curl -X PUT "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}" \
-H "Content-Type: application/json" \
-d '{
"registry": "string",
"token": "string",
"scopes": "value"
}'
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/events/{event}
Source: https://forge.laravel.com/api/docs.openapi
Get a specific event associated with the server.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **event** (integer, path, required): The event ID
### Responses
#### 200 - `EventResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (events)) (required) ("events")
- **attributes** (object)
- **description** (string) (required): The description of the event.
- **ran_as** (string,null) (required): The server user that the event was run as.
- **created_at** (string (date-time)) (required): The date and time the event was created.
- **updated_at** (string (date-time)) (required): The date and time the event was last updated.
- **relationships** (object)
- **initiator** (object)
- **data** (object) (required)
- **type** (string (users)) (required) ("users")
- **id** (string) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
- **included** (array (UserResource))
Array items:
- **id** (string) (required)
- **type** (string (users)) (required) ("users")
- **attributes** (object)
- **name** (string) (required)
- **email** (string) (required)
- **created_at** (string,null) (required)
- **updated_at** (string,null) (required)
- **links** (object) (required)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/events/{event}"
```
```
--------------------------------
### GET /orgs/{organization}/recipes/{recipe}
Source: https://forge.laravel.com/api/docs.openapi
Show the recipe for the organization.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **recipe** (integer, path, required): The recipe ID
### Responses
#### 200 - `RecipeResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (recipes)) (required) ("recipes")
- **attributes** (object)
- **name** (string) (required): The name of the Recipe.
- **script** (string) (required): The script that should be executed.
- **user** (string) (required): The user that the Recipe should be executed as.
- **created_at** (string (date-time)) (required): The date the Recipe was created.
- **updated_at** (string (date-time)) (required): The date the Recipe was last updated.
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/recipes/{recipe}"
```
```
--------------------------------
### GET /orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs/{vpcId}
Source: https://forge.laravel.com/api/docs.openapi
Get a VPC for the provider.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **credential** (integer, path, required): The credential ID
- **region** (string, path, required)
- **vpcId** (string, path, required)
### Responses
#### 200 - `VpcResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string) (required)
- **attributes** (object)
- **name** (string) (required): The name of the vpc
- **cidrBlock** (string) (required)
- **subnets** (array (object)) (required)
Array items:
- **id** (string) (required)
- **name** (string) (required)
- **cidrBlock** (string) (required)
- **region** (string) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs/{vpcId}"
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/monitors/{monitor}
Source: https://forge.laravel.com/api/docs.openapi
Get a specific monitor associated with the server.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **monitor** (integer, path, required): The monitor ID
### Responses
#### 200 - `MonitorResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (monitors)) (required) ("monitors")
- **attributes** (object)
- **type** (string (cpu_load|disk|free_memory|used_memory)) (required) ("cpu_load"|"disk"|"free_memory"|"used_memory")
- **operator** (string (gte|lte)) (required) ("gte"|"lte")
- **threshold** (number) (required): The threshold to alert on once breached.
- **minutes** (integer,null) (required): The frequency in minutes to evaluate the monitor.
- **notify** (string) (required): The email address to notify when the monitor is in an alert state.
- **status** (string (installing|installed|removing|restarting|stopping|stopped|starting|syncing|updating|disabling|disabled|enabling|running|restoring|deleting|failed|success|failed-unknown|failed-runner|renewing)) (required) ("installing"|"installed"|"removing"|"restarting"|"stopping"|"stopped"|"starting"|"syncing"|"updating"|"disabling"|"disabled"|"enabling"|"running"|"restoring"|"deleting"|"failed"|"success"|"failed-unknown"|"failed-runner"|"renewing")
- **state** (string (OK|ALERT|UNKNOWN)) (required) ("OK"|"ALERT"|"UNKNOWN")
- **state_changed_at** (string,null) (required): The date and time the monitor state was last changed.
- **created_at** (string (date-time)) (required): The date and time the monitor was created.
- **updated_at** (string (date-time)) (required): The date and time the monitor was last updated.
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/monitors/{monitor}"
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/sites/{site}/deploy-key
Source: https://forge.laravel.com/api/docs.openapi
Get the deploy key for the site.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **site** (integer, path, required): The site ID
### Responses
#### 200 - `DeployKeyResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (deployKeys)) (required) ("deployKeys")
- **attributes** (object)
- **key** (string,null) (required): The public deploy key for the site.
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/deploy-key"
```
```
--------------------------------
### PUT /orgs/{organization}/servers/{server}/sites/{site}/environment
Source: https://forge.laravel.com/api/docs.openapi
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **site** (integer, path, required): The site ID
### Request Body
**Content-Type:** application/json
- **environment** (string) (required)
- **cache** (boolean)
- **queues** (boolean)
- **encryption_key** (string,null)
### Responses
#### 202 - response
Empty response body
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
#### 422 - response
- **message** (string) (required): Errors overview.
- **errors** (object) (required): A detailed description of each field that failed validation.
### Example Usage
```bash
curl -X PUT "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/environment" \
-H "Content-Type: application/json" \
-d '{
"environment": "string",
"cache": "true",
"queues": "true",
"encryption_key": "value"
}'
```
```
--------------------------------
### POST /orgs/{organization}/servers/{server}/sites/{site}/deploy-key
Source: https://forge.laravel.com/api/docs.openapi
Create a new deploy key for the site. If the site already has a deploy key, the existing key is returned.
Processing mode: async
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **site** (integer, path, required): The site ID
### Responses
#### 200 - `DeployKeyResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (deployKeys)) (required) ("deployKeys")
- **attributes** (object)
- **key** (string,null) (required): The public deploy key for the site.
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X POST "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/deploy-key"
```
```
--------------------------------
### GET /orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}
Source: https://forge.laravel.com/api/docs.openapi
Get a specific backup configuration for the server.
Processing mode: sync
```markdown
### Parameters
- **organization** (string, path, required): The organization slug
- **server** (integer, path, required): The server ID
- **backupConfiguration** (integer, path, required): The backup configuration ID
### Responses
#### 200 - `BackupConfigurationResource`
- **data** (object) (required)
- **id** (string) (required)
- **type** (string (backupConfigurations)) (required) ("backupConfigurations")
- **attributes** (object)
- **name** (string) (required)
- **storage_provider_id** (integer,null) (required)
- **provider** (string) (required)
- **bucket** (string,null) (required)
- **directory** (string) (required)
- **schedule** (string) (required)
- **displayable_schedule** (string) (required)
- **next_run_time** (string) (required)
- **status** (string) (required)
- **day_of_week** (integer,null) (required)
- **time** (string,null) (required)
- **cron_schedule** (string,null) (required)
- **database_ids** (array (unknown)) (required)
- **retention** (integer) (required)
- **notify_email** (string,null) (required)
- **links** (object) (required)
- **self** (object) (required)
- **href** (string (uri)) (required)
- **rel** (string)
- **describedby** (string)
- **title** (string)
- **type** (string)
- **hreflang** (string)
- **meta** (object)
#### 403 - response
- **message** (string) (required): Error overview.
#### 404 - response
- **message** (string) (required): Error overview.
### Example Usage
```bash
curl -X GET "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}"
```
```