Open in AI

Servers

Switch auto-renew

With auto-renew on, the server renews for one month from the balance before it expires.

PATCH/servers/{id}/auto-renew

Authorization

Authorizationheaderrequired

Bearer rv_…, a key with the renew scope. About keys

Path parameters

idstring (uuid)required

The server id from List servers.

Body

application/json

enabledbooleanrequired

On or off.

Response

idstring (uuid)

The server id.

hostnamestring | null

The name you gave it.

ip_addressstring | null

Public IPv4 address, null while it’s being created.

statusstring

provisioning, reinstalling, moving, running, stopped, suspended, expired or deleted.

distro_namestring | null

Operating system, e.g. Windows Server 2022.

plan_idinteger

The plan, see List plans.

region_idinteger

The location, see List locations.

distro_idinteger

The operating system, see List operating systems.

sell_pricestring (decimal)

Monthly price in USD.

duration_monthsinteger

The term it was ordered for.

expiry_datestring (datetime) | null

Paid until.

auto_renewboolean

Renews from the balance before it expires.

created_atstring (datetime)

When it was ordered.

suspended_atstring (datetime) | null

Set while the server is suspended.

suspend_reasonstring | null

Why, when it is.

Status codes

200Success.
401No key, a wrong key, or a revoked or expired one.
429More than 120 requests a minute with one key, or too many wrong keys from one address.