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

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

payload = { "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({version: '<string>'})
};

fetch('https://api.example.com/providers/installed/{org}/{name}/deploy', 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}/deploy",
  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([
    '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}/deploy"

	payload := strings.NewReader("{\n  \"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}/deploy")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "deployment_name": "<string>",
  "available_replicas": 0,
  "ready_replicas": 0,
  "image": "<string>",
  "version": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "message": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
org
string
required
​
name
string
required

Body

application/json
​
version
string | null

Response

Successful Response

Internal result of a deployment status query from Kubernetes.

Contains all K8s-specific details. Use ProviderStatus for external API.

Attributes: deployment_name: Name of the Kubernetes Deployment. status: Current deployment status. available_replicas: Number of available replicas. ready_replicas: Number of ready replicas. image: Container image reference (e.g., registry/image:version). version: CalVer version string of deployed build. updated_at: Last update timestamp from deployment conditions. message: Status message or error details.

​
deployment_name
string
required
​
status
enum<string>
required

Status of a provider deployment.

Available options:
pending,
progressing,
available,
failed
​
available_replicas
integer
default:0
​
ready_replicas
integer
default:0
​
image
string | null
​
version
string | null
​
updated_at
string<date-time> | null
​
message
string | null