Skip to main content
API docs by Redocly

Crusoe Cloud API Gateway (v1alpha5)

Download OpenAPI specification:Download

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

VMs

Create new VM instances owned by the logged in user.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
count
required
integer <int64>

The number of VMs to create. If multiple locations are specified, this will be the number of VMs created in each location.

instance_group_id
string

The ID of the instance group the VMs will be created in.

object (InstanceTemplate defines the specifications of VMs to be created during bulk VM creation.)
instance_template_id
string

The ID of the instance template to use for creating the VMs.

Array of objects (BulkCreateLocationInfo)

The locations to create the VMs in. This will override any location specified in the instance template.

name_prefix
required
string

The name prefix for the VMs to be created. E.g. "my-vm" will create VMs with names "my-vm-1",

object (ReservationSpecification)

Responses

Request samples

Content type
application/json
{
  • "count": 6,
  • "instance_group_id": "cda562c4-6162-4565-95f3-ce06a8220c07",
  • "instance_template": {
    },
  • "instance_template_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "locations": [
    ],
  • "name_prefix": "my-vm",
  • "reservation_specification": {
    }
}

Response samples

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
ids
string
Example: ids=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
names
string
Example: names=my-first-vm
types
string
Example: types=a40.2x,a100.8x
locations
string
Example: locations=us-east1,us-northcentral1
states
string
Example: states=STATE_RUNNING
limit
string
Example: limit=20
sort
string
Example: sort=name
next_token
string
Example: next_token=bXktZmlyc3Qtdm0
prev_token
string
Example: prev_token=bXktZmlyc3Qtdm0

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_page_token": "bXktbGFzdC12bQ",
  • "prev_page_token": "bXktZmlyc3Qtdm0"
}

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
commitment_period
integer <int64>

commitment is no longer supported

custom_image
string

either image or custom image should be supplied, not both.

Array of objects (DiskAttachment)
Array of objects (PartialHostChannelAdapter is used when POSTing and PATCHing VMs to assign IB Partitions.)
image
string
location
required
string
maintenance_policy
string

The Host Maintenance Policy to use.

name
required
string
Array of objects (NetworkInterface)
object (ReservationSpecification)
shutdown_script
string
ssh_public_key
required
string
startup_script
string
type
required
string
object (VirtualizationFeatures)

Responses

Request samples

Content type
application/json
{
  • "commitment_period": 0,
  • "custom_image": "string",
  • "disks": "[{disk_id: \"09ae8411-0fbb-411c-898c-2b8f19622ae1\", mode: \"read-write\", attach_type: \"data\"},",
  • "host_channel_adapters": [
    ],
  • "image": "ubuntu:20.04",
  • "location": "us-northcentral1-a",
  • "maintenance_policy": "stop-vm",
  • "name": "my-first-vm",
  • "network_interfaces": [
    ],
  • "reservation_specification": {
    },
  • "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'",
  • "type": "a100.2x",
  • "virtualization_features": {
    }
}

Response samples

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

Retrieve details about a particular VM.

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

Responses

Response samples

Content type
application/json
{
  • "commitment_end": "string",
  • "commitment_period": 0,
  • "created_at": "2021-12-03T19:58:34Z",
  • "disks": [
    ],
  • "host_channel_adapters": [
    ],
  • "id": "ca39e669-47ee-456b-968d-303234fbf99f",
  • "instance_group_id": "707749bd-ecad-4de8-aa00-1ae2fdb99e19",
  • "instance_template_id": "75c6712a-8da8-463c-a72d-fc65cf922959",
  • "location": "us-centralnorth1-a",
  • "maintenance_policy": "stop-vm",
  • "name": "my-first-vm",
  • "network_interfaces": [
    ],
  • "pod_id": "29d20dc4-90ad-4365-ab05-83f5f5e52d94",
  • "project_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  • "state": "RUNNING",
  • "type": "a100.2x",
  • "updated_at": "2023-08-14T09:00:35Z",
  • "virtualization_features": {
    }
}

Delete a VM that the logged in user owns.

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

Responses

Response samples

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vm_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
action
required
string
Enum: "START" "STOP" "RESET" "RESERVE" "UNRESERVE" "UPDATE"

The action to perform on the VM. RESERVE and UNRESERVE operations are done synchronously, and so will have succeeded with a 200 response.

