Skip to content

Preflight Import

POST
/clusters/preflight-import
curl --request POST \
--url https://api.mengi.cloud/clusters/preflight-import \
--header 'Content-Type: application/json' \
--data '{ "kubeconfig": "example", "cloud_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "provider": "example", "provider_cluster_id": "example", "region": "example" }'

Inspect a candidate cluster for collisions before importing it.

Returns a list of detected resource collisions (CRDs, IngressClasses, pre-existing namespaces, etc.) so the caller can decide whether the import is safe to proceed.

Read-only — no DB mutations, no cluster creation.

Media type application/json
PreflightImportRequest

Input to POST /clusters/preflight-import.

Either kubeconfig or (cloud_credential_id + provider + provider_cluster_id) must be supplied — same contract as the regular import endpoint.

object
kubeconfig
Any of:
string
cloud_credential_id
Any of:
string format: uuid
provider
Any of:
string
provider_cluster_id
Any of:
string
region
Any of:
string
Example generated
{
"kubeconfig": "example",
"cloud_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"provider": "example",
"provider_cluster_id": "example",
"region": "example"
}

Successful Response

Media type application/json
PreflightImportResponse

Result of POST /clusters/preflight-import.

object
safe_to_import
required
Safe To Import
boolean
conflicts
required
Conflicts
Array<object>
PreflightConflict

A single collision detected by import preflight.

object
resource_type
required
Resource Type
string
name
required
Name
string
severity
required
Severity
string
detail
required
Detail
string
Example generated
{
"safe_to_import": true,
"conflicts": [
{
"resource_type": "example",
"name": "example",
"severity": "example",
"detail": "example"
}
]
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}