Skip to main content
POST
/
orgs
/
{organization}
/
servers
/
{server}
/
sites
/
balancer
Create site on a load balancer
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/balancer",
  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([
    'domain' => '<string>',
    'allow_wildcard_subdomains' => true,
    'balancer_method' => 'round_robin',
    'balancer_keepalive_max_connections' => 128,
    'balancing' => [
        [
                'server_id' => 123,
                'port' => 32768,
                'weight' => 2,
                'backup' => true,
                'down' => true
        ]
    ]
  ]),
  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;
}
{
  "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": "<string>",
      "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_script": "<string>",
      "wildcards": true,
      "app_type": "<string>",
      "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>"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

organization
string
required

The organization slug

server
integer
required

The server ID

Body

application/json
domain
string
required
allow_wildcard_subdomains
boolean
balancer_method
enum<string>
Available options:
round_robin,
least_conn,
ip_hash
balancer_keepalive_max_connections
integer
Required range: 0 <= x <= 256
balancing
object[]
Minimum array length: 1

Response

SiteResource

data
SiteResource · object
required