Skip to main content
POST
Resolve a platform component configuration before cluster creation

Authorizations

Authorization
string
header
required

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" '

Path Parameters

organizationId
string<uuid>
required

Organization ID

templateKey
string
required

Platform template key

templateVersion
string
required

Platform template version

componentKey
string
required

Platform component key

Query Parameters

clusterMode
enum<string>
required

Cluster management mode used to resolve component applicability

Available options:
QOVERY_MANAGED,
CUSTOMER_MANAGED
cloudProvider
enum<string>
required

Cluster cloud provider used to resolve component applicability

Available options:
AWS,
SCW,
GCP,
DO,
AZURE,
OVH,
CIVO,
HETZNER,
ORACLE,
IBM,
UNKNOWN

Body

application/json
profileConfig
object

Configuration values keyed by their catalog field name

clusterInputs
object
componentOutputs
object

String values keyed first by component key and then by input key

Response

Resolved component configuration

Component configuration resolved from an explicit template and cluster context before an actual cluster exists.

componentKey
string
required
fields
object[]
required
requirements
object[]
required
componentBindings
object[]
required
violations
object[]
required