> ## 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 a source-control binding's AI review switches

> Organisation admin only. ai_review and mention_replies are required; every other member is optional and an omitted member keeps its stored value. merge_when_green is the switch behind merge-when-green: with it on, and the binding's AI mode set to Agent, an '@ankraai merge when green' comment, the portal button or the scm_merge_pull_request tool records a merge intent that Ankra settles once the pull request is green.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/ai-gateway/scm-bindings/{provider}/{binding_external_id}
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: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - 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: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - 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 Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - 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: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - 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: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - 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.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/ai-gateway/scm-bindings/{provider}/{binding_external_id}:
    put:
      tags:
        - AI Environment
      summary: Update a source-control binding's AI review switches
      description: >-
        Organisation admin only. ai_review and mention_replies are required;
        every other member is optional and an omitted member keeps its stored
        value. merge_when_green is the switch behind merge-when-green: with it
        on, and the binding's AI mode set to Agent, an '@ankraai merge when
        green' comment, the portal button or the scm_merge_pull_request tool
        records a merge intent that Ankra settles once the pull request is
        green.
      operationId: >-
        update_scm_binding_api_v1_org_ai_gateway_scm_bindings__provider___binding_external_id__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
        - in: path
          name: provider
          required: true
          schema:
            title: Provider
            type: string
          description: >-
            The source-control provider of the binding: github, gitlab or
            bitbucket.
        - in: path
          name: binding_external_id
          required: true
          schema:
            title: Binding External Id
            type: string
          description: >-
            The provider's own id of the binding: the GitHub App installation
            id, the GitLab or Bitbucket credential id.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSCMBindingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCMBindingUpdateResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    UpdateSCMBindingRequest:
      properties:
        ai_review:
          title: Ai Review
          type: boolean
        mention_replies:
          title: Mention Replies
          type: boolean
        pr_previews:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Pr Previews
          description: Omitted keeps the stored value.
        merge_when_green:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Merge When Green
          description: >-
            Switches merge-when-green on for the binding. Omitted keeps the
            stored value. The binding's AI mode must also be Agent for a request
            to be honoured.
        review_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Review Model
          description: >-
            An organisation model-catalog key; the empty string inherits the
            platform default; omitted keeps the stored value.
        review_drafts:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Review Drafts
          description: Omitted keeps the stored value.
        max_reviews_per_pr:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Reviews Per Pr
          description: 0 means no cap; omitted keeps the stored value.
        custom_instructions:
          anyOf:
            - type: string
            - type: 'null'
          title: Custom Instructions
          description: The empty string clears it; omitted keeps the stored value.
      required:
        - ai_review
        - mention_replies
      title: UpdateSCMBindingRequest
      type: object
    SCMBindingUpdateResult:
      properties:
        success:
          title: Success
          type: boolean
        provider:
          title: Provider
          type: string
        binding_external_id:
          title: Binding External Id
          type: string
        ai_review:
          title: Ai Review
          type: boolean
        mention_replies:
          title: Mention Replies
          type: boolean
        pr_previews:
          title: Pr Previews
          type: boolean
        merge_when_green:
          title: Merge When Green
          type: boolean
        review_model:
          title: Review Model
          type: string
        review_drafts:
          title: Review Drafts
          type: boolean
        max_reviews_per_pr:
          title: Max Reviews Per Pr
          type: integer
        custom_instructions:
          title: Custom Instructions
          type: string
      required:
        - success
        - provider
        - binding_external_id
        - ai_review
        - mention_replies
      title: SCMBindingUpdateResult
      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

````