Skip to main content
PATCH
/
providers
/
{org}
/
{name}
Update Provider
curl --request PATCH \
  --url https://api.example.com/providers/{org}/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "readme": "<string>",
  "tags": [
    "<string>"
  ],
  "icon_url": "<string>"
}
'
import requests

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

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "readme": "<string>",
    "tags": ["<string>"],
    "icon_url": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    description: '<string>',
    readme: '<string>',
    tags: ['<string>'],
    icon_url: '<string>'
  })
};

fetch('https://api.example.com/providers/{org}/{name}', 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/{org}/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'display_name' => '<string>',
    'description' => '<string>',
    'readme' => '<string>',
    'tags' => [
        '<string>'
    ],
    'icon_url' => '<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/{org}/{name}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"readme\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"icon_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/providers/{org}/{name}")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"readme\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"icon_url\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"readme\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"icon_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "prefix": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "author": {
    "display_name": "<string>",
    "organization_id": "<string>"
  },
  "canonical": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "scope": "public",
  "icon_url": "<string>",
  "readme": "<string>",
  "tags": [
    "<string>"
  ],
  "latest_version": "<string>",
  "install_count": 0
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

org
string
required
name
string
required

Body

application/json

Request model for updating provider metadata.

Only provided (non-None) fields are updated.

Attributes: display_name: Human-readable name for UI display. description: Short description of what the provider does. readme: Long-form documentation in markdown. tags: Searchable tags for categorization. icon_url: URL to provider icon image.

display_name
string | null
Maximum string length: 100
description
string | null
Maximum string length: 500
readme
string | null
Maximum string length: 50000
tags
string[] | null
Maximum array length: 20
icon_url
string | null
Maximum string length: 500

Response

Successful Response

Provider listing in the catalog.

Provider identity is stored as two separate fields: prefix and name. The prefix is an opaque namespace token (either the literal "platform" for catalog providers owned by Pragmatiks or a customer organization slug). The name is the provider's short name (e.g. pragma, gcp). Use :attr:canonical when a display string or URL path is needed.

Identity fields (frozen): prefix: Namespace token ("platform" or a customer org slug). name: Provider short name within the prefix.

Metadata: display_name: Human-readable name for UI display. description: Short description of what the provider does. author: Publishing organization metadata. scope: Visibility scope (public or tenant-only). icon_url: URL to provider icon image. readme: Long-form documentation in markdown. tags: Searchable tags for categorization.

State (system-managed): latest_version: Semver of the most recent published version. install_count: Total number of tenant installations.

prefix
string
required
name
string
required
display_name
string
required
description
string
required
author
ProviderAuthor · object
required

Author metadata for a provider.

kind discriminates between providers owned by Pragmatiks ("platform") and providers owned by a customer organization ("customer"). Platform-owned providers leave organization_id as None; customer-owned providers must populate it.

Attributes: kind: Discriminator between platform and customer ownership. organization_id: Organization ID of the publishing tenant, or None for platform-owned providers. display_name: Human-facing label shown in catalog listings and the web UI.

canonical
string
required
read-only

Slash-joined prefix/name canonical string.

Returns: Display form of the provider identity, used in CLI output, web UI labels, and URL paths.

created_at
string<date-time>
updated_at
string<date-time>
scope
enum<string>
default:public

Scope of a provider in the catalog.

Available options:
public,
tenant
icon_url
string | null
readme
string | null
tags
string[]
latest_version
string | null
install_count
integer
default:0