Instances

Create instance

Create a new instance for an environment.

post/environments/{environment}/instances

Request

Base URL
https://cloud.laravel.com/api
Auth
HTTP bearer

Path parameters

environmentstring required

The environment identifier

Request body

namestring required

type'service' | 'managed_queue' required

scaling_type'none' | 'custom' | 'auto' required

max_replicasinteger

The maximum number of replicas the instance can scale to. Only applicable to the custom scaling type, and rejected when used with auto.

min_replicasinteger

The minimum number of replicas the instance runs. Only applicable to the custom scaling type, and rejected when used with auto. Not applicable to managed queues, which always scale to zero when idle.

uses_schedulerboolean

sleep_with_appboolean

Whether worker replicas scale to zero alongside the app cluster, waking when they receive traffic. Only applicable to worker (service) instances.

scaling_cpu_threshold_percentageinteger nullable

scaling_memory_threshold_percentageinteger nullable

visibility_timeoutinteger nullable

How long a message stays hidden from other workers while one is processing it. Only available when the organization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.

shutdown_timeoutinteger nullable

The time a worker has to finish its current job before being forcefully shut down. Only available when the organization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.

Example request

{
  "max_replicas": 10,
  "min_replicas": 1,
  "sleep_with_app": true,
  "visibility_timeout": 180,
  "shutdown_timeout": 90,
  "background_processes": [
    {
      "command": "php artisan my:command",
      "config": {
        "connection": "redis",
        "queue": "default,emails",
        "tries": 3,
        "backoff": 30,
        "sleep": 3,
        "timeout": 60
      }
    }
  ]
}

Response

InstanceResource

Changes

No recorded changes to this operation across all 1 revision of this API.