Create site

Add a new site to the server.

Processing mode: async

POST /orgs/{organization}/servers/{server}/sites

Create site

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'domain_mode' => '<string>',
    'www_redirect_type' => 'from-www',
    'allow_wildcard_subdomains' => false,
    'root_directory' => '<string>',
    'web_directory' => '<string>',
    'is_isolated' => true,
    'isolated_user' => '<string>',
    'zero_downtime_deployments' => true,
    'shared_paths' => [
        [
                'from' => '<string>',
                'to' => '<string>'
        ]
    ],
    'nginx_template_id' => 123,
    'source_control_provider_id' => 123,
    'repository' => '<string>',
    'branch' => '<string>',
    'database_id' => 123,
    'database_user_id' => 123,
    'statamic_setup' => '<string>',
    'statamic_starter_kit' => '<string>',
    'statamic_super_user_email' => '[e-mail]',
    'statamic_super_user_password' => '<string>',
    'install_composer_dependencies' => true,
    'generate_deploy_key' => true,
    'public_deploy_key' => '<string>',
    'private_deploy_key' => '<string>',
    'frontend_package_manager' => '<string>',
    'frontend_build_command' => '<string>',
    'nuxt_next_mode' => '<string>',
    'nuxt_next_port' => 123,
    'push_to_deploy' => false,
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

202

{
  "data": {
    "id": "<string>",
    "type": "sites",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "name": "<string>",
      "status": "installed",
      "url": "<string>",
      "user": "<string>",
      "https": true,
      "web_directory": "<string>",
      "root_directory": "<string>",
      "aliases": [
        "<unknown>"
      ],
      "php_version": null,
      "deployment_status": "<string>",
      "quick_deploy": true,
      "isolated": true,
      "shared_paths": {},
      "repository": {
        "provider": "<string>",
        "url": "<string>",
        "branch": "<string>",
        "status": "installed"
      },
      "database": "<string>",
      "maintenance_mode": {
        "enabled": true,
        "status": "disabling"
      },
      "zero_downtime_deployments": true,
      "deployment_retention": 123,
      "deployment_script": "<string>",
      "wildcards": true,
      "app_type": "Statamic",
      "uses_envoyer": true,
      "deployment_url": "<string>",
      "healthcheck_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "server": {
        "data": {
          "type": "servers",
          "id": "<string>"
        }
      },
      "tags": {
        "data": [
          {
            "type": "tags",
            "id": "<string>"
          }
        ]
      },
      "latestDeployment": {
        "data": {
          "type": "deployments",
          "id": "<string>"
        }
      },
      "securityRules": {
        "data": [
          {
            "type": "securityRules",
            "id": "<string>"
          }
        ]
      },
      "redirectRules": {
        "data": [
          {
            "type": "redirect-rules",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "servers",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "id": 123,
        "credential_id": 123,
        "name": "<string>",
        "slug": "<string>",
        "type": "app",
        "ubuntu_version": "<string>",
        "ssh_port": 123,
        "provider": "<string>",
        "identifier": "<string>",
        "size": "<string>",
        "region": "<string>",
        "php_version": "<string>",
        "php_cli_version": "<string>",
        "opcache_status": "<string>",
        "database_type": "<string>",
        "db_status": "<string>",
        "redis_status": "<string>",
        "ip_address": "<string>",
        "private_ip_address": "<string>",
        "revoked": true,
        "created_at": "2025-07-29T09:00:00Z",
        "updated_at": "2025-07-30T09:00:00Z",
        "connection_status": "<string>",
        "timezone": "<string>",
        "local_public_key": "<string>",
        "is_ready": true
      },
      "relationships": {
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

site:create

Allow members to create sites

Path Parameters

organization · string · required

The organization slug

server · integer · required

The server ID

Body

application/json

type · enum<string> · required

Available options: laravel, symfony, statamic, wordpress, phpmyadmin, php, nextjs, nuxtjs, static-html, other, custom

name · Option 1 · string Option 2 · string · required

domain_mode · string enum<string>

www_redirect_type · enum<string>

The type of www redirection to apply to the domain.

Available options: from-www, to-www, none

Example:

"from-www"

allow_wildcard_subdomains · boolean

Whether to allow wildcard subdomains for the domain.

Example:

false

root_directory · string | null

Pattern: ^[^\s]+$

web_directory · string | null

Pattern: ^[^\s]+$

is_isolated · boolean

isolated_user · string

Maximum string length: 32

Pattern: ^[a-z][\-a-z0-9_]*$

php_version · enum<string>

Available options: php5, php56-old, php56, php70, php71, php72, php73, php74, php80, php81, php82, php83, php84, php85

zero_downtime_deployments · boolean

shared_paths · object[]

A list of files or directories to be shared between releases for zero-downtime deployments.

Show child attributes

nginx_template_id · integer

source_control_provider · enum<string> | null

All supported source control providers.

Available options: github, gitlab, bitbucket, gitlab-custom, custom

source_control_provider_id · integer | null

repository · string | null

branch · string | null

database_id · integer

The ID of the database to use with the site.

database_user_id · integer

The ID of the database user to use with the site.

statamic_setup · string

The type of setup for Statmic apps.

statamic_starter_kit · string

The starter kit for the Statamic app.

statamic_super_user_email · string<email>

statamic_super_user_password · string | null

install_composer_dependencies · boolean

generate_deploy_key · boolean

public_deploy_key · string

private_deploy_key · string

frontend_package_manager · string

The package manager for frontend applications.

frontend_build_command · string

The build command for frontend assets.

nuxt_next_mode · string

The render mode for Next/Nuxt applications.

nuxt_next_port · integer

The port used for Next/Nuxt applications.

push_to_deploy · boolean · default: false

Automatically trigger a new deployment when changes are pushed to the environment's Git branch.

tags · string[] | null

Response

202

application/vnd.api+json

SiteResource

data · SiteResource · object · required

Show child attributes

included · (ServerResource · object | TagResource · object | DeploymentResource · object | SecurityRuleResource · object | RedirectRuleResource · object)[]

ServerResource

TagResource

DeploymentResource

SecurityRuleResource

RedirectRuleResource

Show child attributes