commitment_period
integer <int64>

CommitmentPeriod is deprecated, please use reservationID instead

Array of objects (PartialHostChannelAdapter is used when POSTing and PATCHing VMs to assign IB Partitions.)
maintenance_policy
string

The host maintenance policy to use.

Array of objects (NetworkInterface)
reservation_id
string
type
string

Responses

Request samples

Content type
application/json
{
  • "action": "START",
  • "commitment_period": 0,
  • "host_channel_adapters": [
    ],
  • "maintenance_policy": "stop-vm",
  • "network_interfaces": [
    ],
  • "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  • "type": "a100.2x"
}

Response samples

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

Attach disks to a VM the logged in user owns.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vm_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
required
Array of objects (DiskAttachment)
Array
attachment_type
required
string
Enum: "os" "data"
disk_id
required
string
mode
required
string
Enum: "read-only" "read-write"

Responses

Request samples

Content type
application/json
{
  • "attach_disks": "[{disk_id: \"09ae8411-0fbb-411c-898c-2b8f19622ae1\", mode: \"read-write\", attachment_type: \"data\"}, {disk_id: \"b1f86d1b-42d2-490d-adb0-cc1029abf653\", mode: \"read-only\", attachment_type: \"data\"}]"
}

Response samples

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

Detach disks from a VM the logged in user owns.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vm_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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.

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

Responses

Response samples

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

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.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=IN_PROGRESS
lower_time_bound
string
Example: lower_time_bound=2021-12-03T19:58:34Z

Responses

Response samples

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

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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

Images

Lists all VM images available for use.

Responses

Response samples

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

Retrieve details about a VM image.

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

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",
  • "locations": "[us-east1, us-northcentral1]",
  • "name": "ubuntu",
  • "tags": "[20.4, latest]"
}

Instance Templates

Lists all VM instance templates available for use.

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

Responses

Response samples

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

Create a VM instance template, for use in bulk VM creation.

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

Custom image to use for all VMs created from this instance template. Only one of Image or CustomImage should be supplied at once.

Array of objects (DiskTemplate defines a disk to create for each VM during bulk VM creation.)

Disks to create for all VMs created from this instance template.

ib_partition_id
string

IB Partition to use for all VMs created from this instance template. Should only be provided for IB-enabled VM types. This is location-specific and must be provided if location is provided.

image_name
string

OS Image to use for all VMs created from this instance template.

location
string

Location to use for all VMs created from this instance template. If provided, all location-specific resources must also be provided.

maintenance_policy
string

THe Host Maintenance Policy to use.

placement_policy
string

The VM Placement Policy to use.

public_ip_address_type
string

Public IP address type to use for all VMs created from this instance template. Must either be "static" or "dynamic".

reservation_id
string
shutdown_script
string

Shutdown script to use for all VMs created from this instance template.

ssh_public_key
required
string

SSH public key to use for all VMs created from this instance template.

startup_script
string

Startup script to use for all VMs created from this instance template.

subnet_id
string

Subnet to use for all VMs created from this instance template. This is location-specific and must be provided if location is provided.

template_name
required
string

Name of the instance template. (This is not the name of the VMs created from this instance template.)

type
required
string

Product name of the VM type we want to create from this instance template.

object (VirtualizationFeatures)

Responses

Request samples

Content type
application/json
{
  • "custom_image_name": "ubuntu:20.04",
  • "disks": [
    ],
  • "ib_partition_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "image_name": "ubuntu:20.04",
  • "location": "us-northcentral1-a",
  • "maintenance_policy": "stop-vm",
  • "placement_policy": "spread",
  • "public_ip_address_type": "static",
  • "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  • "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'\"",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "template_name": "my-instance-template",
  • "type": "a100.2x",
  • "virtualization_features": {
    }
}

Response samples

Content type
application/json
{
  • "created_at": "2024-01-01T00:00:00Z",
  • "custom_image_name": "ubuntu:20.04",
  • "disks": [
    ],
  • "ib_partition_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "image_name": "ubuntu:20.04",
  • "location": "us-northcentral1-a",
  • "maintenance_policy": "stop-vm",
  • "name": "my-instance-template",
  • "placement_policy": "spread",
  • "project_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "public_ip_address_type": "static",
  • "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  • "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'",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "type": "a100.2x",
  • "virtualization_features": {
    }
}

