Sign in

v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
UI Extensions Config Operations

Get a single custom UI extension

Get a single UI extension which is managed through the Integrations Library by its ID. The response will not include UI extensions which are not managed through the Integrations Library, such as legacy product pickers.

get/{id}

Path parameters

idstring required

ID of the extension. Must be unique and only contain alphanumeric characters

Response

OK

idstring

ID of a UI extension

displayNamestring required

Display name of the extension

urlstring required

The URL on which the extension is served

configstring required

JSON string to configure the Open UI extension

extensionPoint'document.field' | 'channel.page.tools' | 'unknown' required

The type of extension point. For extensions on content-type fields, this is always 'document.field'

heightinteger

The initial height of the iframe in pixels (default is 60)

descriptionstring

Description of the extension

logostring

Logo (Icon) of the extension. Should be a base64 string representation of the image

packagestring

The relative path of the UI Extensions Package where this extension is installed from, e.g. bynder/v1

connect-srcstring[]

URLs for external systems that need to be called by an extension

frame-ancestorsstring[]

URLs for external systems that need to be loaded in child iframes by an extension

frame-srcstring[]

URLs for external servers that host extensions

img-srcstring[]

URLs for external systems that host images used or exposed by extensions

script-srcstring[]

URLs for external systems that host scripts used by extensions

style-srcstring[]

URLs for external systems that host styles used by extensions

font-srcstring[]

URLs for external systems that host fonts used by extensions

media-srcstring[]

URLs for external systems that host media used by extensions

All 83 operations