SKE API and CLI index

Use these references to look up fields, supported values and behaviour. Start with the Enterprise overview for installation and task-based guides. Core Kratix APIs are defined in the Kratix reference.

Platform APIs

• SKE Operator: Kratix and SKEIntegration, installation configuration and status.
• HealthDefinition: health checks declared by a Promise.
• HealthSource: importing health records from a bucket.
• UpgradePlan: desired Promise upgrades.
• UpgradeRun: upgrade execution and progress.

See Promise upgrade concepts for the relationship between upgrade plans and runs.

Promise Testing CLI

• kratix test.
• kratix test pipeline.
• kratix test stage.

Portal APIs and plugins

• Portal configuration and bindings.
• PortalCustomization.
• Portal Patch recipes.
• Adapter reference.
• Backstage frontend plugin API.
• Backstage backend plugin API.

See component compatibility for release requirements and prerequisites for download credentials.