API Reference

Complete REST API documentation for Orbex Cloud

Interactive API Docs

Services

Resources

SDKsExamplesCLI

Compute API

Manage compute instances, GPU resources, and container deployments.

GET/api/v1/compute/instances

List all compute instances

Parameters

limitinteger

Maximum number of instances to return

offsetinteger

Number of instances to skip

statusstring

Filter by instance status

Example Request

curl -X GET "https://api.orbex.cloud/v1/compute/instances" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
POST/api/v1/compute/instances

Create a new compute instance

Parameters

namestringrequired

Instance name

instance_typestringrequired

Instance type (e.g., gpu-a100)

imagestringrequired

Container image to run

Example Request

curl -X POST "https://api.orbex.cloud/v1/compute/instances" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-gpu-instance",
    "instance_type": "gpu-a100",
    "image": "pytorch:latest"
  }'
DELETE/api/v1/compute/instances/{id}

Delete a compute instance

Parameters

idstringrequired

Instance ID

Example Request

curl -X DELETE "https://api.orbex.cloud/v1/compute/instances/inst-123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can generate API keys in your account settings.