/instances/{id}/info

id

string

required

The unique identifier for the instance. Used in the instances for the /instances/{id}/info and /instances/{id}/delete APIs.

cloud

enum<string>

required

Specifies the underlying cloud provider. See this explanation for more details.

Available options:

aws,

azure,

lambdalabs,

tensordock,

runpod,

latitude,

jarvislabs,

oblivus,

paperspace,

datacrunch,

massedcompute,

vultr

region

string

required

Specifies the region.

shade_instance_type

string

required

The Shadeform standardized instance type. See this explanation for more details.

cloud_instance_type

string

required

The instance type for the underlying cloud provider. See this explanation for more details.

cloud_assigned_id

string

required

The unique identifier of the instance issued by the underlying cloud provider.

shade_cloud

boolean

required

Specifies if the instance is launched in Shade Cloud or in a linked cloud account.

name

string

required

The name of the instance

configuration

object

required

ip

string

required

The public IP address of the instance. In select cases, it may also be the DNS.

ssh_user

string

required

The SSH user used to SSH into the instance.

ssh_port

integer

required

The SSH port of the instance. In most cases, this will be port 22 but for some clouds, this may be a different port.

status

enum<string>

required

The status of the instance.

Available options:

pending,

active,

deleted

cost_estimate

string

required

The cost incurred by the instance. This only the cost via Shadeform. If the instance is deployed in your own cloud account, then all billing is through your cloud provider.

created_at

string

required

The timestamp of when the instance was created in UTC.

deleted_at

string

required

The timestamp of when the instance was deleted in UTC.

hourly_price

integer

The hourly price of the instance in cents.

volume_ids

string[]

List of volume IDs to be mounted. Currently only supports 1 volume at a time.

ssh_key_id

string

The ID of the SSH Key.

launch_configuration

object

Defines automatic actions after the instance becomes active.

launch_configuration.type

enum<string>

required

Specifies the type of launch configuration. See Launch Configuration for more details.

Available options:

docker,

script

launch_configuration.docker_configuration

object

May only be used if launch_configuration.type is 'docker'. Use docker_configuration to automatically pull and run a docker image. See this tutorial for examples.

launch_configuration.script_configuration

object

May only be used if launch_configuration.type is 'script'. Configures a startup script to be run automatically after the instance is active. See this [tutorial]/guides/startupscript) for examples.

auto_delete

object

Set a date or spend threshold to automatically delete the instance

alert

object

Set a date or spend threshold to receive an email alert

volume_mount

object

Settings for mounting volumes onto file systems

Instances

SSH Keys

Volumes

API Documentation

Authorizations

Path Parameters

Response