Skip to content

Extensions

19 methods on the Extensions resource.

19 methods · 0 available to app tokens36 pages in SDK Reference

OpenAI Open in ChatGPTClaude Open in ClaudeGitHub Invertocat
import { Compozy } from "@compozy/client";

19 of 19

deleteExtensionSecret

Remove one extension environment secret binding

compozy.extensions.deleteExtensionSecret({ path, query }) → Promise<void>

Options

namestringpathrequired
Extension name
env_namestringpathrequired
Declared environment name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Act as this profile by name

DELETE /api/extensions/{name}/secrets/{env_name}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.deleteExtensionSecret({ path: { "name": "name", "env_name": "env_name" } });

devExtension

Link an immutable extension generation to the resolved workspace

compozy.extensions.devExtension({ query, body }) → Promise<ExtensionResponse>

Options

workspacestringquery
Operator workspace reference; agent callers use trusted session scope
profilestringquery
Act as this profile by name

Request bodyDevLinkExtensionRequest

POST /api/extensions/devapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.devExtension({ body: { /* request fields */ } });

getExtension

Get one installed extension

compozy.extensions.getExtension({ path, query }) → Promise<ExtensionResponse>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Profile whose effective extension state is returned

GET /api/extensions/{name}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.getExtension({ path: { "name": "name" } });

getExtensionInventory

List shipped and live resources for one extension

compozy.extensions.getExtensionInventory({ path, query }) → Promise<ExtensionInventoryPayload>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Profile whose effective extension state is returned

GET /api/extensions/{name}/inventoryapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.getExtensionInventory({ path: { "name": "name" } });

getExtensionLogs

Read or follow redacted extension logs

compozy.extensions.getExtensionLogs({ path, query }) → Promise<ExtensionLogsResponse>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Profile name; omit for the default profile
followstringquery
Stream extension_log deltas and atomic extension_log_reset snapshots
afterstringquery
Return entries after this sequence within stream_epoch
stream_epochstringquery
Opaque ring identity; required when after is greater than zero

GET /api/extensions/{name}/logsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.getExtensionLogs({ path: { "name": "name" } });

getExtensionProvenance

Get extension provenance and trust evidence

compozy.extensions.getExtensionProvenance({ path, query }) → Promise<ExtensionProvenanceResponse>

Options

namestringpathrequired
Extension name
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/extensions/{name}/provenanceapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.getExtensionProvenance({ path: { "name": "name" } });

installExtension

Install a local or marketplace extension

compozy.extensions.installExtension({ query, body }) → Promise<InstallExtensionResponse>

Options

profilestringquery
Act as this profile by name

Request bodyInstallExtensionRequestWritable

POST /api/extensionsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.installExtension({ body: { /* request fields */ } });

listExtensionCommands

List active extension-contributed commands

compozy.extensions.listExtensionCommands({ query }) → Promise<ExtensionCommandsResponse>

Options

extensionstringquery
Filter by exact extension name
workspacestringquery
Operator workspace reference; agent callers use trusted session scope
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/extensions/commandsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.listExtensionCommands();

listExtensionEnablement

List one extension's effective state for every profile

compozy.extensions.listExtensionEnablement({ path, query }) → Promise<Array<ExtensionEnablementPayload>>

Options

namestringpathrequired
Extension name
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/extensions/{name}/enablementapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.listExtensionEnablement({ path: { "name": "name" } });

listExtensionSecrets

List declared and bound extension environment names

compozy.extensions.listExtensionSecrets({ path, query }) → Promise<ExtensionSecretsPayload>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/extensions/{name}/secretsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.listExtensionSecrets({ path: { "name": "name" } });
Show all 19 methods

listExtensions

List installed extensions

compozy.extensions.listExtensions({ query }) → Promise<ExtensionsResponse>

Options

workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Profile whose effective extension state is returned

GET /api/extensionsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.listExtensions();

previewExtensionEnable

Preview one extension enablement change

compozy.extensions.previewExtensionEnable({ path, query }) → Promise<ExtensionEnablePreviewPayload>

Options

namestringpathrequired
Extension name
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/extensions/{name}/previewapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.previewExtensionEnable({ path: { "name": "name" } });

previewExtensionInstall

Preview an extension install without changing state

compozy.extensions.previewExtensionInstall({ query, body }) → Promise<ExtensionInstallPreviewPayload>

Options

profilestringquery
Act as this profile by name

Request bodyInstallExtensionRequestWritable

POST /api/extensions/preview-installapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.previewExtensionInstall({ body: { /* request fields */ } });

reloadDevExtension

Reload a workspace extension from an immutable generation

compozy.extensions.reloadDevExtension({ path, query, body }) → Promise<ExtensionResponse>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; agent callers use trusted session scope
profilestringquery
Act as this profile by name

Request bodyReloadExtensionRequest

POST /api/extensions/{name}/reloadapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.reloadDevExtension({ path: { "name": "name" }, body: { /* request fields */ } });

removeExtension

Remove one managed extension

compozy.extensions.removeExtension({ path, query }) → Promise<ExtensionRemoveResponse>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Act as this profile by name

DELETE /api/extensions/{name}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.removeExtension({ path: { "name": "name" } });

setExtensionEnablement

Set one extension's effective state for a profile

compozy.extensions.setExtensionEnablement({ path, query, body }) → Promise<ExtensionEnablementPayload>

Options

namestringpathrequired
Extension name
profilestringquery
Act as this profile by name

Request bodySetExtensionEnablementRequest

PUT /api/extensions/{name}/enablementapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.setExtensionEnablement({ path: { "name": "name" }, body: { /* request fields */ } });

setExtensionSecrets

Set or bind extension environment secrets

compozy.extensions.setExtensionSecrets({ path, query, body }) → Promise<ExtensionSecretsPayload>

Options

namestringpathrequired
Extension name
workspacestringquery
Operator workspace reference; omit for the global instance
profilestringquery
Act as this profile by name

Request bodySetExtensionSecretsRequest

PUT /api/extensions/{name}/secretsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.setExtensionSecrets({ path: { "name": "name" }, body: { /* request fields */ } });

updateExtension

Update one marketplace-installed extension

compozy.extensions.updateExtension({ path, query, body }) → Promise<ExtensionUpdateResponse>

Options

namestringpathrequired
Extension name
profilestringquery
Act as this profile by name

Request bodyUpdateExtensionRequestWritable

PUT /api/extensions/{name}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.updateExtension({ path: { "name": "name" }, body: { /* request fields */ } });

updateExtensions

Update installed extensions and report each outcome

compozy.extensions.updateExtensions({ query, body }) → Promise<ExtensionUpdateBatchResponse>

Options

profilestringquery
Act as this profile by name

Request bodyUpdateExtensionsRequestWritable

POST /api/extensions/updateapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.extensions.updateExtensions({ body: { /* request fields */ } });