Marketplace Demos
Create
A marketplace demo is created from an existing simulation, which becomes the
template that gets cloned each time someone provisions the demo. By default the latest
COMPLETE checkpoint of that simulation is used; pass checkpoint to pin a specific
one.
Get
Retrieve a single marketplace demo by ID. The model exposes several fields worth calling out:
demo— foreign key to the templateSimulation(lazily resolved).demo_simulation_state— state of that template simulation (DEMO,CLONING,INVALID).published/publicly_published— whether the demo is published, and whether it is published catalog-wide vs. restricted to an allow-list.publish_access_record_id— the active publish access record, if any.featured/order— control default catalog ordering (see Featuring & ordering).provision_count— how many clones have been provisioned from this demo.
List / Filter / Search
list() returns an iterator of MarketplaceDemo objects (paginated automatically).
Pass query parameters to filter, order, or search. Convert to a list to work with all
results at once, or iterate lazily.
Update
Update the editable metadata on a demo: name, description, documentation,
repo, tags, and icon. Fields like creator, demo, and published are
read-only. You can update via the model instance or via the endpoint API.
Provision
Provisioning clones the demo’s template simulation into a brand-new Simulation that
belongs to you. Each successful provision increments the demo’s provision_count.
Preview Demos & Access Requests
A preview demo is listed for every authenticated user, but only the orgs on its
allow-list can provision it. Check can_provision before provisioning: when it is
False, provision() is rejected with a 403, and your org can request access instead.
Each org has one request per demo, and requesting again updates it.
access_request_status shows where your org’s request stands (None until you ask).
How a demo is published in preview mode is covered in the Publishing examples.
Tags
Tags are managed through api.marketplace_demo_tags. Each MarketplaceDemoTag has an
is_public flag indicating whether the tag is visible catalog-wide. A tag also exposes
a marketplace_demos property that reverse-lists the demos assigned that tag.
Featuring & Ordering (Privileged)
These management actions require elevated (SRE/ADMIN) privileges.
manage(featured=..., order=...)sets whether a demo is featured and its ordering value. Featured demos sort before non-featured ones, and lowerordervalues sort first. Passorder=Noneto clear a demo’s order.tighten_order()is a collection-level action that re-numbers the populatedordervalues to be consecutive starting at 1 (e.g.[1, 5, 20] -> [1, 2, 3]), preserving relative ordering. Demos withorder=Noneare left untouched.
Reviewing Access Requests (Privileged)
Admins review access requests through api.marketplace_demo_access_requests. Accepting
a request adds the requesting org to the demo’s allow-list so its users can provision
the demo. Denying it records an optional denial_reason that the requester can read.
Delete
Delete a marketplace demo. This removes the demo entry; it does not delete the underlying template simulation.