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

# Revise an application's proposed setup contract

> Change named defaults on the application's deploy option contract. The revised .ankra/ankra.yaml is committed to the setup branch and the stored parameters are reprojected from it; nothing is deployed. The revision is all-or-nothing: any refused member leaves the proposal exactly as it was. Every answered request is a 200 whose outcome the client must switch on - a refusal carries its reasons in refusals rather than as an empty changes list.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json patch /org/applications/{application_id}/setup-contract
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:
  /org/applications/{application_id}/setup-contract:
    patch:
      tags:
        - Applications
      summary: Revise an application's proposed setup contract
      description: >-
        Change named defaults on the application's deploy option contract. The
        revised .ankra/ankra.yaml is committed to the setup branch and the
        stored parameters are reprojected from it; nothing is deployed. The
        revision is all-or-nothing: any refused member leaves the proposal
        exactly as it was. Every answered request is a 200 whose outcome the
        client must switch on - a refusal carries its reasons in refusals rather
        than as an empty changes list.
      operationId: revise_application_setup_contract
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSetupRevisionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSetupRevisionResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: '"permission_denied" (requires applications.write)'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: Not found ("Application not found")
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ApplicationSetupRevisionRequest:
      description: >-
        Named deploy-option defaults to change. The object maps option name to
        the new default value, which is the shape the deploy contract itself
        stores. Every value is a string: the contract stores every option
        default as text.
      properties:
        options:
          additionalProperties:
            type: string
          title: Options
          type: object
      required:
        - options
      title: Application Setup Revision Request
      type: object
    ApplicationSetupRevisionResult:
      description: >-
        The answer to a revision request. Every answered request is a 200
        carrying outcome; a refusal is a domain answer whose reasons the user
        has to read, not a malformed request. changes and refusals are always
        arrays.
      properties:
        outcome:
          $ref: '#/components/schemas/ApplicationSetupRevisionOutcome'
        changes:
          items:
            $ref: '#/components/schemas/ApplicationSetupChange'
          title: Changes
          type: array
        already_matching:
          items:
            type: string
          title: Already Matching
          type: array
        refusals:
          items:
            $ref: '#/components/schemas/ApplicationSetupRefusal'
          title: Refusals
          type: array
        commit_sha:
          title: Commit Sha
          type: string
        pull_request_url:
          title: Pull Request Url
          type: string
        setup_branch:
          title: Setup Branch
          type: string
        contract_store_failure:
          title: Contract Store Failure
          type: string
      required:
        - outcome
        - changes
        - already_matching
        - refusals
      title: Application Setup Revision Result
      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
    ApplicationSetupRevisionOutcome:
      description: >-
        What the revision request did. Clients switch on this: reading the
        changes list alone would render a refusal exactly like a request that
        needed no change. "applied" - the contract was rewritten, committed to
        the setup branch and reprojected onto the stored parameters.
        "already_matching" - every named default already held the requested
        value, so nothing was committed. "refused" - the proposal was left
        exactly as it was and refusals says why. "applied_contract_not_stored" -
        the revised descriptor was committed but the stored contract could not
        be reprojected from it, so the repository and the deploy form now
        describe different options.
      enum:
        - applied
        - already_matching
        - refused
        - applied_contract_not_stored
      title: Application Setup Revision Outcome
      type: string
    ApplicationSetupChange:
      description: >-
        One deploy-option default that moved. from is null when the option
        declared no default at all, which is a different fact from an empty one.
      properties:
        option:
          title: Option
          type: string
        from:
          anyOf:
            - type: string
            - type: 'null'
          title: From
        to:
          title: To
          type: string
      required:
        - option
        - from
        - to
      title: Application Setup Change
      type: object
    ApplicationSetupRefusal:
      description: >-
        One requested change that was not applied, and why. option is omitted
        when the whole request was refused rather than one member of it.
      properties:
        option:
          title: Option
          type: string
        reason:
          title: Reason
          type: string
      required:
        - reason
      title: Application Setup Refusal
      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

````