GET
/
instances
/
{id}
/
info

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

The instance id

Response

200 - application/json
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
cloud_assigned_id
string
required

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

cloud_instance_type
string
required

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

configuration
object
required
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.

id
string
required

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

ip
string
required

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

name
string
required

The name of the instance

region
string
required

Specifies the region.

shade_cloud
boolean
required

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

shade_instance_type
string
required

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

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.

ssh_user
string
required

The SSH user used to SSH into the instance.

status
enum<string>
required

The status of the instance.

Available options:
pending,
active,
deleted
alert
object

Set a date or spend threshold to receive an email alert

auto_delete
object

Set a date or spend threshold to automatically delete the instance

envs
object[]

List of environment variable name and values to automatically add to the instance

hourly_price
integer

The hourly price of the instance in cents.

launch_configuration
object

Defines automatic actions after the instance becomes active.

ssh_key_id
string

The ID of the SSH Key.

tags
string[]

Add custom, searchable tags to instances.

volume_ids
string[]

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

volume_mount
object

Settings for mounting volumes onto file systems