Skip to main content
API docs by Redocly

Crusoe Cloud API Gateway (v1alpha4)

Download OpenAPI specification:Download

The API Gateway exposes all publicly available API endpoints for Crusoe Cloud products.

VMs

Retrieve details about all VMs that the logged in user owns or has access to.

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

Create a new VM instance owned by the logged in user.

Request Body schema: application/json
commitment_period
integer <int64>
disks
Array of strings
ib_partition_id
string
image
string
image_checksum
string
image_id
string
location
string
name
required
string
product_name
required
string
role_id
required
string
shutdown_script
string
ssh_public_key
required
string
startup_script
string

Responses

Request samples

Content type
application/json
{
  • "commitment_period": 6,
  • "disks": [
    ],
  • "ib_partition_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "image": "ubuntu:20.04",
  • "image_checksum": "120EA8A25E5D487BF68B5F7096440019",
  • "image_id": "9f161e28-b629-442c-951c-77c68199f36e",
  • "location": "us-northcentral1-a",
  • "name": "my-first-vm",
  • "product_name": "a100.2x",
  • "role_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "shutdown_script": "\"#!/bin/bash\\necho'goodbye'\"",
  • "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCspdG97nTS/h4PEPq2QD2RYVK1jxFXLFZuSDMI8Rtxpucl6LDZLOghEYoj13lxKQnGtcsM3Iu68lh+4YgZe7CbI6cc/TxPbeAX2HJTqDh0J7+GAlLBHK9tsepC0QlhIDiazJptOPDZ3cesCBXdxSnzEbhDaqgYOfl393cp1fCeOKRIDWEP3H9CM25dCbWF66sTDziLsojJ9dMnxhgKm9/JkZc5gYncLT/2Ey+VWfV9Fs65mGUrBbQOn3c8S/nEk6WRcYn4PFOnIp0Mz+Chb50iCJrW677pllLnkTGSU+4c0H9J5z4HDG0I+91RoiQ0QsayFTYO1JtSn+THLuq98V+D",
  • "startup_script": "\"#!/bin/bash\\necho'hello'\""
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Retrieve details about a particular VM.

path Parameters
vm_id
required
string

Responses

Response samples

Content type
application/json
{
  • "instance": {
    }
}

Delete a VM that the logged in user owns.

path Parameters
vm_id
required
string

Responses

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Change the state of a VM the logged in user owns.

path Parameters
vm_id
required
string
Request Body schema: application/json
action
required
string
commitment_period
integer <int64>
product_name
string

Responses

Request samples

Content type
application/json
{
  • "action": "START",
  • "commitment_period": 6,
  • "product_name": "a100.2x"
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Attach disks to a VM the logged in user owns.

path Parameters
vm_id
required
string
Request Body schema: application/json
attach_disks
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attach_disks": [
    ]
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Detach disks from a VM the logged in user owns.

path Parameters
vm_id
required
string
Request Body schema: application/json
detach_disks
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "detach_disks": [
    ]
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Retrieve information about the types of VMs that are available to purchase along with their prices.

Responses

Response samples

Content type
application/json
{
  • "vm_types": [
    ]
}

VM-Operations

Get status of asynchronous operations

This resource retrieves information about the status of asynchronous operations initiated by the instances resource. All operations that are either in-flight or completed but not yet queried will be returned.

query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=OPERATION_STATE_IN_PROGRESS

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Get the status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the instances resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

path Parameters
operation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Images

Lists all VM images available for use.

Responses

Response samples

Content type
application/json
{
  • "images": [
    ]
}

Retrieve details about a VM image.

path Parameters
image_id
required
string

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-06-29T20:03:26Z",
  • "description": "base Ubuntu 20.04 image",
  • "id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "name": "\"ubuntu\"",
  • "tags": "[20.4, latest]"
}

Roles

Retrieve details about roles that the logged in user belongs to or owns.

If querying for roles within an organization, the logged in user must be the owner of the organization.

query Parameters
org_id
string
Example: org_id=ee2a6bc3-aed5-4756-8995-9990a53d3a17

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Update details for a role that the logged in user owns.

Requests to this resource must contain the json-encoded representation of the changes they want to make to the role. Currently only the role's name can be changed.

query Parameters
role_id
required
string
Example: role_id=f058d0db-2fa4-4cf2-8cf1-dfbcfe05a814
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Crusoe Energy"
}

Response samples

Content type
application/json
{
  • "role": {
    }
}

Create a new role that will be owned by the logged in user.

The logged in user must have the permission to create roles within the organization. A successful response from this resource contains details of the created role.

Request Body schema: application/json
name
required
string
organization_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Admin",
  • "organization_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab"
}

Response samples

Content type
application/json
{
  • "role": {
    }
}

Delete a role that the logged in user owns.

Delete operations cascade to VMs created under that role.

query Parameters
role_id
required
string
Example: role_id=f058d0db-2fa4-4cf2-8cf1-dfbcfe05a814

