Cloud Bursting

Cedana API for cloud bursting

List instances

get

Responses

200

List of instances

application/json

cloud_providerstringRequired

created_atstring · nullableOptional

idstringRequired

instance_typestringRequired

namestringRequired

regionstringRequired

statusstringRequired

500

Internal server error

application/json

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/instances

GET /v1/instances HTTP/1.1
Accept: */*

[
  {
    "cloud_provider": "text",
    "created_at": null,
    "id": "text",
    "instance_type": "text",
    "name": "text",
    "region": "text",
    "status": "text"
  }
]

Create instance

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

cloudstringRequired

namestringRequired

osstring · nullableOptional

regionstringRequired

shade_cloudbooleanRequired

shade_instance_typestringRequired

ssh_key_idstring · nullableOptional

tagsstring[] · nullableOptional

template_idstring · nullableOptional

volume_idsstring[] · nullableOptional

Responses

200

Instance created successfully

application/json

cloud_providerstringRequired

instance_idstringRequired

instance_typestringRequired

regionstringRequired

statusstringRequired

400

Invalid request

application/json

500

Internal server error

application/json

4XX

Client error

application/json

5XX

Server error

application/json

post/v1/instances

POST /v1/instances HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "alert": null,
  "auto_delete": null,
  "cloud": "text",
  "envs": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "launch_configuration": null,
  "name": "text",
  "os": null,
  "region": "text",
  "shade_cloud": true,
  "shade_instance_type": "text",
  "ssh_key_id": null,
  "tags": [
    "text"
  ],
  "template_id": null,
  "volume_ids": [
    "text"
  ],
  "volume_mount": null
}

{
  "cloud_provider": "text",
  "instance_id": "text",
  "instance_type": "text",
  "region": "text",
  "status": "text"
}

Get configuration status

get

Responses

200

Bursting configuration status

application/json

can_use_burstingbooleanRequired

messagestringRequired

statusstring · enumRequiredPossible values:

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/instances/bursting-status

GET /v1/instances/bursting-status HTTP/1.1
Accept: */*

{
  "can_use_bursting": true,
  "message": "text",
  "status": "not_configured"
}

Get available instance types

get

Query parameters

num_gpusinteger · int32Optional

Filter by number of GPUs

gpu_typestringOptional

Filter by GPU type

sortstringOptional

Sort results (e.g., 'price')

Responses

200

Available instance types

application/json

cloudstringRequired

cloud_instance_typestringRequired

deployment_typestringRequired

hourly_priceinteger · int32Required

shade_instance_typestringRequired

500

Internal server error

application/json

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/instances/types

GET /v1/instances/types HTTP/1.1
Accept: */*

[
  {
    "availability": [
      {
        "available": true,
        "display_name": "text",
        "region": "text"
      }
    ],
    "boot_time": {
      "max_boot_in_sec": 1,
      "min_boot_in_sec": 1
    },
    "cloud": "text",
    "cloud_instance_type": "text",
    "configuration": {
      "gpu_type": "text",
      "interconnect": "text",
      "memory_in_gb": 1,
      "num_gpus": 1,
      "nvlink": true,
      "os_options": [
        "text"
      ],
      "storage_in_gb": 1,
      "vcpus": 1,
      "vram_per_gpu_in_gb": 1
    },
    "deployment_type": "text",
    "hourly_price": 1,
    "shade_instance_type": "text"
  }
]

Delete instance

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

instance_idstringRequired

Instance ID to delete

Responses

200

Instance deleted successfully

text/plain

stringOptional

500

Failed to delete instance

application/json

4XX

Client error

application/json

5XX

Server error

application/json

delete/v1/instances/{instance_id}

DELETE /v1/instances/{instance_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Get instance status

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

instance_idstringRequired

Instance ID

Responses

200

Instance status

application/json

created_atstring · nullableOptional

instance_idstringRequired

ip_addressstring · nullableOptional

metadataanyRequired

ssh_portinteger · nullableOptional

ssh_userstring · nullableOptional

statusstringRequired

404

Instance not found

application/json

500

Failed to get status

application/json

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/instances/{instance_id}/status

GET /v1/instances/{instance_id}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created_at": null,
  "instance_id": "text",
  "ip_address": null,
  "metadata": null,
  "ssh_port": null,
  "ssh_user": null,
  "status": "text"
}