Skip to content

Support

3 methods on the Support resource.

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

import { Compozy } from "@compozy/client";

3 of 3

createSupportBundle

Create a support bundle

compozy.support.createSupportBundle({ body }) → Promise<SupportBundleOperationResponse>

Request bodyCreateSupportBundleRequest

POST /api/support/bundlesapp tokens denied

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

downloadSupportBundle

Download a completed support bundle archive

compozy.support.downloadSupportBundle({ path }) → Promise<Blob | File>

Options

operation_idstringpathrequired
Support bundle operation id

GET /api/support/bundles/{operation_id}/downloadapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.support.downloadSupportBundle({ path: { "operation_id": "operation_id" } });

getSupportBundle

Get support bundle operation status

compozy.support.getSupportBundle({ path }) → Promise<SupportBundleOperationResponse>

Options

operation_idstringpathrequired
Support bundle operation id

GET /api/support/bundles/{operation_id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.support.getSupportBundle({ path: { "operation_id": "operation_id" } });