Regions
List the regions and move a team to a different region.
Last updated
Overview
A region is a place where the platform runs your workspaces and environments. It has an id, a name, and a status, and you can use it only while the status is active. Each owner has exactly one region, which the platform records when it makes the team. Create calls have no field for a region.
Only an administrator of the platform decides the request. See Quota and requests.
The platform cannot move workspace data between regions. It refuses a move while the owner holds a workspace, capsule, environment, volume, snapshot, or desk. After an approved move, create new items in the new region.
To do these tasks with an AI agent, see Agentic workflows.
Limits
| Item | Limit |
|---|---|
| Regions of an owner | One |
| Pending region requests | One for each owner |
Tasks
List the regions
Reason for the task
Find the regions that you can use.
Job set-up
- Access: you.
- References:
GET /v1/regions.
Procedure
Create the SDK client.
from kloudlite import Kodekl = Kloudlite()import { Kode } from "./index.ts";const kl = new Kloudlite();kl := kloudlite.New(kloudlite.Options{})require_relative "kloudlite"kl = Kloudlite::Client.newvar kl = new Kloudlite();List the regions.
for r in kl.request("GET", "/v1/regions"): print(r["id"], r["name"], r["status"])const regions = (await kl.request("GET", "/v1/regions")) as { id: string; name: string; status: string }[];for (const r of regions) { console.log(r.id, r.name, r.status);}var regions []map[string]anyif err := kl.Request("GET", "/v1/regions", kloudlite.RequestOptions{Out: ®ions}); err != nil { log.Fatal(err)}for _, r := range regions { fmt.Println(r["id"], r["name"], r["status"])}kl.request("GET", "/v1/regions").each do |r| puts "#{r["id"]} #{r["name"]} #{r["status"]}"end// The answer is a JSON list; each entry has "id", "name", and "status".System.out.println(kl.request("GET", "/v1/regions"));kode request GET /v1/regions
Close-out
- Use the
idof a region with the statusactive.
Move a team to a different region
Reason for the task
Run the workspaces of an owner in a different region.
Job set-up
- Access: you. For a team, a team admin or a team owner.
- Conditions: the owner holds no workspace, environment, volume, or desk and has no pending request of the kind
region. You know theidof anactiveregion. - References:
POST /v1/requests, List the regions.
Delete every workspace, environment, volume, and desk of the owner first. This deletes the data in them. Copy what you need to a repository first.
The console form requests for your own account. A request for a team goes to the same route with owner set to the team handle.
Procedure
Delete the workspaces, the environments, the volumes, and the desks of the owner.
Open your avatar menu, select My requests, and select New request.
Select Move to a region in the field
What do you need?.Select the region in the field
Region, and type the reason in the fieldReason.Select Send request.
Close-out
- Make sure that the request shows
approved. See Show the status of a request.
Troubleshooting
| Symptom | Possible cause | Corrective action |
|---|---|---|
422 with unknown region | The region does not exist or is not active. | Select a region from List the regions. |
409 with a request is already pending | The owner has a pending region request. | Wait for the decision. |
The request stays pending | The owner still holds a workspace, an environment, a volume, or a desk. | Delete them. Ask the administrator to decide again. |
The request shows denied | An administrator refused the move. | Read the note below the reason. Send a new request if needed. |