List Bare Metal Regions

Retrieve information about available geographical deployment locations, each representing a distinct data center facility. This endpoint provides comprehensive details about infrastructure distribution and regional capabilities.

HTTP Request

GET {API_URL}/bare-metal/regions

Parameters

This endpoint accepts no parameters.

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 region information retrieval.

data array

Collection of region objects detailing available deployment locations.

Region attributes include:

• name string: Regional designation
• id string: Unique region identifier
• description string: Detailed region specifications and capabilities

Implementation Example

Request

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

Response

{
    "status": true,
    "message": "Region information retrieved successfully",
    "data": [
        {
            "name": "FRANCE",
            "description": "",
            "id": "65aa480a29ba870811f0edc7"
        },
        {
            "name": "SINGAPORE",
            "description": "",
            "id": "6758f63bd2c19c3dcb532230"
        },
        {
            "name": "TOKYO",
            "description": "",
            "id": "676248245a4f6a9d15562122"
        }
    ]
}