Retrieve details about a VM instance template.

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

Responses

Response samples

Content type
application/json
{
  • "created_at": "2024-01-01T00:00:00Z",
  • "custom_image_name": "ubuntu:20.04",
  • "disks": [
    ],
  • "ib_partition_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "image_name": "ubuntu:20.04",
  • "location": "us-northcentral1-a",
  • "maintenance_policy": "stop-vm",
  • "name": "my-instance-template",
  • "placement_policy": "spread",
  • "project_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "public_ip_address_type": "static",
  • "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
  • "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'",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "type": "a100.2x",
  • "virtualization_features": {
    }
}

Delete a VM instance template.

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

Responses

Response samples

Content type
application/json
{
  • "code": "400",
  • "message": "bad_request"
}

Projects

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

If querying for projects 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
project_name
string
Example: project_name=default

Responses

Response samples

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

Update details for a project 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 project. Currently only the project's name can be changed.

query Parameters
project_id
required
string
Example: project_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
{
  • "project": {
    }
}

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

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

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
{
  • "project": {
    }
}

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

path Parameters
project_id
required
string
Example: ee2a6bc3-aed5-4756-8995-9990a53d3a17

Responses

Response samples

Content type
application/json
{
  • "id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "name": "Admin",
  • "organization_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "relation": "owner",
  • "resources": {
    }
}

Delete a project that the logged in user owns.

Delete operations cascade to VMs created under that project.

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

Responses

Response samples

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

Entities

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

Responses

Response samples

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

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
object (BillingAddress contains sensitive information related to the billing address for an entity.)
organization_name
string

Responses

Request samples

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

Response samples

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

Usage

Get project-level usage for products in Crusoe Cloud.

path Parameters
organization_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
projects
required
Array of strings
Example: projects=d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
resource_types
required
Array of strings
Example: resource_types=persistent-ssd,a40.1x
regions
required
Array of strings
Example: regions=us-east1,us-northcentral1
start_date
required
string
Example: start_date="2022-07-01"
end_date
required
string
Example: end_date="2023-08-08"

Responses

Response samples

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

Get resource-level usage for products in Crusoe Cloud.

path Parameters
organization_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
projects
required
Array of strings
Example: projects=d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
resources
required
Array of strings
Example: resources=d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
resource_types
required
Array of strings
Example: resource_types=persistent-ssd,a40.1x
regions
required
Array of strings
Example: regions=us-east1,us-northcentral1
start_date
required
string
Example: start_date="2022-07-01"
end_date
required
string
Example: end_date="2023-08-08"

Responses

Response samples

Content type
application/json
{
  • "code": "400",
  • "message": "bad_request"
}

Get options which exist for filters for /usage and /usage/export routes.

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

Responses

Response samples

Content type
application/json
{
  • "end_date": "\"2023-08-08\"",
  • "projects": [
    ],
  • "regions": [
    ],
  • "resource_types": [
    ],
  • "start_date": "\"2022-07-01\""
}

Audit Logs

Get audit logs belonging to the specified organization. User must be part of the organization.

path Parameters
organization_id
required
string
Example: de8f27fe-8438-45e7-a2c2-a2767660625f
query Parameters
project_ids
Array of strings
Example: project_ids=f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
start_time
string
Example: start_time=2022-09-01T14:25:36-07:00
end_time
string
Example: end_time=2022-09-06T14:25:36-07:00
actions
Array of strings
Example: actions=Create,Update
actor_ids
Array of strings
Example: actor_ids=f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
actor_emails
Array of strings
Example: [email protected],[email protected], only support filter by user email, not by crusoe admin email.
actor_types
Array of strings
Example: actor_types=User,Crusoe Admin, please ensure URL encoding for values with space.
target_ids
Array of strings
Example: target_ids=f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
target_types
Array of strings
Example: target_types=VM,KubernetesCluster
target_names
Array of strings
Example: target_names=my_vm1,my_vm2
locations
Array of strings
Example: locations=us-east1,us-northcentral1-a
results
Array of strings
Example: results=OK,Bad Request
results_not
Array of strings
Example: results_not=OK,Bad Request
surfaces
Array of strings
Example: surfaces=Browser,Crusoe Terraform/v0.5.21 please make sure the values are URL encoded.
limit
string
Example: limit=20
next_token
string
Example: next_token=bXktZmlyc3Qtdm0
prev_token
string
Example: prev_token=bXktZmlyc3Qtdm0

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_page_token": "bXktbGFzdC12bQ",
  • "prev_page_token": "bXktZmlyc3Qtdm0"
}

