Skip to main content
PATCH
Update Provider

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 "pragmatiks" 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 ("pragmatiks" 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.

Every provider is owned by exactly one publishing organization, identified by organization_id. First-party providers are owned by the reserved pragmatiks organization; customer providers are owned by the publishing tenant's organization.

Attributes: organization_id: Organization ID of the publishing tenant. 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