> ## 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.

# Set the organisation's CI runner label

> Set the organisation's application CI settings. Organisation admins only. ci_runner_label is the GitHub Actions runner label generated pipelines run on, validated rather than accepted as free text: one label of at most 64 characters, starting and ending with a letter or digit, containing only letters, digits, '-', '_' and '.' (for example ubuntu-latest, depot-ubuntu-24.04, self-hosted). Anything else answers 400 - a label outside that grammar produces a workflow GitHub cannot parse or run, and the generators concatenate it into a YAML scalar. An explicit null clears the choice and puts every future generation back on the default. auto_merge_setup_pull_requests opts the organisation into the platform merging an application's setup pull request itself once the PR's checks pass (squash; branch protection is honoured, never forced). Each member only moves when named: an absent member leaves the stored value untouched, and a body naming neither answers 422. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication plus the X-Ankra-CSRF double-submit header).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/applications/settings
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/applications/settings:
    put:
      tags:
        - Applications
      summary: Set the organisation's CI runner label
      description: >-
        Set the organisation's application CI settings. Organisation admins
        only. ci_runner_label is the GitHub Actions runner label generated
        pipelines run on, validated rather than accepted as free text: one label
        of at most 64 characters, starting and ending with a letter or digit,
        containing only letters, digits, '-', '_' and '.' (for example
        ubuntu-latest, depot-ubuntu-24.04, self-hosted). Anything else answers
        400 - a label outside that grammar produces a workflow GitHub cannot
        parse or run, and the generators concatenate it into a YAML scalar. An
        explicit null clears the choice and puts every future generation back on
        the default. auto_merge_setup_pull_requests opts the organisation into
        the platform merging an application's setup pull request itself once the
        PR's checks pass (squash; branch protection is honoured, never forced).
        Each member only moves when named: an absent member leaves the stored
        value untouched, and a body naming neither answers 422. A browser
        session twin is mounted at the same path without the /api/v1 prefix
        (cookie authentication plus the X-Ankra-CSRF double-submit header).
      operationId: set_application_ci_settings_api_v1
      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/SetApplicationCISettingsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationCISettings'
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: The runner label is outside the accepted grammar
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Forbidden ("Only organisation admins can change the application CI
            settings.")
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    SetApplicationCISettingsRequest:
      description: >-
        At least one member must be present; an absent member leaves the stored
        value untouched. An explicit null ci_runner_label clears the
        organisation's choice. auto_merge_setup_pull_requests is a plain boolean
        (an organisation admin's opt-in to auto-merging setup pull requests
        whose checks pass).
      properties:
        ci_runner_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Ci Runner Label
        auto_merge_setup_pull_requests:
          title: Auto Merge Setup Pull Requests
          type: boolean
      title: SetApplicationCISettingsRequest
      type: object
    ApplicationCISettings:
      description: >-
        The organisation's application CI settings. ci_runner_label is the
        runs-on value generated pipelines carry; is_default reports that the
        organisation has never chosen one, so the label is Ankra's default
        rather than a decision - a build that never starts reads very
        differently under the two. auto_merge_setup_pull_requests is the
        organisation's opt-in to letting the platform merge an application's
        setup pull request itself once the PR's checks pass (default false).
      properties:
        ci_runner_label:
          title: Ci Runner Label
          type: string
        is_default:
          title: Is Default
          type: boolean
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
        auto_merge_setup_pull_requests:
          title: Auto Merge Setup Pull Requests
          type: boolean
      required:
        - ci_runner_label
        - is_default
        - updated_at
        - auto_merge_setup_pull_requests
      title: ApplicationCISettings
      type: object
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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

````