Identities

Retrieve user details for the logged in user.

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "credentials_map": {
    },
  • "identity": {
    }
}

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
{
  • "credentials": [
    ],
  • "credentials_map": {
    },
  • "identity": {
    }
}

SSH Keys

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

Responses

Response samples

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

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": "400",
  • "message": "bad_request"
}

Tokens

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

Responses

Response samples

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

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)

path Parameters
project_id
required
string
query Parameters
disk_ids
Array of strings
location
string
disk_names
Array of strings
exclude_os
boolean

Responses

Response samples

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

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.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
block_size
integer <int64>
location
string
name
required
string
size
string
snapshot_id
string
type
string
Default: "persistent-ssd"
Enum: "persistent-ssd" "shared-volume"

Responses

Request samples

Content type
application/json
{
  • "block_size": 4096,
  • "location": "us-northcentral1-a",
  • "name": "my-disk",
  • "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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
disk_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "attached_to": [
    ],
  • "block_size": 4096,
  • "created_at": "2021-12-03T19:58:34Z",
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "location": "us-northcentral1-a",
  • "name": "my-disk",
  • "serial_number": "96FD14FDBCF7E21E8EC",
  • "size": "10GiB",
  • "type": "persistent-ssd",
  • "updated_at": "2021-12-03T19:58:34Z"
}

Delete a disk owned by the logged in user.

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=IN_PROGRESS

Responses

Response samples

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

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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

Snapshots

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

Size of snapshots will be in bytes.

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

Responses

Response samples

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

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

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

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

Responses

Request samples

Content type
application/json
{
  • "disk_id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "my-snapshot-1"
}

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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
snapshot_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "block_size": 4096,
  • "created_at": "2021-12-03T19:58:34Z",
  • "created_from": "123e4567-e89b-12d3-a456-426614174000",
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "my-snapshot",
  • "size": "10457 bytes",
  • "updated_at": "2021-12-03T19:58:34Z"
}

Delete a disk snapshot owned by the logged in user.

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

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

Responses

Response samples

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

Rename a disk snapshot owned by the logged in user.

A successful response from this resource will contain the updated snapshot.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
snapshot_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "my-snapshot"
}

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.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=IN_PROGRESS

Responses

Response samples

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

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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

VPC Firewall Rules

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

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

Responses

Response samples

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

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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
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]",
  • "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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vpc_firewall_rule_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "action": "allow",
  • "destination_ports": "[80, 443, 3000-8080]",
  • "destinations": [
    ],
  • "direction": "ingress",
  • "id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
  • "name": "my-firewall-rule",
  • "protocols": "[tcp, udp]",
  • "source_ports": "[80, 443, 3000-8080]",
  • "sources": [
    ],
  • "state": "active",
  • "vpc_network_id": "74927f69-f6f6-43f4-bc0d-7bb2e864250e"
}

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
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.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=IN_PROGRESS

Responses

Response samples

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

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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

VPC Networks

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

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

Responses

Response samples

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

Create a new VPC network owned by the logged in user.

A successful response from this resource will contain information regarding the created VPC network.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
cidr
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "cidr": "172.27.0.0/16",
  • "name": "my-cool-vpc-network"
}

Response samples

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

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

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

Responses

Response samples

Content type
application/json
{
  • "cidr": "121.0.0.0/20",
  • "gateway": "11bf5b4c-e0e5-4017-bdb8-3861f3acedc1",
  • "id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
  • "name": "default-ethernet",
  • "subnets": "[1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc]"
}

Delete a VPC network owned by the logged in user.

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

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

Responses

Response samples

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

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vpc_network_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "my-cool-vpc-network"
}

Response samples

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

VPC Subnets

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

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

Responses

Response samples

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

Create a new VPC subnet owned by the logged in user.

A successful response from this resource will contain information regarding the created subnet.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
cidr
required
string
location
required
string
name
required
string
vpc_network_id
required
string

Responses

Request samples

Content type
application/json
{
  • "cidr": "172.27.0.0/16",
  • "location": "us-east",
  • "name": "my-cool-vpc-subnet",
  • "vpc_network_id": "36c0b0d9-8b68-4869-addb-227b06b64ee0"
}

