List Instances

Returns all compute instances for the authenticated user.

Endpoint


GET /v1/instances

Example


curl https://api.redu.cloud/v1/instances \
  -H "x-api-key: YOUR_API_KEY"


const response = await fetch(
  "https://api.redu.cloud/v1/instances",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    },
  }
);
 
if (!response.ok) {
  throw new Error(`HTTP ${response.status}`);
}
 
const data = await response.json();
console.log(data);


import axios from "axios";
 
const { data } = await axios.get(
  "https://api.redu.cloud/v1/instances",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    },
  }
);
 
console.log(data);


import requests
 
resp = requests.get(
    "https://api.redu.cloud/v1/instances",
    headers={"x-api-key": "YOUR_API_KEY"},
)
 
resp.raise_for_status()
print(resp.json())


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	req, _ := http.NewRequest(
		"GET",
		"https://api.redu.cloud/cloud/v1/compute/instances/list",
		nil,
	)
 
	req.Header.Set("x-api-key", "YOUR_API_KEY")
 
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Successful Response


[
  {
    "id": "8b6f4c21-1c7e-4c45-9e5a-1b6c7a9f2d11",
    "name": "web-production-01",
    "status": "ACTIVE",
    "state": "active",
    "image_id": "a2f1d2c3-4455-4e11-8e33-9a7b0c6d1234",
    "flavor_id": "m1.small",
    "created": "2026-02-12T09:14:22Z",
    "updated": "2026-02-12T09:16:03Z",
    "metadata": {
      "isPublic": "true",
      "enableSSH": "true",
      "floatingIp": "203.0.113.42"
    },
    "user_id": "ab2399414c9248a09de5ed551c817f16",
    "project_id": "719015812e824d5b874b4190dde8f43c"
  },
  {
    "id": "c3a29e87-5e7f-4f88-b8a2-44d6e8f19abc",
    "name": "api-staging",
    "status": "SHUTOFF",
    "state": "stopped",
    "image_id": "b1c3d5e7-8899-4d22-9f44-0a1b2c3d4e5f",
    "flavor_id": "m1.medium",
    "created": "2026-02-10T18:03:11Z",
    "updated": "2026-02-14T12:45:09Z",
    "metadata": {
      "isPublic": "false",
      "enableSSH": "true"
    },
    "user_id": "ab2399414c9248a09de5ed551c817f16",
    "project_id": "719015812e824d5b874b4190dde8f43c"
  }
]

Response Schema

This endpoint returns an array of instance objects.

Instance

Field	Type	Description
id	string	Unique instance ID
name	string	Instance name
status	string	High-level status (`ACTIVE`, `SHUTOFF`, `BUILD`)
state	string	Internal state (`active`, `stopped`, `provisioning`)
image_id	string	Image ID used to create the instance
flavor_id	string	Flavor identifier (e.g. `m1.small`)
created	string	Creation timestamp (ISO 8601 UTC)
updated	string	Last update timestamp (ISO 8601 UTC)
metadata	object	Instance metadata (key-value map)
user_id	string	Owner user ID
project_id	string	Project ID

metadata

Field	Type	Description
isPublic	string	Whether the instance has public access (`"true"` / `"false"`)
enableSSH	string	Whether SSH access is enabled (`"true"` / `"false"`)
floatingIp	string	Public IP address (if assigned)

Errors

401 Unauthorized


{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

403 Forbidden

The API key does not have access to the requested project.