> For the complete documentation index, see [llms.txt](https://docs.nebulablock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nebulablock.com/api-reference/platform-api/list-products/get-instance.md).

# Get Instance

Retrieve the full details of one instance, including its connection credentials.

Return instance detail information, like cpu, gpu, ram, total running time and etc.

## HTTP Request

`GET` `{API_URL}/computing/instance/{id}`

## Path parameters

| Parameters | Requirements | Type     | Description                                                                                                               |
| ---------- | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| id         | Required     | `string` | The unique identifier of the instance, from [List Instances](/api-reference/platform-api/list-products/list-instances.md) |

> **Note:** An unknown id is rejected with **HTTP 404** `Instance not found`, and an instance belonging to someone else with **HTTP 403** `Permission denied`.

## Response Attributes

#### data `array`

An **array holding a single object** that describes the instance — not a bare object. Read `data[0]`.

> **Important:** A server-side error is not reported as an HTTP error. It returns an **empty `data` array with `"status": "success"`** and HTTP 200. Check that `data` is non-empty rather than trusting `status` here.

The object contains:

* **id** `string`: The unique identifier of the instance.
* **host\_name** `string`: The user-defined name of the instance.
* **dc\_id** `number`: Identifier of the data center hosting the instance.
* **region** `string`: The region the instance runs in.
* **product\_type** `string`: The form factor — `Virtual Machine`, `Baremetal`, or `Container`.
* **cpu\_cores** `number`: The number of CPU cores.
* **cpu\_count** `number`: The number of CPUs, alongside `cpu_cores`.
* **cpu\_model** `string`: The CPU model.
* **ram** `number`: The amount of RAM in gigabytes.
* **gpu** `string`: The full GPU model name, for example `A100-80G-PCIe`.
* **gpu\_type** `string`: The GPU family, for example `A100`.
* **gpu\_count** `number`: The number of GPUs attached to the instance.
* **disk\_size** `number`: The root disk size in gigabytes.
* **ephemeral** `number`: The ephemeral disk size in gigabytes.
* **bandwidth** `number`: Network bandwidth allocated to the instance.
* **public\_ipv4** `string`: The public IPv4 address of the instance, or `null` before one is assigned.
* **lan\_ipv4** `string`: The LAN IPv4 address of the instance.
* **login\_method** `string`: The login method of the instance.
* **os** `string`: The operating system of the instance.
* **image** `string`: The OS image the instance was deployed from.
* **exposed\_ports** `string`: The exposed ports of the container instance.
* **user\_name** `string`: The login user name. Also repeated as **username** — the two always match.
* **password** `string`: The login password, for configurations that issue one.
* **description** `string`: The instance description, if one was set. `""` otherwise.
* **status** `string`: The status of the instance, for example `Deploying`, `Running`, `Stopped`.
* **is\_spot** `boolean`: Whether the instance is running on spot capacity.
* **firewall\_supported** `boolean`: Whether this instance supports [firewall rules](/api-reference/platform-api/list-products/firewall-rules.md). Not every configuration does.
* **start\_time** `string`: The instance's **creation** time, formatted in US Eastern time, for example `EST 2024-11-04 10:11:50`. Despite the name it is not when the instance last started — the API does not report that. Use `created_at` if you want the same moment as a timestamp.
* **running\_time** `string`: The billed running time so far, as a string ending in `hours`. `" hours"` on its own when the instance has no billing record yet.
* **total\_cost** `string`: The accumulated cost so far, as a `$`-prefixed string.
* **billing\_price\_per\_hour** `number`: What the instance is billed per hour right now, in USD — its hourly rate while running, the storage rate while a Spot instance is `Preempted`, and `0` when nothing is being billed.
* **created\_at** `number`: Unix timestamp in seconds for when the instance record was created.
* **started\_at** `number`: Only set on a reserved instance, where it holds the booked start of the reservation as a unix timestamp. `null` on on-demand instances.
* **ended\_at** `number`: Only set on a reserved instance, where it holds the booked end of the reservation as a unix timestamp. `null` on on-demand instances.
* **type** `number`: An internal product classification. Usually `null`.
* **team\_id** `number`: The owning team, or `null` for a personal instance.

> **Note:** The response also carries fields used by the console UI, such as `capabilities` and `cmd_log`. Treat anything not listed here as internal and subject to change.

#### message `string`

A description of the status of the request.

#### status `string`

Indicates the result of the request.\
**success** signifies success, while **failed** indicates an error.

## Example

#### Request

```bash
curl -X GET '{API_URL}/computing/instance/{id}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \

```

#### Response

```json
{
    "data": [
        {
            "id": "7b3e4c21-8f2a-4d19-9c3e-1a2b3c4d5e6f",
            "host_name": "demo",
            "dc_id": 2,
            "region": "CANADA",
            "product_type": "Virtual Machine",
            "cpu_cores": 28,
            "cpu_count": 1,
            "cpu_model": "AMD EPYC 7763",
            "ram": 58,
            "gpu": "RTX-A6000",
            "gpu_type": "RTX",
            "gpu_count": 1,
            "disk_size": 100,
            "ephemeral": 1500,
            "bandwidth": 1000,
            "public_ipv4": "38.80.81.128",
            "lan_ipv4": "10.0.0.14",
            "login_method": "",
            "os": "Ubuntu Server 22.04 LTS",
            "image": "Ubuntu Server 22.04 LTS",
            "exposed_ports": "",
            "user_name": "ubuntu",
            "username": "ubuntu",
            "password": "",
            "description": "",
            "status": "Running",
            "is_spot": false,
            "firewall_supported": true,
            "start_time": "EST 2024-11-04 10:11:50",
            "running_time": "12.5000 hours",
            "total_cost": "$8.4875",
            "billing_price_per_hour": 0.679,
            "created_at": 1730729510,
            "started_at": null,
            "ended_at": null,
            "type": null,
            "team_id": null
        }
    ],
    "message": "Get instance detail successfully",
    "status": "success"
}

```