v1

latestOpenAPI 3.0.02026-07-13288558.3 KB

/instances/{id}/info

Get details for the specified, non deleted, instance in the url.

get/instances/{id}/info

Response

Return an instance object.

idstring uuid required

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

cloudstring required

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

regionstring required

Specifies the region.

shade_instance_typestring required

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

cloud_instance_typestring required

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

cloud_assigned_idstring required

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

shade_cloudboolean required

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

namestring required

The name of the instance

ipstring required

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

ssh_userstring required

The SSH user used to SSH into the instance.

ssh_portinteger 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.

The status of the instance.

status_detailsstring

Additional context for the status

cost_estimatestring 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.

hourly_priceinteger

The hourly price of the instance in cents.

volume_idsVolumeID[]

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

ssh_key_idstring

The ID of the SSH Key.

tagsTag[]

Add custom, searchable tags to instances.

active_atstring date-time

The timestamp of when the instance was active in UTC.

created_atstring date-time required

The timestamp of when the instance was created in UTC.

deleted_atstring date-time required

The timestamp of when the instance was deleted in UTC.

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "cloud": "hyperstack",
  "region": "canada-1",
  "shade_instance_type": "A6000",
  "cloud_instance_type": "gpu_1x_a6000",
  "cloud_assigned_id": "13b057d7-e266-4869-985f-760fe75a78b3",
  "shade_cloud": true,
  "name": "cool-gpu-server",
  "configuration": {
    "memory_in_gb": 12,
    "storage_in_gb": 256,
    "vcpus": 6,
    "num_gpus": 1,
    "gpu_type": "A100",
    "interconnect": "pcie",
    "nvlink": true,
    "vram_per_gpu_in_gb": 48,
    "gpu_manufacturer": "nvidia",
    "os": "ubuntu_22_shade_os"
  },
  "ip": "1.0.0.1",
  "ssh_user": "shadeform",
  "ssh_port": 22,
  "status": "active",
  "status_details": "downloading",
  "cost_estimate": "103.4",
  "hourly_price": 210,
  "volume_ids": [
    "78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40"
  ],
  "ssh_key_id": "78a0dd5a-dbb1-4568-b55c-5e7e0a8b0c40",
  "launch_configuration": {
    "type": "docker",
    "docker_configuration": {
      "image": "vllm/vllm-openai:latest",
      "args": "--model mistralai/Mistral-7B-v0.1",
      "shared_memory_in_gb": 8,
      "envs": [
        {
          "name": "HUGGING_FACE_HUB_TOKEN",
          "value": "hugging_face_api_token"
        }
      ],
      "port_mappings": [
        {
          "host_port": 80,
          "container_port": 8000
        }
      ],
      "volume_mounts": [
        {
          "host_path": "~/.cache/huggingface",
          "container_path": "/root/.cache/huggingface"
        }
      ],
      "registry_credentials": {
        "username": "username",
        "password": "password"
      }
    },
    "script_configuration": {
      "base64_script": "IyEvYmluL2Jhc2gKCiMgRW5kbGVzcyBsb29wCndoaWxlIHRydWUKZG8KICAgICMgRmV0Y2ggYSBjYXQgZmFjdCB3aXRoIGEgbWF4aW11bSBsZW5ndGggb2YgMTQwIGNoYXJhY3RlcnMKICAgIGN1cmwgLS1uby1wcm9ncmVzcy1tZXRlciBodHRwczovL2NhdGZhY3QubmluamEvZmFjdD9tYXhfbGVuZ3RoPTE0MAoKICAgICMgUHJpbnQgYSBuZXdsaW5lIGZvciByZWFkYWJpbGl0eQogICAgZWNobwoKICAgICMgU2xlZXAgZm9yIDMgc2Vjb25kcyBiZWZvcmUgdGhlIG5leHQgaXRlcmF0aW9uCiAgICBzbGVlcCAzCmRvbmUKCgo="
    }
  },
  "auto_delete": {
    "date_threshold": "2006-01-02T15:04:05-07:00",
    "spend_threshold": "3.14"
  },
  "alert": {
    "date_threshold": "2006-01-02T15:04:05-07:00",
    "spend_threshold": "3.14"
  },
  "tags": [
    "tag1"
  ],
  "envs": [
    {
      "name": "HUGGING_FACE_HUB_TOKEN",
      "value": "hugging_face_api_token"
    }
  ],
  "port_mappings": [
    {
      "internal_port": 8000,
      "external_port": 80
    }
  ],
  "active_at": "2016-08-29T09:12:33.001Z",
  "created_at": "2016-08-29T09:12:33.001Z",
  "deleted_at": "2016-08-29T09:12:33.001Z",
  "boot_time": {
    "min_boot_in_sec": 180,
    "max_boot_in_sec": 300
  }
}