Skip to main content
GET
/
providers
/
installed
List Installed
curl --request GET \
  --url https://api.example.com/providers/installed
import requests

url = "https://api.example.com/providers/installed"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/providers/installed', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.example.com/providers/installed"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/providers/installed")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/providers/installed")

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

request = Net::HTTP::Get.new(url)

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>"
  }
]

Response

200 - application/json

Successful Response

​
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