Response samples

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

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

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

Responses

Response samples

Content type
application/json
{
  • "cidr": "121.0.0.0/24",
  • "id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
  • "location": "us-northcentraleast1-a",
  • "name": "my-subnet",
  • "vpc_network_id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc"
}

Delete a VPC subnet owned by the logged in user.

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

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

Responses

Response samples

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

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

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
vpc_subnet_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "my-cool-vpc-subnet"
}

Response samples

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

IB Partitions

Retrieve details for all Infiniband partitions that belongs to the user.

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

Responses

Response samples

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

Create a new Infiniband partition owned by the logged in user.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
ib_network_id
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "ib_network_id": "36c0b0d9-8b68-4869-addb-227b06b64ee0",
  • "name": "my-ib-partition"
}

Response samples

Content type
application/json
{
  • "ib_network_id": "36c0b0d9-8b68-4869-addb-227b06b64ee0",
  • "id": "44701f9e-845c-4005-9240-adee6401b8d3",
  • "name": "my-ib-partition"
}

Retrieve details for an Infiniband partition that belongs to the user.

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

Responses

Response samples

Content type
application/json
{
  • "ib_network_id": "36c0b0d9-8b68-4869-addb-227b06b64ee0",
  • "id": "44701f9e-845c-4005-9240-adee6401b8d3",
  • "name": "my-ib-partition"
}

Delete an Infiniband partition owned by the logged in user.

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

Responses

Response samples

Content type
application/json
{
  • "code": "400",
  • "message": "bad_request"
}

Load Balancers

Retrieve information about External Load Balancer belonging to the project.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
location
string
Example: location=us-east1
vpc_network_id
string
Example: vpc_network_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
name
string
Example: name=my-loadbalancer-test

Responses

Response samples

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

Create a new external load balancer.

This endpoint creates a new external load balancer in the specified project. The request must include the VPC ID, name, location, and at least one listen port with its associated backends.

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

The project ID to which the external load balancer belongs.

Request Body schema: application/json

Request body for creating the external load balancer.

object (HealthCheckOptions defines the health check configuration.)
required
Array of objects (ListenPortAndBackend defines a mapping of listen ports to backend configurations.)

Listen ports and associated backends configuration.

location
required
string

Location of the External Load Balancer.

name
required
string

Name of the External Load Balancer.

protocol
required
string

The protocol of the External Load Balancer.

vpc_id
required
string

The ID of the VPC network this External Load Balancer belongs to.

Responses

Request samples

Content type
application/json
{
  • "health_check_options": {
    },
  • "listen_ports_and_backends": [
    ],
  • "location": "us-east1",
  • "name": "my-external-load-balancer",
  • "protocol": "tcp",
  • "vpc_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab"
}

Response samples

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

Retrieve information about a particular external load balancer belonging to the project.

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

Responses

Response samples

Content type
application/json
{
  • "health_check_options": {
    },
  • "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "listen_ports_and_backends": [
    ],
  • "location": "string",
  • "name": "my-external-load-balancer",
  • "project_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "protocol": "string",
  • "vip": "192.168.1.1",
  • "vpc_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab"
}

Delete an external load balancer.

This endpoint deletes an external load balancer identified by its ID within the specified project. No request body or query parameters are required.

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

The project ID to which the external load balancer belongs.

load_balancer_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

The ID of the external load balancer to delete.

Responses

Response samples

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

Update an existing external load balancer.

This endpoint updates the configuration of an existing external load balancer. The request must include the load balancer ID and optionally the health check options and/or listen ports and associated backends.

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

The project ID to which the external load balancer belongs.

load_balancer_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

The ID of the external load balancer to update.

Request Body schema: application/json

Request body for updating the external load balancer.

object (HealthCheckOptions defines the health check configuration.)
id
required
string

The ID of the External Load Balancer to update.

required
Array of objects (ListenPortAndBackend defines a mapping of listen ports to backend configurations.)

Listen ports and associated backends configuration.

Responses

Request samples

Content type
application/json
{
  • "health_check_options": {
    },
  • "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "listen_ports_and_backends": [
    ]
}

Response samples

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

Kubernetes Clusters

