instance_create

Create instance
post/v1/instances

Query Parameters

project

Request Body

Create-time parameters for an Instance

Object
description
disks

The disks to be created or attached for this instance.

Describe the instance's disks at creation time

external_ips

The external IP addresses provided to this instance.

By default, all instances have outbound connectivity, but no inbound connectivity. These external addresses can be used to provide a fixed, known IP address for making inbound connections to the instance.

Parameters for creating an external IP address for instances.

hostname

A hostname identifies a host on a network, and is usually a dot-delimited sequence of labels, where each label contains only letters, digits, or the hyphen. See RFCs 1035 and 952 for more details.

memory

Byte count to express memory or storage capacity.

name

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

ncpus

The number of CPUs in an Instance

network_interfaces

The network interfaces to be created for this instance.

Describes an attachment of an InstanceNetworkInterface to an Instance, at the time the instance is created.

ssh_public_keys

An allowlist of SSH public keys to be transferred to the instance via cloud-init during instance creation.

If not provided, all SSH public keys from the user's profile will be sent. If an empty list is provided, no public keys will be transmitted to the instance.

start

Should this instance be started upon creation; true by default.

user_data

User data for instance initialization systems (such as cloud-init). Must be a Base64-encoded string, as specified in RFC 4648 § 4 (+ and / characters with padding). Maximum 32 KiB unencoded data.

Responses

Object
description

human-readable free-form text about a resource

hostname

RFC1035-compliant hostname for the Instance.

id

unique, immutable, system-controlled identifier for each resource

memory

memory allocated for this Instance

Byte count to express memory or storage capacity.

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

ncpus

number of CPUs allocated for this Instance

The number of CPUs in an Instance

project_id

id for the project containing this Instance

run_state

Running state of an Instance (primarily: booted or stopped)

This typically reflects whether it's starting, running, stopping, or stopped, but also includes states related to the Instance's lifecycle

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified

time_run_state_updated