Marketplace
9 methods on the Marketplace resource.
9 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";9 of 9
addMarketplaceSourcegetMarketplaceCatalogEntrygetMarketplaceSectionslistMarketplacelistMarketplaceSourcesrefreshMarketplaceCatalogrefreshMarketplaceSourceremoveMarketplaceSourceupdateMarketplaceSource
addMarketplaceSource
Validate or register a plugin marketplace source
compozy.marketplace.addMarketplaceSource({ query, body }) → Promise<AddMarketplaceSourceResponse>
Options
- dry_runbooleanquery
- Inspect packages without registering the source
Request bodyAddMarketplaceSourceRequest
POST /api/marketplace/sourcesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.addMarketplaceSource({ body: { /* request fields */ } });getMarketplaceCatalogEntry
Get a catalog entry or an explicitly selected installed extension
compozy.marketplace.getMarketplaceCatalogEntry({ path, query }) → Promise<MarketplaceEntryResponse>
Options
- sourcestringquery
- Catalog source name; omitted searches the CompozyOS catalog, then registration order
- entry_idstringpathrequired
- Stable URL-safe marketplace entry id
- installed_namestringquery
- Exact installed extension identity
- scope"global" | "profile" | "workspace"query
- Installed-state projection scope
- profilestringquery
- Required for profile installed-state projection
- workspace_idstringquery
- Required for workspace installed-state projection
GET /api/marketplace/entries/{entry_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.getMarketplaceCatalogEntry({ path: { "entry_id": "entry_id" } });getMarketplaceSections
Browse Featured and category sections
compozy.marketplace.getMarketplaceSections({ query }) → Promise<MarketplaceSectionsResponse>
Options
- qstringquery
- Optional catalog search query
- per_sectionintegerquery
- Entries per section from 1 to 12; default 6
- scope"global" | "profile" | "workspace"query
- Installed-state projection scope
- profilestringquery
- Required for profile scope
- workspace_idstringquery
- Required for workspace scope
GET /api/marketplace/sectionsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.getMarketplaceSections();listMarketplace
List the extension catalog with source state and a content revision
compozy.marketplace.listMarketplace({ query }) → Promise<MarketplaceListResponse>
Options
- qstringquery
- Optional catalog search query
- categorystringquery
- Optional CompozyOS category id
- limitintegerquery
- Maximum results from 1 to 100
- cursorstringquery
- Opaque next_cursor from the previous page
- scope"global" | "profile" | "workspace"query
- Installed-state projection scope
- profilestringquery
- Required for profile installed-state projection
- workspace_idstringquery
- Required for workspace installed-state projection
GET /api/marketplaceapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.listMarketplace();listMarketplaceSources
List global plugin marketplace sources
compozy.marketplace.listMarketplaceSources() → Promise<MarketplaceSourcesResponse>
GET /api/marketplace/sourcesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.listMarketplaceSources();refreshMarketplaceCatalog
Refresh the extension catalog
compozy.marketplace.refreshMarketplaceCatalog() → Promise<MarketplaceRefreshResponse>
POST /api/marketplace/refreshapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.refreshMarketplaceCatalog();refreshMarketplaceSource
Refresh one enabled marketplace source
compozy.marketplace.refreshMarketplaceSource({ path }) → Promise<MarketplaceSourceResponse>
Options
- namestringpathrequired
- Registered source name
POST /api/marketplace/sources/{name}/refreshapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.refreshMarketplaceSource({ path: { "name": "name" } });removeMarketplaceSource
Remove a custom source without removing installed extensions
compozy.marketplace.removeMarketplaceSource({ path }) → Promise<void>
Options
- namestringpathrequired
- Custom source name
DELETE /api/marketplace/sources/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.removeMarketplaceSource({ path: { "name": "name" } });updateMarketplaceSource
Enable or disable a plugin marketplace source
compozy.marketplace.updateMarketplaceSource({ path, body }) → Promise<MarketplaceSourceResponse>
Options
- namestringpathrequired
- Registered source name
Request bodyUpdateMarketplaceSourceRequest
PATCH /api/marketplace/sources/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.marketplace.updateMarketplaceSource({ path: { "name": "name" }, body: { /* request fields */ } });