Responses

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "bad_credential"
}

Billing

Retrieve an intent to facilitate a Stripe action.

query Parameters
org_id
required
string
Example: org_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
intent_type
required
string
Example: intent_type=dashboard

Responses

Response samples

Content type
application/json
{}

Entities

Retrieve details about all active organizations the logged in user belongs to.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Update details for an organization that the logged in user owns.

A successful response from this resource will contain the updated organization details.

query Parameters
org_id
required
string
Example: org_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
organization_name
required
string

Responses

Request samples

Content type
application/json
{
  • "organization_name": "Crusoe Energy"
}

Response samples

Content type
application/json
{
  • "entity": {
    }
}

Create a new organization owned by the logged in user.

A successful response from this resource will contain the json encoded organization details.

Request Body schema: application/json
organization_name
required
string

Responses

Request samples

Content type
application/json
{
  • "organization_name": "Crusoe Energy"
}

Response samples

Content type
application/json
{
  • "entity": {
    }
}

Delete an organization owned by the logged in user.

Delete operations will cascade to roles and VMs, and all members will be removed from the organization.

query Parameters
org_id
required
string
Example: org_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "bad_credential"
}

Prospects

Create a new prospective customer in Crusoe Cloud.

Request Body schema: application/json
company
required
string
email
required
string
name
required
string
source
required
string
use_case
required
string

Responses

Request samples

Content type
application/json
{
  • "company": "crusoe",
  • "email": "[email protected]",
  • "name": "john",
  • "source": "portal",
  • "use_case": "training model to minimize energy usage"
}

Response samples

Content type
application/json
{
  • "success": true
}

Identities

Retrieve user details for the logged in user.

Responses

Response samples

Content type
application/json
{}

Update user details for the logged in user.

A successful response from this resource wil contain the updated user details.

Request Body schema: application/json
name
required
string
role
string

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "role": "Admin"
}

Response samples

Content type
application/json
{}

Delete the account for the logged in user.

Delete operations will cascade to all entities the user owns (organizations, roles, vms).

Responses

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "bad_credential"
}

SSH-Keys

Retrieve the list of SSH public keys registered to the logged in user.

Responses

Response samples

Content type
application/json
{
  • "ssh_keys": [
    ]
}

Register a new SSH public key to the logged in user.

A successful response from this resource wil contain the created SSH key details.

Request Body schema: application/json
name
required
string
public_key
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICpuH/fqCFLbAConChyVH6rZzSaxlnHSwQk6qvtPsf5E"
}

Response samples

Content type
application/json
{
  • "ssh_key": {
    }
}

Delete an SSH public key registered to the logged in user.

query Parameters
id
required
string
Example: id=6e28cad3-98e6-47a9-a9fc-1cd83a7f25c1

Responses

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "bad_credential"
}

Tokens

Retrieve all active/expired API tokens for the logged in user.

Responses

Response samples

Content type
application/json
{
  • "tokens": [
    ]
}

Create a new token owned by the logged in user.

A successful response from this resource will contain json-encoded details of API token. This is the only time the customer will be able to view the secret key associated with the token.

Request Body schema: application/json
alias
string
expires_at
required
string

Responses

Request samples

Content type
application/json
{
  • "alias": "token1",
  • "expires_at": "2021-12-03T19:58:34Z"
}

Response samples

Content type
application/json
{
  • "token": {
    }
}

Delete an API token owned by the logged in user.

query Parameters
access_key
required
string
Example: access_key=WTUzcGibQ82y9_01h4MCdQ

Responses

Response samples

Content type
application/json
{
  • "code": "401",
  • "message": "bad_credential"
}

Disks

Retrieve details about all disks that belong to the logged in user.

Size of disks will be in gibibytes (GiB)

Responses

Response samples

Content type
application/json
{
  • "disks": [
    ]
}

Create a new disk owned by the logged in user.

Requires either a disk snapshot ID, or size and location, where size of disk should be in gibibytes (GiB) or tebibytes (TiB) in the format [Size][Unit]. E.g. 10GiB. Disk type must be one of: DISK_TYPE_PERSISTENT_SSD. A successful response from this resource will contain the async operation.

Request Body schema: application/json
location
string
name
required
string
role_id
required
string
size
string
snapshot_id
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "location": "us-northcentral1-a",
  • "name": "my-disk",
  • "role_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "size": "10GiB",
  • "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
  • "type": "persistent-ssd"
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Retrieve details for a disk that belongs to the logged in user.

Size of disk will be in gibibytes (GiB)

path Parameters
disk_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "disks": [
    ]
}

Delete a disk owned by the logged in user.

A successful response from this resource will contain the async operation.

path Parameters
disk_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Resize a disk that the logged in user owns.

Size should be in gibibytes (GiB) or tebibytes (TiB) in the format [Size][Unit]. E.g. 10GiB A successful response from this resource will contain the async operation.

path Parameters
disk_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
size
required
string

Responses

Request samples

