Skip to main content
POST
/
providers
/
install
Install Provider
curl --request POST \
  --url https://api.example.com/providers/install \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_name": "<string>",
  "version": "<string>",
  "resource_tier": "standard",
  "upgrade_policy": "manual",
  "config": {}
}
'
{
  "provider_name": "<string>",
  "installed_version": "<string>",
  "installed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "current_version": "<string>",
  "upgrade_policy": "manual",
  "resource_tier": "standard",
  "config": {}
}

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). resource_tier: Resource allocation tier for the deployment. upgrade_policy: How upgrades should be handled. config: Key-value pairs injected as environment variables on the deployment.

​
provider_name
string
required
Required string length: 1 - 200
​
version
string | null
​
resource_tier
enum<string>
default:standard

Resource allocation tier for an installed provider.

Available options:
free,
standard,
performance
​
upgrade_policy
enum<string>
default:manual

How a tenant wants installed providers to be upgraded.

Available options:
auto,
manual
​
config
Config · object

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: provider_name: Name of the installed provider. 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. resource_tier: Resource allocation tier for the provider. config: Key-value pairs injected as environment variables on the deployment. installed_at: Timestamp when the provider was first installed. created_at: Creation timestamp. updated_at: Last update timestamp.

​
provider_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
​
current_version
string | null
​
upgrade_policy
enum<string>
default:manual

How a tenant wants installed providers to be upgraded.

Available options:
auto,
manual
​
resource_tier
enum<string>
default:standard

Resource allocation tier for an installed provider.

Available options:
free,
standard,
performance
​
config
Config · object