Get Ai Environment Api Endpoint

Read the organisation’s AI environment settings, including dns_root_domain - the organisation’s own Ankra root domain that every generated hostname nests under - and dns_root_domain_default, the platform default that applies when no custom domain is registered.

GET /api/v1/org/ai-environment

Get Ai Environment Api Endpoint

Python

import requests

url = "https://platform.ankra.app/api/v1/org/ai-environment"

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

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

print(response.text)

200

{
  "dns_root_domain": "<string>",
  "dns_root_domain_default": "<string>",
  "staging_cluster_id": "<string>",
  "staging_cluster_name": "<string>",
  "staging_cluster_online": true,
  "workspace_ttl_hours": 123,
  "demo_ttl_hours": 123,
  "default_gateway_mode": "<string>",
  "demo_ttl_role_caps": {},
  "demo_base_domain": "<string>",
  "demo_ingress_class_name": "<string>",
  "demo_tls_secret_name": "<string>",
  "demo_cert_issuer_name": "<string>",
  "demo_preview_tls_warning": "<string>",
  "demo_preview_dns_warning": "<string>",
  "home_slack_channel_id": "<string>",
  "home_slack_channel_name": "<string>",
  "home_slack_team_id": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Response

200

application/json

Successful Response

dns_root_domain · string | null · required

dns_root_domain_default · string · required

staging_cluster_id · string | null

staging_cluster_name · string | null

staging_cluster_online · boolean

workspace_ttl_hours · integer

demo_ttl_hours · integer

default_gateway_mode · string

demo_ttl_role_caps · Demo Ttl Role Caps · object

Show child attributes

demo_base_domain · string | null

demo_ingress_class_name · string | null

demo_tls_secret_name · string | null

demo_cert_issuer_name · string | null

demo_preview_tls_warning · string | null

demo_preview_dns_warning · string | null

home_slack_channel_id · string | null

home_slack_channel_name · string | null

home_slack_team_id · string | null