Skip to main content
POST
Install Provider

Body

application/json

Request model for installing a store provider.

Attributes: provider_name: Store provider name to install (org/name format). version: Specific version to install (None = latest published). upgrade_policy: How upgrades should be handled. config: Environment variables passed only to this provider's child process.

provider_name
string
required
Required string length: 1 - 200
version
string | null
upgrade_policy
enum<string>
default:manual

How a tenant wants installed providers to be upgraded.

Available options:
auto,
manual
config
Config · object | null

Response

Successful Response

Public-facing response model for a provider installation.

Excludes internal infrastructure fields (deployment_name, service_name, current_image) that are not meaningful to API consumers.

Attributes: prefix: Namespace token of the installed provider. name: Provider short name within the prefix. installed_version: Semver of the currently installed version. current_version: Version currently deployed (None if never deployed). upgrade_policy: Whether upgrades are applied automatically or manually. config: Environment variables passed only to this provider's child process. installed_at: Timestamp when the provider was first installed. created_at: Creation timestamp. updated_at: Last update timestamp. lifecycle_state: Deploy lifecycle state of the installation (PENDING/PROCESSING/READY/FAILED/DELETING). health: Rolling reachability signal (healthy or degraded). Independent of lifecycle_state. health_message: Optional detail string for the last health transition; None when healthy or unset.

prefix
string
required
name
string
required
installed_version
string
required
installed_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
lifecycle_state
enum<string>
required

Lifecycle state of a ProviderInstallation.

Mirrors the resource lifecycle pattern: a single linear state owned by the installation row that platform workers transition forward. Distinct from :class:DeploymentStatus, which reflects the observed state of the underlying kubernetes Deployment.

States: PENDING: Installation row created; no deploy attempt yet. PROCESSING: Deploy in flight (artifact apply or upgrade running). READY: Provider self-registered and is reachable. FAILED: Deploy or registration failed terminally. DELETING: Uninstall in progress; row will be removed when done.

Available options:
pending,
processing,
ready,
failed,
deleting
health
enum<string>
required
Available options:
healthy,
degraded
canonical
string
required
read-only

Slash-joined prefix/name canonical string of the owning provider.

Returns: Display form of the provider identity this installation targets.

current_version
string | null
upgrade_policy
enum<string>
default:manual

How a tenant wants installed providers to be upgraded.

Available options:
auto,
manual
config
Config · object | null
health_message
string | null