Skip to main content
New to Corsair? See API access, authentication, and error handling.

Api Keys

getCurrent

apiKeys.getCurrent Verify the configured API key and return its details, including the organization it belongs to Risk: read
Input: empty object Output

Baremetals

action

baremetals.action Start, stop, power-cycle, or reboot a bare-metal server Risk: write
Input Output

create

baremetals.create Provision bare-metal GPU servers (billed while they exist) Risk: write
Input Output: object[]

delete

baremetals.delete Delete a bare-metal server and release its resources Risk: destructive · Irreversible
Input Output

get

baremetals.get Get a bare-metal server by ID Risk: read
Input Output

list

baremetals.list List bare-metal GPU servers, optionally filtered by data center Risk: read
Input Output: object[]

listProducts

baremetals.listProducts List bare-metal server products (GPU types and specs) in a data center Risk: read
Input Output: object[]

update

baremetals.update Rename a bare-metal server Risk: write
Input Output

Chat

createCompletion

chat.createCompletion Generate a chat completion with an LLM through the OpenAI-compatible API (billed per token) Risk: write
Input
Output

Containers

create

containers.create Launch GPU container workloads from a template (billed while they run) Risk: write
Input
Output: object[]

createShell

containers.createShell Generate a web shell URL path for a running container Risk: write
Input Output

delete

containers.delete Delete a container workload; its local data is lost Risk: destructive · Irreversible
Input Output

get

containers.get Get a container workload by ID, including status and IP addresses Risk: read
Input Output

getLogs

containers.getLogs Download the logs of a container workload as text Risk: read
Input Output

list

containers.list List container workloads in the organization Risk: read
Input: empty object Output: object[]

listProducts

containers.listProducts List container products (GPU types and specs) in a data center Risk: read
Input Output: object[]

restart

containers.restart Restart a container workload Risk: write
Input Output

update

containers.update Update a container’s name, template, command, arguments, environment, ports, or SSH keys Risk: write
Input
Output

Elastic Ips

allocate

elasticIps.allocate Allocate a static public IPv4 address for the organization Risk: write
Input Output: object[]

associate

elasticIps.associate Attach an elastic IP to a bare-metal server or container Risk: write
Input Output

disassociate

elasticIps.disassociate Detach an elastic IP from its instance Risk: write
Input Output

get

elasticIps.get Get an elastic IP by ID Risk: read
Input Output

list

elasticIps.list List elastic IPs allocated to the organization Risk: read
Input: empty object Output: object[]

listProducts

elasticIps.listProducts List elastic IP products in a data center Risk: read
Input Output: object[]

release

elasticIps.release Release an elastic IP; the address cannot be reclaimed Risk: destructive · Irreversible
Input Output

Firewalls

associate

firewalls.associate Apply a firewall to bare-metal servers or containers Risk: write
Input Output

create

firewalls.create Create a firewall with inbound rules in a data center Risk: write
Input
Output

delete

firewalls.delete Delete a firewall Risk: destructive · Irreversible
Input Output

disassociate

firewalls.disassociate Remove a firewall from bare-metal servers or containers Risk: write
Input Output

get

firewalls.get Get a firewall and its rules by ID Risk: read
Input Output

list

firewalls.list List firewalls, optionally filtered by data center Risk: read
Input Output: object[]

update

firewalls.update Replace a firewall’s name, description, and inbound rules Risk: write
Input
Output

Idcs

list

idcs.list List the data centers (IDCs) available for GPU compute resources Risk: read
Input: empty object Output

Images

get

images.get Get an OS image by ID Risk: read
Input Output

list

images.list List OS images for bare-metal servers, optionally filtered by data center and product Risk: read
Input Output: object[]

Media Models

get

mediaModels.get Get a media model’s description and the payload parameters its requests accept Risk: read
Input Output

list

mediaModels.list List the video, image, and audio model IDs served by the GMI request queue Risk: read
Input: empty object Output

Media Requests

create

mediaRequests.create Queue a video, image, or audio generation request; poll mediaRequests.get for the outcome (billed) Risk: write
Input Output

get

