> ## Documentation Index > Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Resolve a platform component configuration > Resolves the fields and runtime requirements to display for a component using the cluster context and the values currently entered in the Console. This operation is read-only. ## OpenAPI ````yaml /api-reference/openapi.yaml post /organization/{organizationId}/cluster/{clusterId}/platformBinding/component/{componentKey}/resolve openapi: 3.0.0 info: version: 1.0.4 title: Qovery API description: > - Qovery is the fastest way to deploy your full-stack apps on any Cloud provider. - ℹ️ The API is stable and still in development. contact: name: Qovery Product Team url: https://www.qovery.com email: support+api+documentation@qovery.com x-logo: url: https://console.qovery.com/assets/logos/logo-white.svg altText: Qovery servers: - url: https://api.qovery.com security: - bearerAuth: [] - ApiKeyAuth: [] tags: - name: Account - name: Account Info - name: IPs - name: Alert Receivers - name: Alert Rules - name: Admin - name: ArgoCD - name: Application - name: Application Actions - name: Application Configuration - name: Application Database - name: Application Deployment Restriction - name: Application Deployment History - name: Application Environment Variable - name: Application Logs - name: Application Main Calls - name: Application Secret - name: Application Annotations Group - name: Applications - name: AutoscalingPolicy - name: Container - name: Container Actions - name: Container Configuration - name: Container Database - name: Container Deployment History - name: Container Environment Variable - name: Container Logs - name: Container Main Calls - name: Container Registry - name: Container Secret - name: Container Annotations Group - name: Containers - name: Deployment Stage Main Calls - name: Job - name: Job Actions - name: Job Configuration - name: Job Database - name: Job Deployment Restriction - name: Job Deployment History - name: Job Environment Variable - name: Job Logs - name: Job Main Calls - name: Job Registry - name: Job Secret - name: Job Annotations Group - name: Jobs - name: KedaTriggerAuthentication - name: Helm - name: Helm Actions - name: Helm Configuration - name: Helm Database - name: Helm Deployment Restriction - name: Helm Deployment History - name: Helm Logs - name: Helm Main Calls - name: Helm Repository - name: Helms - name: Backups - name: Billing - name: Blueprint Catalog - name: Cloud Provider - name: Cloud Provider Credentials - name: Clusters - name: Platform Configuration - name: Custom Domain - name: Container Custom Domain - name: Database - name: Database Actions - name: Database Application - name: Database Container - name: Database Deployment History - name: Database Main Calls - name: Database Annotations Group - name: Databases - name: Environment - name: Environment Actions - name: Environment Deployment History - name: Environment Deployment Rule - name: Environment Logs - name: Environment Main Calls - name: Environment Secret - name: Environment Variable - name: Environments - name: Git - name: Github App - name: Git repositories - name: Members - name: Organization - name: Organization Account Git Repositories - name: Organization Cluster Lock - name: Organization Main Calls - name: Organization Custom Role - name: Organization Event - name: Organization Api Token - name: Organization Webhook - name: Organization Annotations Group - name: Organization Labels Group - name: Organization Enterprise Connection - name: Project - name: Project Deployment Rule - name: Project Environment Variable - name: Project Main Calls - name: Project Secret - name: Projects - name: Referral & Rewards - name: Secret Manager Access - name: Terraforms - name: Terraform Main Calls - name: Terraform Resources - name: Terraform Deployment History - name: Terraform Deployment Restriction - name: Container Registries - name: Helm Repositories - name: User Sign Up - name: Variable Main Calls - name: Helm Custom Domain - name: Lifecycle Template Main Calls - name: Blueprint Main Calls paths: /organization/{organizationId}/cluster/{clusterId}/platformBinding/component/{componentKey}/resolve: post: tags: - Platform Configuration summary: Resolve a platform component configuration description: >- Resolves the fields and runtime requirements to display for a component using the cluster context and the values currently entered in the Console. This operation is read-only. operationId: resolvePlatformComponentConfiguration parameters: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/clusterId' - name: componentKey in: path description: Platform component key required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/PlatformComponentConfigurationPreviewRequest responses: '200': description: Resolved component configuration content: application/json: schema: $ref: >- #/components/schemas/PlatformComponentConfigurationPreviewResponse '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '503': description: The platform template catalog is temporarily unavailable components: parameters: organizationId: name: organizationId in: path description: Organization ID required: true schema: type: string format: uuid clusterId: name: clusterId in: path description: Cluster ID required: true schema: type: string format: uuid schemas: PlatformComponentConfigurationPreviewRequest: type: object properties: profileConfig: $ref: '#/components/schemas/PlatformConfigurationValues' clusterInputs: type: object additionalProperties: type: string componentOutputs: $ref: '#/components/schemas/PlatformComponentStringValuesMap' PlatformComponentConfigurationPreviewResponse: type: object required: - clusterId - componentKey - fields - requirements - componentBindings - violations properties: clusterId: type: string format: uuid componentKey: type: string fields: type: array items: $ref: '#/components/schemas/FieldSchemaResponse' requirements: type: array items: $ref: '#/components/schemas/PlatformComponentInputRequirementResponse' componentBindings: type: array items: $ref: '#/components/schemas/PlatformComponentOutputBindingResponse' violations: type: array items: $ref: >- #/components/schemas/PlatformComponentConfigurationViolationResponse PlatformConfigurationValues: type: object description: Configuration values keyed by their catalog field name additionalProperties: {} PlatformComponentStringValuesMap: type: object description: String values keyed first by component key and then by input key additionalProperties: type: object additionalProperties: type: string FieldSchemaResponse: type: object description: >- Canonical platform catalog field descriptor. Mirrors the q-core `FieldSchemaResponse` DTO. required: - key - type - required - label - sensitive - constraints properties: key: type: string type: type: string description: >- Field type understood by the Console, such as string, number, or bool required: type: boolean defaultValue: type: string nullable: true label: type: string description: type: string nullable: true sensitive: type: boolean constraints: $ref: '#/components/schemas/FieldSchemaConstraintsResponse' PlatformComponentInputRequirementResponse: description: >- A catalog field the cluster must provide for the selected configuration: the shared field descriptor extended with its resolution scope and readiness. allOf: - $ref: '#/components/schemas/FieldSchemaResponse' - type: object required: - scope - status properties: scope: $ref: '#/components/schemas/PlatformComponentConfigurationInputScope' status: $ref: >- #/components/schemas/PlatformComponentConfigurationRequirementStatus PlatformComponentOutputBindingResponse: type: object required: - input - fromComponent - output properties: input: type: string fromComponent: type: string output: type: string PlatformComponentConfigurationViolationResponse: type: object required: - code - fieldPath - message properties: code: type: string description: Stable machine-readable violation code. fieldPath: type: string description: >- Path of the offending field. Convention: profile configuration fields use the bare field key (e.g. `storage`); cluster-provided inputs are prefixed with `clusterInputs.` (e.g. `clusterInputs.s3BucketName`). Consumers match violations to form fields using these exact paths. message: type: string description: Customer-facing message describing how to fix the violation. FieldSchemaConstraintsResponse: type: object description: Validation constraints attached to a catalog field descriptor. properties: allowedValues: type: array nullable: true items: type: string min: type: integer format: int64 nullable: true max: type: integer format: int64 nullable: true minLength: type: integer format: int64 nullable: true maxLength: type: integer format: int64 nullable: true pattern: type: string nullable: true PlatformComponentConfigurationInputScope: type: string enum: - PLATFORM_PROFILE - CLUSTER PlatformComponentConfigurationRequirementStatus: type: string enum: - MISSING - READY responses: '400': description: Bad request '401': description: Access token is missing or invalid '403': description: Access forbidden '404': description: Resource not found securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" ' ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token" ' ````