Skip to main content
POST
Analyze Bundle

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Analyze a bundle into an import preview.

Provide exactly one of source (pasted text) or source_url (a URL the server fetches behind the SSRF guard). source_url is what a landing-page deep-link (/bundles/import?src=<url>) uses for one-click installs.

source
string | null

Raw bundle source text (YAML or JSON).

source_url
string | null

URL to fetch raw bundle source from (YAML or JSON).

Response

Successful Response

What the wizard renders before the user commits to installing.

bundle
Bundle · object
required

The canonical, fully-inlined package object.

installable
boolean
required

True when there are no blocking issues (setup may still be required).

entities
PreviewEntity · object[]
issues
PreviewIssue · object[]
setup
SetupField · object[]