List Bare Metal Regions

Lists the currently available regions, each representing a distinct geographic location housing a data center. For additional information on regions.

HTTP Request

GET {API_URL}/bare-metal/regions

Parameters

No parameters.

Reponse Attributes

status boolean

Indicates the success or failure of the retrieval of regions. true signifies success, while false indicates an error.

message string

A message confirming the successful retrieval of regions.

data array

An array of regions objects containing details about the available regions.

Each region specifies the following properties:

• name string: The name of the region.
• id string: Unique identifier for the region.
• description string: Description of the region.

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": "Getting regions successful",
    "data": [
        {
            "name": "SINGAPORE-1",
            "description": "",
            "id": "65d4586b07f237cca5eeb5b5"
        },
        {
            "name": "TOKYO-1",
            "description": "",
            "id": "65d4586907f237cca5eeb5b2"
        }
    ]
}