Skip to main content
PATCH
Update instance

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

instance
string
required

The instance identifier

Body

application/json
name
string
Required string length: 2 - 40
size
enum<string>
Available options:
flex-512mb,
flex-1gb,
flex-2gb,
flex.c-1vcpu-256mb,
flex.g-1vcpu-512mb,
flex.m-1vcpu-1gb,
flex.c-2vcpu-512mb,
flex.g-2vcpu-1gb,
flex.m-2vcpu-2gb,
flex.c-4vcpu-1gb,
flex.g-4vcpu-2gb,
flex.m-4vcpu-4gb,
flex.c-8vcpu-2gb,
flex.g-8vcpu-4gb,
flex.m-8vcpu-8gb,
pro.c-1vcpu-1gb,
pro.g-1vcpu-2gb,
pro.m-1vcpu-4gb,
pro.c-2vcpu-2gb,
pro.g-2vcpu-4gb,
pro.m-2vcpu-8gb,
pro.c-4vcpu-4gb,
pro.g-4vcpu-8gb,
pro.m-4vcpu-16gb,
pro.c-8vcpu-8gb,
pro.g-8vcpu-16gb,
pro.m-8vcpu-32gb,
dedicated.c-0.25vcpu-512mb,
dedicated.c-0.5vcpu-1gb,
dedicated.c-1vcpu-2gb,
dedicated.g-1vcpu-4gb,
dedicated.m-1vcpu-8gb,
dedicated.c-2vcpu-4gb,
dedicated.g-2vcpu-8gb,
dedicated.m-2vcpu-16gb,
dedicated.c-4vcpu-8gb,
dedicated.g-4vcpu-16gb,
dedicated.m-4vcpu-32gb,
dedicated.c-8vcpu-16gb,
dedicated.g-8vcpu-32gb,
dedicated.m-8vcpu-64gb,
mq-pro-256mb,
mq-pro-512mb,
mq-pro-1gb,
mq-pro-2gb,
mq-pro-4gb,
mq-pro-8gb,
mq-dedicated-256mb,
mq-dedicated-512mb,
mq-dedicated-1gb,
mq-dedicated-2gb,
mq-dedicated-4gb,
mq-dedicated-8gb,
mq-dedicated-16gb,
mq.flex.256mb,
mq.flex.512mb,
mq.flex.1gb,
mq.flex.2gb,
mq.pro.256mb,
mq.pro.512mb,
mq.pro.1gb,
mq.pro.2gb,
mq.pro.4gb,
mq.pro.8gb,
mq.dedicated.flex.256mb,
mq.dedicated.flex.512mb,
mq.dedicated.flex.1gb,
mq.dedicated.flex.2gb,
mq.dedicated.pro.256mb,
mq.dedicated.pro.512mb,
mq.dedicated.pro.1gb,
mq.dedicated.pro.2gb,
mq.dedicated.pro.4gb,
mq.dedicated.pro.8gb,
mq.dedicated.pro.16gb
scaling_type
enum<string>
Available options:
none,
custom,
auto
max_replicas
integer

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

Example:

10

min_replicas
integer

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

Example:

1

hibernation_timeout
integer | null

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.

Example:

5

uses_sleep_mode
boolean
deprecated

Use hibernation_timeout instead.

sleep_timeout
integer
deprecated

Use hibernation_timeout instead.

Required range: 1 <= x <= 60
uses_scheduler
boolean
sleep_with_app
boolean

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

Example:

true

uses_octane
boolean
uses_inertia_ssr
boolean
scaling_cpu_threshold_percentage
integer | null
Required range: 50 <= x <= 95
scaling_memory_threshold_percentage
integer | null
Required range: 50 <= x <= 95
visibility_timeout
integer | null

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.

Example:

180

shutdown_timeout
integer | null

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:

90

probes
object | null

Custom health checks for the app's web process, keyed by startup, readiness, and liveness. Each check and each of its fields (path, port, delay, interval, timeout, tries) is optional and falls back to the platform default. A path selects HTTP and a port alone selects TCP. Timing overrides without a path or port keep the default handler. Only applicable to app instances; ignored otherwise. Replaces all existing checks, set to null to remove them, or omit it to keep the current checks. The startup check may take at most 600 seconds (delay + interval × tries).

Example:

Response

InstanceResource

data
InstanceResource · object
required
included
(EnvironmentResource · object | BackgroundProcessResource · object)[]