List instances

How to view your existing instances with the FluidStack API

Call the List user instances endpoint:

GET
1curl https://platform.fluidstack.io/instances \
2     -H "api-key: <api-key>"

You must provide your own API key in the header of the request.

Example response:

Response
1[
2  {
3    "id": "i-1234567890",
4    "status": "running",
5    "username": "ubuntu",
6    "ssh_port": "22",
7    "ssh_keys": [
8      "my_ssh_key"
9    ],
10    "ip_address": "192.0.2.0",
11    "name": "my_instance_name",
12    "current_rate": 1,
13    "configuration": {
14      "id": "c-1234567890",
15      "gpu_model": {
16        "name": "RTX_A5000_24GB",
17        "memory_size_gb": 24
18      },
19      "cpu_model": "generic",
20      "gpu_count": 1,
21      "cpu_count": 8,
22      "nvme_storage_size_gb": 200,
23      "memory_size_gb": 30,
24      "estimated_provisioning_time_minutes": 5
25    },
26    "created_at": "2024-01-15T09:30:00Z"
27  }
28]

If your request succeeds, the endpoint will respond with a JSON array containing one or more objects.

Each object contains the details for an instance belonging to the user whose API key was provided in the header.

For further details, see the API Reference.