Crusoe
Crusoe is a vertically integrated AI cloud and energy infrastructure company. It builds and operates purpose-built data centers powered by renewable and alternative energy sources, and exposes that infrastructure as Crusoe Cloud: a high-performance compute platform optimized for AI training and inference on NVIDIA and AMD GPUs. The Crusoe Intelligence Foundry provides managed inference for open-source and custom-tuned models (DeepSeek, Llama, Nemotron, and others). Crusoe Cloud ships a full REST API, a CLI, SDKs, a Terraform provider, and a cookbook of code samples. Public developer documentation is hosted at docs.crusoecloud.com with the API rooted at api.crusoecloud.com/v1alpha5.
APIs
Crusoe Cloud API
The Crusoe Cloud API is the primary control plane for provisioning and managing GPU compute, storage, networking, Kubernetes clusters, identity, and billing on Crusoe's vertical...
Collections
Pricing Plans
Rate Limits
FinOps
Crusoe Energy Finops
FINOPSResources
Sources
opencollection: 1.0.0
info:
name: Crusoe Cloud API Gateway
version: v1alpha5
items:
- info:
name: Capacities
type: folder
items:
- info:
name: Lists available Crusoe Cloud capacity with optional filters on location and product name.
type: http
http:
method: GET
url: '{{baseUrl}}/capacities'
params:
- name: product_name
value: '[l40s-48gb.1x, l40s-48gb.2x]'
type: query
- name: location
value: '[us-southcentral1-a, us-east1-a]'
type: query
docs: Lists available Crusoe Cloud capacity with optional filters on location and product name.
- info:
name: Images
type: folder
items:
- info:
name: Lists all VM images available for use.
type: http
http:
method: GET
url: '{{baseUrl}}/compute/images'
docs: Lists all VM images available for use.
- info:
name: Retrieve details about a VM image.
type: http
http:
method: GET
url: '{{baseUrl}}/compute/images/:image_id'
params:
- name: image_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve details about a VM image.
- info:
name: Feature Flags
type: folder
items:
- info:
name: Get feature flags for the currently logged in user.
type: http
http:
method: GET
url: '{{baseUrl}}/featureflags'
docs: 'A successful response from this resource will contain a map of
all feature flags and the value assigned to each of them for the user.'
- info:
name: Locations
type: folder
items:
- info:
name: Lists all Crusoe Cloud locations usable for resource hosting.
type: http
http:
method: GET
url: '{{baseUrl}}/locations'
docs: Lists all Crusoe Cloud locations usable for resource hosting.
- info:
name: Entities
type: folder
items:
- info:
name: Retrieve details about all active organizations the logged in user belongs to.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/entities'
docs: Retrieve details about all active organizations the logged in user belongs to.
- info:
name: Update details for an organization that the logged in user owns.
type: http
http:
method: PUT
url: '{{baseUrl}}/organizations/entities'
params:
- name: org_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: query
docs: A successful response from this resource will contain the updated organization details.
- info:
name: Projects
type: folder
items:
- info:
name: Retrieve details about projects that the logged in user belongs to or owns.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/projects'
params:
- name: org_id
value: ee2a6bc3-aed5-4756-8995-9990a53d3a17
type: query
- name: project_name
value: default
type: query
docs: If querying for projects within an organization, the logged in user must be the owner of the organization.
- info:
name: Create a new project that will be owned by the logged in user.
type: http
http:
method: POST
url: '{{baseUrl}}/organizations/projects'
docs: '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.'
- info:
name: Update details for a project that the logged in user owns.
type: http
http:
method: PUT
url: '{{baseUrl}}/organizations/projects'
params:
- name: project_id
value: f058d0db-2fa4-4cf2-8cf1-dfbcfe05a814
type: query
docs: '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.'
- info:
name: Retrieve details about a project that the logged in user belongs to or owns.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/projects/:project_id'
params:
- name: project_id
value: ee2a6bc3-aed5-4756-8995-9990a53d3a17
type: path
docs: Retrieve details about a project that the logged in user belongs to or owns.
- info:
name: Delete a project that the logged in user owns.
type: http
http:
method: DELETE
url: '{{baseUrl}}/organizations/projects/:project_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Delete operations cascade to VMs created under that project.
- info:
name: Audit Logs
type: folder
items:
- info:
name: Get audit logs belonging to the specified organization. User must be part of the organization.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/audit-logs'
params:
- name: organization_id
value: de8f27fe-8438-45e7-a2c2-a2767660625f
type: path
- name: project_ids
value: f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
type: query
- name: start_time
value: '2022-09-01T14:25:36-07:00'
type: query
- name: end_time
value: '2022-09-06T14:25:36-07:00'
type: query
- name: actions
value: Create,Update
type: query
- name: actor_ids
value: f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
type: query
- name: actor_emails
value: hh26@xxx.com,xyz@yyy.ai, only support filter by user email, not by crusoe admin email.
type: query
- name: actor_types
value: User,Crusoe Admin, please ensure URL encoding for values with space.
type: query
- name: target_ids
value: f934fbdb-7e3a-4b92-b7d2-da0f91d768e8,8c29f3f3-830f-4a44-9b6b-a51fcf6a6b5d
type: query
- name: target_types
value: VM,KubernetesCluster
type: query
- name: target_names
value: my_vm1,my_vm2
type: query
- name: locations
value: us-east1,us-southcentral1-a
type: query
- name: results
value: OK,Bad Request
type: query
- name: results_not
value: OK,Bad Request
type: query
- name: surfaces
value: Browser,Crusoe Terraform/v0.5.21 please make sure the values are URL encoded.
type: query
- name: limit
value: '20'
type: query
- name: next_token
value: bXktZmlyc3Qtdm0
type: query
- name: prev_token
value: bXktZmlyc3Qtdm0
type: query
docs: Get audit logs belonging to the specified organization. User must be part of the organization.
- info:
name: Billing
type: folder
items:
- info:
name: Get the daily spend for a specified organization by project.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/billing/costs'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Get the daily spend for a specified organization by project.
- info:
name: Return the daily spend per resource.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/billing/export'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: format
value: '"json","csv"'
type: query
- name: projects
value: d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
type: query
- name: resources
value: d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
type: query
- name: resource_types
value: persistent-ssd,l40s-48gb.1x
type: query
- name: regions
value: us-east1,us-southcentral1
type: query
- name: start_date
value: '"2022-07-01"'
type: query
- name: end_date
value: '"2023-08-08"'
type: query
docs: Return the daily spend per resource.
- info:
name: Get options which exist for filters for /billing/costs and /billing/export routes.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/billing/options'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: start_date
value: '"2025-05-01"'
type: query
- name: end_date
value: '"2025-05-20"'
type: query
docs: Get options which exist for filters for /billing/costs and /billing/export routes.
- info:
name: Quotas
type: folder
items:
- info:
name: List max and currently used organization quotas.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/quotas'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: List max and currently used organization quotas.
- info:
name: List max and currently used project quotas.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/quotas'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: List max and currently used project quotas.
- info:
name: Reservations
type: folder
items:
- info:
name: Get all reservations belonging to the specified organization. User must be part of the organization.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/reservations'
params:
- name: organization_id
value: de8f27fe-8438-45e7-a2c2-a2767660625f
type: path
- name: status
value: effective
type: query
docs: Get all reservations belonging to the specified organization. User must be part of the organization.
- info:
name: Get latest GPU tracking data for the specified organization. User must be part of the organization and have reservations
feature access.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/reservations/gpu-tracking/latest'
params:
- name: organization_id
value: de8f27fe-8438-45e7-a2c2-a2767660625f
type: path
- name: product_line
value: gpu-hours
type: query
- name: region
value: us-east1,us-northcentral1
type: query
docs: Get latest GPU tracking data for the specified organization. User must be part of the organization and have reservations
feature access.
- info:
name: Get reservation belonging to the specified organization and reservation ID. User must be part of the organization.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/reservations/:reservation_id'
params:
- name: organization_id
value: de8f27fe-8438-45e7-a2c2-a2767660625f
type: path
- name: reservation_id
value: de8f27fe-8438-45e7-a2c2-a2767660625f
type: path
docs: Get reservation belonging to the specified organization and reservation ID. User must be part of the organization.
- info:
name: Usage
type: folder
items:
- info:
name: Get project-level usage for products in Crusoe Cloud.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/usage'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: projects
value: d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
type: query
- name: resource_types
value: persistent-ssd,l40s-48gb.1x
type: query
- name: regions
value: us-east1,us-southcentral1
type: query
- name: start_date
value: '"2022-07-01"'
type: query
- name: end_date
value: '"2023-08-08"'
type: query
docs: Get project-level usage for products in Crusoe Cloud.
- info:
name: Get resource-level usage for products in Crusoe Cloud.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/usage/export'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: projects
value: d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
type: query
- name: resources
value: d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
type: query
- name: resource_types
value: persistent-ssd,l40s-48gb.1x
type: query
- name: regions
value: us-east1,us-southcentral1
type: query
- name: start_date
value: '"2022-07-01"'
type: query
- name: end_date
value: '"2023-08-08"'
type: query
docs: Get resource-level usage for products in Crusoe Cloud.
- info:
name: Get options which exist for filters for /usage and /usage/export routes.
type: http
http:
method: GET
url: '{{baseUrl}}/organizations/:organization_id/usage/options'
params:
- name: organization_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Get options which exist for filters for /usage and /usage/export routes.
- info:
name: Custom Images
type: folder
items:
- info:
name: List all custom VM images available for use.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/custom-images'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: List all custom VM images available for use.
- info:
name: Create a custom image.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/custom-images'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Create a custom image.
- info:
name: Retrieve details about a VM image.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/:image_id'
params:
- name: image_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve details about a VM image.
- info:
name: Update a custom image's description.
type: http
http:
method: PATCH
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/:image_id'
params:
- name: image_id
value: ''
type: path
- name: project_id
value: ''
type: path
docs: Update a custom image's description.
- info:
name: Delete a custom image.
type: http
http:
method: DELETE
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/:image_id'
params:
- name: image_id
value: ''
type: path
- name: project_id
value: ''
type: path
docs: Delete a custom image.
- info:
name: Update a custom image's tags.
type: http
http:
method: PATCH
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/:image_id/edit-tags'
params:
- name: image_id
value: ''
type: path
- name: project_id
value: ''
type: path
docs: Update a custom image's tags.
- info:
name: Custom Image Operations
type: folder
items:
- info:
name: Get status of asynchronous operations
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/operations'
params:
- name: resource_id
value: 452580d7-41d1-4b63-b4d7-4e4e21e95f96
type: query
- name: state
value: IN_PROGRESS
type: query
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: 'This resource retrieves information about the status of asynchronous operations initiated by
the custom images resource. All operations that are either in-flight or completed but not yet
queried will be returned.'
- info:
name: Get status of a single asynchronous custom image operation
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/custom-images/operations/:operation_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: operation_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: 'This resource retrieves information about the status of an asynchronous operation initiated by
the custom image 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.'
- info:
name: Instance Groups
type: folder
items:
- info:
name: Lists all instance groups.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/instance-groups'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Lists all instance groups.
- info:
name: Create an instance group.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/instance-groups'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Create an instance group.
- info:
name: Retrieve details about an instance group.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/instance-groups/:instance_group_id'
params:
- name: instance_group_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve details about an instance group.
- info:
name: Update an instance group.
type: http
http:
method: PATCH
url: '{{baseUrl}}/projects/:project_id/compute/instance-groups/:instance_group_id'
params:
- name: instance_group_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Update an instance group.
- info:
name: Delete an instance group.
type: http
http:
method: DELETE
url: '{{baseUrl}}/projects/:project_id/compute/instance-groups/:instance_group_id'
params:
- name: instance_group_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Delete an instance group.
- info:
name: Instance Templates
type: folder
items:
- info:
name: Lists all VM instance templates available for use.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/instance-templates'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Lists all VM instance templates available for use.
- info:
name: Create a VM instance template, for use in bulk VM creation.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/instance-templates'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Create a VM instance template, for use in bulk VM creation.
- info:
name: Retrieve details about a VM instance template.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/instance-templates/:instance_template_id'
params:
- name: instance_template_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve details about a VM instance template.
- info:
name: Delete a VM instance template.
type: http
http:
method: DELETE
url: '{{baseUrl}}/projects/:project_id/compute/instance-templates/:instance_template_id'
params:
- name: instance_template_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Delete a VM instance template.
- info:
name: VMs
type: folder
items:
- info:
name: Create new VM instances owned by the logged in user.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/vms/bulk-instances'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Create new VM instances owned by the logged in user.
- info:
name: Retrieve details about all VMs that the logged in user owns or has access to.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: ids
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: query
- name: names
value: my-first-vm
type: query
- name: types
value: l40s-48gb.2x,l40s-48gb.8x
type: query
- name: locations
value: us-east1,us-southcentral1
type: query
- name: states
value: STATE_RUNNING
type: query
- name: limit
value: '20'
type: query
- name: sort
value: name
type: query
- name: next_token
value: bXktZmlyc3Qtdm0
type: query
- name: prev_token
value: bXktZmlyc3Qtdm0
type: query
docs: Retrieve details about all VMs that the logged in user owns or has access to.
- info:
name: Create a new VM instance owned by the logged in user.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Create a new VM instance owned by the logged in user.
- info:
name: Retrieve details about a particular VM.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/:vm_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: vm_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve details about a particular VM.
- info:
name: Change the state of a VM the logged in user owns.
type: http
http:
method: PATCH
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/:vm_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: vm_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Change the state of a VM the logged in user owns.
- info:
name: Delete a VM that the logged in user owns.
type: http
http:
method: DELETE
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/:vm_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: vm_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Delete a VM that the logged in user owns.
- info:
name: Attach disks to a VM the logged in user owns.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/:vm_id/attach-disks'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: vm_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Attach disks to a VM the logged in user owns.
- info:
name: Detach disks from a VM the logged in user owns.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/:vm_id/detach-disks'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: vm_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Detach disks from a VM the logged in user owns.
- info:
name: Retrieve information about the types of VMs that are available.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/vms/types'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve information about the types of VMs that are available.
- info:
name: VM Operations
type: folder
items:
- info:
name: Get status of asynchronous operations
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/operations'
params:
- name: resource_id
value: 452580d7-41d1-4b63-b4d7-4e4e21e95f96
type: query
- name: state
value: IN_PROGRESS
type: query
- name: lower_time_bound
value: '2021-12-03T19:58:34Z'
type: query
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: '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.'
- info:
name: Get the status of a single asynchronous operation
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/compute/vms/instances/operations/:operation_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: operation_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: '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.'
- info:
name: AutoCluster Operations
type: folder
items:
- info:
name: Retrieve information about a specific AutoCluster operation.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/kubernetes/autocluster-operations/:operation_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: operation_id
value: e384a1de-81f8-4cb2-b312-a7d88a9bf9cb
type: path
docs: Retrieve information about a specific AutoCluster operation.
- info:
name: Kubernetes Clusters
type: folder
items:
- info:
name: Retrieve information about Kubernetes clusters belonged to the project.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: cluster_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: query
- name: cluster_name
value: my-first-cluster
type: query
- name: cluster_search_names
value: a40.2x,a100.8x
type: query
- name: locations
value: us-east1,us-northcentral1
type: query
- name: states
value: STATE_RUNNING
type: query
- name: versions
value: '1.30'
type: query
- name: sort
value: name, -name
type: query
- name: show_inactive
value: 'true'
type: query
- name: next_token
value: bXktZmlyc3Qtdm0
type: query
- name: prev_token
value: bXktZmlyc3Qtdm0
type: query
docs: Retrieve information about Kubernetes clusters belonged to the project.
- info:
name: Create a new Kubernetes cluster owned by the logged in user.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: A successful response from this resource will contain the async operation.
- info:
name: Retrieve information about a particular Kubernetes cluster belonged to the project.
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/:cluster_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: cluster_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Retrieve information about a particular Kubernetes cluster belonged to the project.
- info:
name: Update a cluster that the logged in user owns.
type: http
http:
method: PATCH
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/:cluster_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: cluster_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Update a cluster that the logged in user owns.
- info:
name: Delete a cluster that the logged in user owns.
type: http
http:
method: DELETE
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/:cluster_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: cluster_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: Delete a cluster that the logged in user owns.
- info:
name: Retrieve credentials for the user to authenticate to the specified cluster.
type: http
http:
method: POST
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/:cluster_id/get-credentials'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: cluster_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: auth_type
value: ''
type: query
docs: Retrieve credentials for the user to authenticate to the specified cluster.
- info:
name: Kubernetes Cluster Operations
type: folder
items:
- info:
name: Get status of asynchronous operations
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/operations'
params:
- name: resource_id
value: 452580d7-41d1-4b63-b4d7-4e4e21e95f96
type: query
- name: state
value: IN_PROGRESS
type: query
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: '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.'
- info:
name: Get status of a single asynchronous operation
type: http
http:
method: GET
url: '{{baseUrl}}/projects/:project_id/kubernetes/clusters/operations/:operation_id'
params:
- name: project_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
- name: operation_id
value: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
type: path
docs: 'This resource retrieves information about t
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/crusoe-energy/refs/heads/main/apis.yml