mediaRequests.get Get the status of a queued media request and, once it succeeds, its output file URLs Risk: read
Input Output

Models

list

models.list List the LLMs available on GMI Cloud serverless inference Risk: read
Input: empty object Output

Router

autoroute

router.autoroute Let the GMI Router pick the best model for a conversation by cost, balance, or quality and return its completion Risk: write
Input
Output

Sandboxes

connect

sandboxes.connect Connect to a running sandbox and return its data-plane domain and access token; a timeout extends its lifetime Risk: write
Input Output

create

sandboxes.create Create a sandbox from a template; returns the data-plane host and access token used by sandboxExec and sandboxFiles Risk: write
Input Output

delete

sandboxes.delete Kill a sandbox; it moves to deleting and then deleted once resources are released Risk: destructive · Irreversible
Input Output

get

sandboxes.get Get sandbox details, including state, resources, and failure reason Risk: read
Input Output

list

sandboxes.list List active sandboxes (provisioning, running, updating, checkpointing, failed) with pagination Risk: read
Input Output

setTimeout

sandboxes.setTimeout Reset a running sandbox’s time-to-live relative to now (300 seconds when omitted) Risk: write
Input Output

updateMetadata

sandboxes.updateMetadata Replace a sandbox’s metadata as a whole (an empty object clears it) Risk: write
Input Output

Sandbox Exec

cancel

sandboxExec.cancel Cancel a running sandbox command Risk: write
Input Output: object

get

sandboxExec.get Get the status, exit code, and output of a sandbox command Risk: read
Input Output

run

sandboxExec.run Run a shell command inside a sandbox; with wait it returns the result, otherwise poll sandboxExec.get Risk: write
Input
Output: object

Sandbox Files

download

sandboxFiles.download Download a file from a sandbox by absolute path. On Corsair up to about 700 KB comes back inline as contentBase64 and a larger file comes back as fileId, a Files id; without a host that keeps files the content comes back inline up to 100 MB, or contentOmitted beyond it. Risk: read
Input Output

upload

sandboxFiles.upload Write a file to an absolute path inside a sandbox, overwriting any existing file Risk: write
Input Output: object[]

Sandbox Products

list

sandboxProducts.list List the sandbox product catalog (CPU, memory, disk) in a data center Risk: read
Input Output

Sandbox Templates

create

sandboxTemplates.create Create a sandbox template from an image or another template and start its first build Risk: write
Input
Output

delete

sandboxTemplates.delete Delete a sandbox template; existing sandboxes keep running Risk: destructive · Irreversible
Input Output

get

sandboxTemplates.get Get a sandbox template with its current and latest build Risk: read
Input Output

getBuild

sandboxTemplates.getBuild Get a sandbox template build status and artifact availability Risk: read
Input Output

getBuildLogs

sandboxTemplates.getBuildLogs Get build logs for a sandbox template build, paged by offset Risk: read
Input Output

list

sandboxTemplates.list List sandbox templates with pagination Risk: read
Input Output

listBuilds

sandboxTemplates.listBuilds List the builds of a sandbox template, newest first, with pagination Risk: read
Input Output

update

sandboxTemplates.update Update a sandbox template’s name, description, or labels Risk: write
Input Output

Templates

create

templates.create Create a custom container template Risk: write
Input
Output

delete

templates.delete Delete a custom container template Risk: destructive · Irreversible
Input Output

get

templates.get Get a container template by ID Risk: read
Input Output

list

templates.list List container templates (official and custom) used to launch containers Risk: read
Input: empty object Output: object[]

update

templates.update Update a custom container template Risk: write
Input
Output

Uploads

createUrl

uploads.createUrl Get a pre-signed upload URL and the stable public URL to reference an image, video, or audio file in media requests Risk: write
Input Output

Vpcs

allocate

vpcs.allocate Allocate the default VPC for the organization in a data center Risk: write
Input Output

get

vpcs.get Get a VPC and its subnets by ID Risk: read
Input Output

list

vpcs.list List VPCs, optionally filtered by data center Risk: read
Input Output: object[]

release

vpcs.release Release the default VPC Risk: destructive · Irreversible
Input Output