> ## 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. # Read an application's proposed setup contract > Read the setup Ankra proposed for this application before anything is deployed: the detected stack, whether a database was generated, and the deploy option contract of record. The contract and database each carry a three-valued status - a proposal Ankra could not read answers "unknown", never an empty option list. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /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: get: tags: - Applications summary: Read an application's proposed setup contract description: >- Read the setup Ankra proposed for this application before anything is deployed: the detected stack, whether a database was generated, and the deploy option contract of record. The contract and database each carry a three-valued status - a proposal Ankra could not read answers "unknown", never an empty option list. operationId: get_application_setup_contract parameters: - in: path name: application_id required: true schema: type: string title: Application Id responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationSetupProposal' description: Successful Response '401': description: Unauthorized '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: ApplicationSetupProposal: description: >- The generated setup as recorded on the application: what Ankra detected, what it proposed, and what of it is negotiable. negotiable_options lists the option names a revision may change, so a caller never has to guess and a refusal is never the first thing the user learns. properties: application_id: type: string title: Application Id name: title: Name type: string analysis_status: title: Analysis Status type: string detected_language: title: Detected Language type: string detected_framework: title: Detected Framework type: string pull_request_url: title: Pull Request Url type: string setup_branch: title: Setup Branch type: string contract: $ref: '#/components/schemas/ApplicationSetupContract' database: $ref: '#/components/schemas/ApplicationSetupDatabase' negotiable_options: items: type: string title: Negotiable Options type: array required: - application_id - name - analysis_status - contract - database - negotiable_options title: Application Setup Proposal 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 ApplicationSetupContract: description: >- The deploy option contract of record. options is populated only when status is "recorded"; on "absent" and "unknown" it is null and reason says which. An application whose contract Ankra cannot read is not an application without a contract, so the two must not be rendered the same way. properties: status: $ref: '#/components/schemas/ApplicationSetupArtifactStatus' path: title: Path type: string options: anyOf: - items: $ref: '#/components/schemas/ApplicationSetupOption' type: array - type: 'null' title: Options reason: title: Reason type: string required: - status - path - options title: Application Setup Contract type: object ApplicationSetupDatabase: description: >- The database the proposal carries, read off the recorded manifests rather than off the detection that produced them. engine/operator/manifest_path are set only when status is "recorded". properties: status: $ref: '#/components/schemas/ApplicationSetupArtifactStatus' engine: title: Engine type: string operator: title: Operator type: string manifest_path: title: Manifest Path type: string reason: title: Reason type: string required: - status title: Application Setup Database 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 ApplicationSetupArtifactStatus: description: >- Which of the three states a recorded setup artifact is in. "absent" means Ankra successfully read the record and it genuinely does not contain the artifact; "unknown" means Ankra could not tell - the analysis has not completed, nothing was recorded, or what was recorded could not be read. They are separate values because a client that renders "unknown" as "no options" tells the user Ankra has nothing to offer when in fact it could not work out what applies. enum: - recorded - absent - unknown title: Application Setup Artifact Status type: string ApplicationSetupOption: description: >- One deploy option declared by the application's .ankra/ankra.yaml. The deploy form renders these and the deploy endpoint validates submitted inputs against them. properties: name: title: Name type: string type: title: Type type: string required: title: Required type: boolean default: anyOf: - type: string - type: 'null' title: Default description: anyOf: - type: string - type: 'null' title: Description required: - name - type - required - default - description title: Application Setup Option type: object ````