Skip to content

List Regions ​

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

HTTP Request ​

GET {API_URL}/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}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": "DALLAS",
            "description": "GPU VPS",
            "id": "66b9c7a00ac7fb00139e6b13"
        }
    ]
}