Back to Yugabyte Db

Listing Configurations

managed/api-examples/python-simple/list-customer-configs.ipynb

2026.1.0.0-b251.1 KB
Original Source

Listing Configurations

Get session Info

  • Using API key make a request get associated session_info
  • session_info contains current user and current customer uuid.
python
import http.client
import json
import os
from pprint import pprint

platform_address = os.getenv('API_BASE_URL', "portal.dev.yugabyte.com")
platform_api_key = os.getenv('YB_API_KEY')

conn = http.client.HTTPConnection(f"{platform_address}")

headers = {
  'Content-Type': "application/json",
  'X-AUTH-YW-API-TOKEN': f"{platform_api_key}"
}

conn.request("GET", "/api/v1/session_info", headers=headers)

res = conn.getresponse()
data = res.read()
session_info = json.loads(data)
pprint(session_info)

List all the configs for current customer.

For example, for storing backups in s3, gcs or nfs; you may have various storage configurations defined.

python
# Now pick a storage config you want to use to store
conn.request("GET",
             f"/api/v1/customers/{session_info.get('customerUUID')}/configs",
             headers=headers)

res = conn.getresponse()
data = res.read()

customer_configs = json.loads(data)
pprint(customer_configs)