List supported regions

GET/regionsList supported regions

Lists supported Neon regions.

Note: Not all regions are available to all organizations. Pass the org_id parameter to get an accurate list of regions available to your organization.

Parameters

org_idstringquery

Organization ID. When provided, returns only regions available to this organization. Recommended for accurate region availability.

pattern ^[a-z0-9-]{1,60}$

Responses

objectActiveRegionsResponse

regionsarray of objectrequired

The list of active regions

Show child attributes

Show array items

defaultbooleanrequired

True if this region is selected by default when no region is specified during project creation.

geo_latstringrequired

The geographical latitude (approximate) for the region. Empty if unknown.

geo_longstringrequired

The geographical longitude (approximate) for the region. Empty if unknown.

namestringrequired

A short description of the region.

region_idstringrequired

Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.

Example response

{
  "regions": [
    {
      "default": true,
      "geo_lat": "string",
      "geo_long": "string",
      "name": "string",
      "region_id": "aws-us-east-1"
    }
  ]
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

org_idquery parameter

curl -X GET 'https://console.neon.tech/api/v2/regions?org_id=string'

const response = await fetch('https://console.neon.tech/api/v2/regions?org_id=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/regions?org_id=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/regions?org_id=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/regions?org_id=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/regions?org_id=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/regions?org_id=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/regions?org_id=string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/regions?org_id=string");
using var response = await client.SendAsync(request);

{
  "regions": [
    {
      "default": true,
      "geo_lat": "string",
      "geo_long": "string",
      "name": "string",
      "region_id": "aws-us-east-1"
    }
  ]
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}