Skip to main content
POST
/
providers
/
installed
/
{org}
/
{name}
/
downgrade
Downgrade Provider
curl --request POST \
  --url https://api.example.com/providers/installed/{org}/{name}/downgrade \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_version": "<string>"
}
'
import requests

url = "https://api.example.com/providers/installed/{org}/{name}/downgrade"

payload = { "target_version": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({target_version: '<string>'})
};

fetch('https://api.example.com/providers/installed/{org}/{name}/downgrade', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/providers/installed/{org}/{name}/downgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target_version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/providers/installed/{org}/{name}/downgrade"

	payload := strings.NewReader("{\n  \"target_version\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/providers/installed/{org}/{name}/downgrade")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_version\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/providers/installed/{org}/{name}/downgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target_version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "prefix": "<string>",
  "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",
  "canonical": "<string>",
  "current_version": "<string>",
  "upgrade_policy": "manual",
  "resource_tier": "standard",
  "config": {},
  "health_message": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
org
string
required
​
name
string
required

Body

application/json

Request model for downgrading an installed store provider.

Attributes: target_version: Target version to downgrade to (required).

​
target_version
string
required

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. 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. 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
​
resource_tier
enum<string>
default:standard

Resource allocation tier for an installed provider.

Available options:
free,
standard,
performance
​
config
Config · object | null
​
health_message
string | null