Content type
application/json
{
  • "size": "10GiB"
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Disk-Operations

Get status of asynchronous operations

This resource retrieves information about the status of asynchronous operations initiated by the disks resource. All operations that are either in-flight or completed but not yet queried will be returned.

query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=OPERATION_STATE_IN_PROGRESS

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Get status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the disks resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

path Parameters
operation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Snapshots

Retrieve details about all disk snapshots that belong to the logged in user.

Size of snapshots will be in bytes.

Responses

Response samples

Content type
application/json
{
  • "disk_snapshots": [
    ]
}

Create a new snapshot for a disk owned by the logged in user.

A successful response from this resource will contain the async operation.

Request Body schema: application/json
disk_id
required
string
role_id
required
string

Responses

Request samples

Content type
application/json
{
  • "disk_id": "123e4567-e89b-12d3-a456-426614174000",
  • "role_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1"
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Retrieve details about a disk snapshot that belongs to the logged in user.

Size of snapshot will be in bytes.

path Parameters
snapshot_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "disk_snapshots": [
    ]
}

Delete a disk snapshot owned by the logged in user.

A successful response from this resource will contain the async operation.

path Parameters
snapshot_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Snapshot-Operations

Get status of asynchronous operations

This resource retrieves information about the status of asynchronous operations initiated by the snapshots resource. All operations that are either in-flight or completed but not yet queried will be returned.

query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=OPERATION_STATE_IN_PROGRESS

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Get status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the snapshots resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

path Parameters
operation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

VPC-Firewall-Rules

Retrieve details about all VPC firewall rules that belong to the logged in user.

Responses

Response samples

Content type
application/json
{
  • "firewall_rules": [
    ]
}

Create a new VPC firewall rule owned by the logged in user.

A successful response from this resource will contain the async operation.

Request Body schema: application/json
action
required
string
Enum: "allow" "deny"
destination_ports
Array of strings
required
Array of objects (FirewallRuleObject specifies the source or destination of a firewall rule.)
direction
required
string
Enum: "ingress" "egress"
name
required
string
protocols
required
Array of strings
role_id
required
string
source_ports
Array of strings
required
Array of objects (FirewallRuleObject specifies the source or destination of a firewall rule.)
vpc_network_id
required
string

Responses

Request samples

Content type
application/json
{
  • "action": "allow",
  • "destination_ports": "[80, 443, 3000-8080]",
  • "destinations": [
    ],
  • "direction": "ingress",
  • "name": "my-firewall-rule",
  • "protocols": "[tcp, udp]",
  • "role_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "source_ports": "[80, 443, 3000-8080]",
  • "sources": [
    ],
  • "vpc_network_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1"
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Retrieve details for a VPC firewall rule that belongs to the logged in user.

path Parameters
vpc_firewall_rule_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "firewall_rules": [
    ]
}

Delete a VPC firewall rule owned by the logged in user.

A successful response from this resource will contain the async operation.

path Parameters
vpc_firewall_rule_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "operation": {
    }
}

Patch (update) a VPC firewall rule owned by the logged in user.

A successful response from this resource will contain the async operation.

path Parameters
vpc_firewall_rule_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
destination_ports
Array of strings
Array of objects (FirewallRuleObject specifies the source or destination of a firewall rule.)
name
string
protocols
Array of strings
source_ports
Array of strings
Array of objects (FirewallRuleObject specifies the source or destination of a firewall rule.)

Responses

Request samples

Content type
application/json
{
  • "destination_ports": "[80, 443, 3000-8080]",
  • "destinations": [
    ],
  • "name": "my-firewall-rule",
  • "protocols": "[tcp, udp]",
  • "source_ports": "[80, 443, 3000-8080]",
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "operation": {
    }
}

VPC-Firewall-Rule-Operations

Get status of asynchronous operations

This resource retrieves information about the status of asynchronous operations initiated by the snapshots resource. All operations that are either in-flight or completed but not yet queried will be returned.

query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=OPERATION_STATE_IN_PROGRESS

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Get status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the snapshots resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

path Parameters
operation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

VPC-Networks

Retrieve details about all VPC networks that belong to the logged in user.

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ]
}

Retrieve details for a VPC network that belongs to the logged in user.

path Parameters
vpc_network_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ]
}

VPC-Subnets

Retrieve details about all VPC subnets that belong to the logged in user.

Responses

Response samples

Content type
application/json
{
  • "subnets": [
    ]
}

Retrieve details for a VPC subnet that belongs to the logged in user.

path Parameters
vpc_subnet_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "subnets": [
    ]
}

Locations

Lists all Crusoe Cloud locations usable for resource hosting.

Responses

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

Capacities

Lists available Crusoe Cloud capacity with optional filters on location and product name.

query Parameters
product_name
Array of strings
Example: product_name=[a100.1x, a100.2x]
location
Array of strings
Example: location=[us-northcentral1-a, us-northcentral1-b]

Responses

Response samples

Content type
application/json
{
  • "capacities": [
    ]
}