List Deployment Regions

Retrieve information about available geographical deployment locations within the Rich platform infrastructure. Each region represents a distinct data center facility. For detailed regional specifications, please refer to our Region Documentation.

HTTP Request

GET {API_URL}/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: Regional specifications and capabilities

Implementation 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": "Region information retrieved successfully",
    "data": [
        {
            "name": "FRANCE",
            "description": "GPU",
            "id": "6705f88d906a954599a477d7"
        }
    ]
}