Retrieve information about Kubernetes clusters belonged to the project.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
cluster_id
string
Example: cluster_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
cluster_name
string
Example: cluster_name=my-first-cluster
cluster_search_names
Array of strings
Example: cluster_search_names=a40.2x,a100.8x
locations
Array of strings
Example: locations=us-east1,us-northcentral1
states
Array of strings
Example: states=STATE_RUNNING
versions
Array of strings
Example: versions=1.30
sort
string
Example: sort=name, -name
show_inactive
boolean
Example: show_inactive=true
next_token
string
Example: next_token=bXktZmlyc3Qtdm0
prev_token
string
Example: prev_token=bXktZmlyc3Qtdm0

Responses

Response samples

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

Create a new Kubernetes cluster owned by the logged in user.

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

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
add_ons
Array of strings

List of add-ons to be included to the cluster.

cluster_cidr
string

defines: the range of IP Addresses allocated to pods scheduled on worker nodes

configuration
string
Value: "ha"

Configuration setting is deprecated, defaults to HA configuration.

location
required
string

Location to create the Kubernetes cluster in.

name
required
string

Name of the Kubernetes cluster.

node_cidr_mask_size
integer <int32>

defines: the mask size for cluster cidr

service_cluster_ip_range
string

defines: the range of IP Addresses allocated to K8s services

subnet_id
string

The ID of the subnet to create the cluster in. Must be in the location specified. If not provided, the default subnet for the location will be used, if there is one.

version
required
string

Version of the Crusoe Kubernetes image to create the cluster with.

Responses

Request samples

Content type
application/json
{
  • "add_ons": [
    ],
  • "cluster_cidr": "10.233.0.0/18",
  • "configuration": "ha",
  • "location": "us-northcentral1-a",
  • "name": "my-kubernetes-cluster",
  • "node_cidr_mask_size": 24,
  • "service_cluster_ip_range": "10.233.0.0/18",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "version": "1.29.5-crusoe.0"
}

Response samples

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

Retrieve information about a particular Kubernetes cluster belonged to the project.

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

Responses

Response samples

Content type
application/json
{
  • "add_ons": [
    ],
  • "cluster_cidr": "10.233.0.0/18",
  • "configuration": "ha",
  • "created_at": "2021-12-03T19:58:34Z",
  • "dns_name": "my-kubernetes-cluster.crusoecloudcompute.com",
  • "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "location": "string",
  • "name": "my-kubernetes-cluster",
  • "node_cidr_mask_size": 24,
  • "node_pools": [
    ],
  • "project_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  • "service_cluster_ip_range": "10.233.0.0/18",
  • "state": "STATE_RUNNING",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "updated_at": "2021-12-03T19:58:34Z",
  • "version": "1.29.5-crusoe.0"
}

Delete a cluster that the logged in user owns.

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

Responses

Response samples

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

Update a cluster that the logged in user owns.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
cluster_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
configuration
string
Value: "ha"

Configuration setting is deprecated, defaults to HA configuration.

Responses

Request samples

Content type
application/json
{
  • "configuration": "ha"
}

Response samples

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

Retrieve credentials for the user to authenticate to the specified cluster.

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

Responses

Response samples

Content type
application/json
{
  • "cluster_address": "string",
  • "cluster_ca_certificate": "string",
  • "cluster_name": "string",
  • "user_client_certificate": "string",
  • "user_client_key": "string",
  • "user_name": "string"
}

Kubernetes Cluster Operations

Get status of asynchronous operations

This resource retrieves information about the status of an asynchronous operation initiated by the Kubernetes Cluster 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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
resource_id
string
Example: resource_id=452580d7-41d1-4b63-b4d7-4e4e21e95f96
state
Array of strings
Example: state=IN_PROGRESS

Responses

Response samples

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

Get status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the Kubernetes Cluster 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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

Kubernetes Node Pools

Retrieve information about Kubernetes node pools belonging to a project or cluster.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
cluster_id
string
Example: cluster_id=ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
sort
string
Example: sort=created_at, -created_at

Responses

Response samples

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

Create a new Kubernetes node pool owned by the logged in user.

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

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

Cluster ID of the cluster this node pool belongs to.

count
required
integer <int64>

The number of nodes to be created.

ib_partition_id
string

The ID of the Infiniband partition to create node pool in. Must be in the location of the cluster if specified.

name
required
string

Name of the Kubernetes node pool.

object

Labels assigned to the node pool

