Instances

Update instance

Update an instance.

patch/instances/{instance}

Request

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

Path parameters

instancestring required

The instance identifier

Request body

namestring

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

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.

hibernation_timeoutinteger nullable

Number of minutes before the application hibernates. Set to null to disable hibernation, or omit it to avoid changing the hibernation settings. Takes precedence over the deprecated uses_sleep_mode and sleep_timeout fields.

uses_sleep_modeboolean

Use hibernation_timeout instead.

sleep_timeoutinteger

Use hibernation_timeout instead.

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.

uses_octaneboolean

uses_inertia_ssrboolean

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,
  "hibernation_timeout": 5,
  "sleep_with_app": true,
  "visibility_timeout": 180,
  "shutdown_timeout": 90,
  "probes": {
    "startup": {
      "path": "/up",
      "tries": 60
    },
    "readiness": {
      "path": "/up"
    }
  }
}

Response

InstanceResource

Changes

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