> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Ai Environment Api Endpoint

> Update the organisation's AI environment settings (organisation admin only). Only the members present in the body are changed. Setting dns_root_domain registers the organisation's own Ankra root domain; it must be a bare domain the organisation owns, already delegated to the Ankra nameservers, and held by no other organisation. The switch is refused with 400 while cluster DNS zones or DNS records still live under the old domain - the response's blocking_cluster_zones and blocking_dns_records members list exactly what to remove first, each capped at 100 entries with a matching *_truncated flag set to true when more exist (read the full lists from /api/v1/org/dns/cluster-zones and /api/v1/org/dns/records).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/ai-environment
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
paths:
  /api/v1/org/ai-environment:
    put:
      tags:
        - AI Environment
      summary: Update Ai Environment Api Endpoint
      description: >-
        Update the organisation's AI environment settings (organisation admin
        only). Only the members present in the body are changed. Setting
        dns_root_domain registers the organisation's own Ankra root domain; it
        must be a bare domain the organisation owns, already delegated to the
        Ankra nameservers, and held by no other organisation. The switch is
        refused with 400 while cluster DNS zones or DNS records still live under
        the old domain - the response's blocking_cluster_zones and
        blocking_dns_records members list exactly what to remove first, each
        capped at 100 entries with a matching *_truncated flag set to true when
        more exist (read the full lists from /api/v1/org/dns/cluster-zones and
        /api/v1/org/dns/records).
      operationId: update_ai_environment_api_endpoint_api_v1_org_ai_environment_put
      parameters:
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAIEnvironmentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIEnvironmentSettingsResult'
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIEnvironmentRefusal'
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    UpdateAIEnvironmentRequest:
      properties:
        staging_cluster_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Staging Cluster Id
        workspace_ttl_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Workspace Ttl Hours
        demo_ttl_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Demo Ttl Hours
        default_gateway_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Gateway Mode
        demo_ttl_role_caps:
          anyOf:
            - additionalProperties:
                type: integer
              type: object
            - type: 'null'
          title: Demo Ttl Role Caps
        demo_base_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Base Domain
        demo_ingress_class_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Ingress Class Name
        demo_tls_secret_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Tls Secret Name
        demo_cert_issuer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Cert Issuer Name
        dns_root_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Dns Root Domain
        home_slack_channel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Home Slack Channel Id
        home_slack_channel_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Home Slack Channel Name
      title: UpdateAIEnvironmentRequest
      type: object
    AIEnvironmentSettingsResult:
      properties:
        staging_cluster_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Staging Cluster Id
        staging_cluster_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Staging Cluster Name
        staging_cluster_online:
          title: Staging Cluster Online
          type: boolean
        workspace_ttl_hours:
          title: Workspace Ttl Hours
          type: integer
        demo_ttl_hours:
          title: Demo Ttl Hours
          type: integer
        default_gateway_mode:
          title: Default Gateway Mode
          type: string
        demo_ttl_role_caps:
          additionalProperties:
            type: integer
          title: Demo Ttl Role Caps
          type: object
        demo_base_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Base Domain
        demo_ingress_class_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Ingress Class Name
        demo_tls_secret_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Tls Secret Name
        demo_cert_issuer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Cert Issuer Name
        demo_preview_tls_warning:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Preview Tls Warning
        demo_preview_dns_warning:
          anyOf:
            - type: string
            - type: 'null'
          title: Demo Preview Dns Warning
        dns_root_domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Dns Root Domain
        dns_root_domain_default:
          title: Dns Root Domain Default
          type: string
        home_slack_channel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Home Slack Channel Id
        home_slack_channel_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Home Slack Channel Name
        home_slack_team_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Home Slack Team Id
      required:
        - dns_root_domain
        - dns_root_domain_default
      title: AIEnvironmentSettingsResult
      type: object
    AIEnvironmentRefusal:
      properties:
        detail:
          type: string
          title: Detail
        blocking_cluster_zones:
          items:
            $ref: '#/components/schemas/AIEnvironmentBlockingClusterZone'
          title: Blocking Cluster Zones
          type: array
        blocking_cluster_zones_truncated:
          title: Blocking Cluster Zones Truncated
          type: boolean
        blocking_dns_records:
          items:
            $ref: '#/components/schemas/AIEnvironmentBlockingDnsRecord'
          title: Blocking Dns Records
          type: array
        blocking_dns_records_truncated:
          title: Blocking Dns Records Truncated
          type: boolean
      required:
        - detail
      title: AIEnvironmentRefusal
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AIEnvironmentBlockingClusterZone:
      properties:
        cluster_id:
          type: string
          title: Cluster Id
        cluster_name:
          type: string
          title: Cluster Name
        fqdn:
          title: Fqdn
          type: string
        state:
          title: State
          type: string
      required:
        - cluster_id
        - cluster_name
        - fqdn
        - state
      title: AIEnvironmentBlockingClusterZone
      type: object
    AIEnvironmentBlockingDnsRecord:
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        record_type:
          title: Record Type
          type: string
        state:
          title: State
          type: string
      required:
        - id
        - name
        - record_type
        - state
      title: AIEnvironmentBlockingDnsRecord
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````