node_pool_version
string

Version of the Kubernetes node pool.

product_name
required
string

Product name of the VM type to be created within this node pool.

object (ReservationSpecification)
ssh_public_key
string

SSH public key to use for all VMs created from this node pool.

subnet_id
string

The ID of the subnet to create the node pool in. Must be in the location of the cluster if specified. If not provided, the default subnet for the location will be used, if there is one.

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "count": 4,
  • "ib_partition_id": "b1f86d1b-42d2-490d-adb0-cc1029abf653",
  • "name": "my-kubernetes-node-pool",
  • "node_labels": {
    },
  • "node_pool_version": "1.30",
  • "product_name": "a100.2x",
  • "reservation_specification": {
    },
  • "ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCspdG97nTS/h4PEPq2QD2RYVK1jxFXLFZuSDMI8Rtxpucl6LDZLOghEYoj13lxKQnGtcsM3Iu68lh+4YgZe7CbI6cc/TxPbeAX2HJTqDh0J7+GAlLBHK9tsepC0QlhIDiazJptOPDZ3cesCBXdxSnzEbhDaqgYOfl393cp1fCeOKRIDWEP3H9CM25dCbWF66sTDziLsojJ9dMnxhgKm9/JkZc5gYncLT/2Ey+VWfV9Fs65mGUrBbQOn3c8S/nEk6WRcYn4PFOnIp0Mz+Chb50iCJrW677pllLnkTGSU+4c0H9J5z4HDG0I+91RoiQ0QsayFTYO1JtSn+THLuq98V+D",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1"
}

Response samples

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

Retrieve information about a particular Kubernetes node pool belonging to the project.

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

Responses

Response samples

Content type
application/json
{
  • "cluster_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  • "count": 4,
  • "created_at": "2021-12-03T19:58:34Z",
  • "id": "0a1b3c2d-5e6f-8b9c-4d7e-1a2b3c4d5e6f",
  • "image_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  • "instance_ids": [
    ],
  • "name": "crusoe-node-pool",
  • "node_labels": "\"nvidia.a100\"",
  • "project_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  • "reservation_id": "ca39e669-47ee-456b-968d-303234fbf99f",
  • "state": "STATE_RUNNING",
  • "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  • "type": "a100.2x",
  • "updated_at": "2021-12-03T19:58:34Z"
}

Delete a node pool that the logged in user owns.

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

Responses

Response samples

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

Update a node pool that the logged in user owns.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
node_pool_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
Request Body schema: application/json
action
required
string
Default: "UPDATE"
Enum: "RESERVE" "UNRESERVE" "UPDATE"

The action to perform on the NodePool. RESERVE and UNRESERVE operations are done synchronously, and so will have succeeded with a 200 response. Defaults to UPDATE if no action specified.

count
required
integer <int64>

The number of nodes to be created.

object

Labels assigned to the node pool

reservation_id
string

The reservation ID of the node pool.

Responses

Request samples

Content type
application/json
{
  • "action": "UPDATE",
  • "count": 4,
  • "node_labels": {
    },
  • "reservation_id": "ca39e669-47ee-456b-968d-303234fbf99f"
}

Response samples

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

Kubernetes Node Pool Operations

Get status of asynchronous operations

This resource retrieves information about the status of an asynchronous operation initiated by the Kubernetes Node Pool 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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

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

Get status of a single asynchronous operation

This resource retrieves information about the status of an asynchronous operation initiated by the Kubernetes Node Pool 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
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
operation_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab

Responses

Response samples

Content type
application/json
{
  • "completed_at": "2021-12-03T19:59:34Z",
  • "metadata": "{}",
  • "operation_id": "F6EF489C-086E-458D-B812-7962964A28C9",
  • "result": "{}",
  • "started_at": "2021-12-03T19:58:34Z",
  • "state": "IN_PROGRESS"
}

Kubernetes Versions

Retrieve information about available Kubernetes versions.

path Parameters
project_id
required
string
Example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
query Parameters
show_deprecated
boolean
Example: show_deprecated=true

Responses

Response samples

Content type
application/json
{
  • "kubernetes_cluster_versions": [
    ],
  • "kubernetes_node_pool_versions": [
    ]
}

Locations

Lists all Crusoe Cloud locations usable for resource hosting.

Responses

Response samples

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

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
{
  • "items": [
    ]
}