Skip to content

Retrieve Bare Metal Instance Details ​

Fetch comprehensive information about a specific bare metal instance by providing its unique identifier. The response includes detailed configuration specifications and current operational status.

HTTP Request ​

GET {API_URL}bare-metal/instances/{id}

Path Parameters ​

ParameterRequirementTypeDescription
idRequiredstringUnique identifier of the target instance

Response Structure ​

status boolean ​

Operation result indicator. Returns true for successful execution, false when encountering an error.

message string ​

Descriptive response indicating the outcome of the information retrieval request.

data object ​

Comprehensive instance information including configuration specifications, operational parameters, and resource allocation details.

Implementation Example ​

Request ​

bash
curl -X GET '{API_URL}bare-metal/instances/{id}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json'

Response ​

json
{
    "status": true,
    "message": "Instance details retrieved successfully",
    "data": {
        "id": "6758edadaa5d7e0971fc5647",
        "name": "BM-dhSqf5qh",
        "login": {
            "ssh_key": {
                "name": "sshkey"
            }
        },
        "fixed_ip": "*.*.*.*",
        "started_time": 1730979274,
        "flavor": {
            "name": "s3-H100x8",
            "cpu": 192,
            "disk": 32100,
            "ram": 1844,
            "gpu": "H100-80G-SXM5",
            "gpu_count": 8
        },
        "image": {
            "name": "Ubuntu Server 22.04 LTS (Jammy Jellyfish)"
        },
        "region": {
            "name": "SINGAPORE-1"
        }
    }
}