Get platform configuration

Returns global platform configuration including available regions, countries, continents, and private locations for deployment policies.

GET /configuration

Get platform configuration

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/configuration \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.blaxel.ai/v0/configuration"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.blaxel.ai/v0/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/configuration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.blaxel.ai/v0/configuration")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "continents": [
    {
      "displayName": "<string>",
      "name": "<string>"
    }
  ],
  "countries": [
    {
      "displayName": "<string>",
      "name": "<string>"
    }
  ],
  "detectedRegion": "<string>",
  "privateLocations": [
    {
      "name": "<string>"
    }
  ],
  "regions": [
    {
      "agentDrivePublicUrl": {},
      "allowed": "<string>",
      "continent": "<string>",
      "country": "<string>",
      "drivesAvailable": true,
      "egressAvailable": true,
      "infoGeneration": "<string>",
      "location": "<string>",
      "name": "<string>",
      "proxyAvailable": true
    }
  ]
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Response

200 - application/json

Configuration of the control plane

Configuration

continents · object[]

Continents

Show child attributes

countries · object[]

Countries

Show child attributes

detectedRegion · string

Auto-detected closest region based on viewer geolocation (from CloudFront headers). Empty when geo headers are not available.

privateLocations · object[]

Private locations managed with blaxel operator

Show child attributes

regions · object[]

Regions

Show child attributes