Skip to navigation
Air APIAPI ReferenceMarketplace

Create a marketplace demo

View as Markdown

Create a blank marketplace demo. Provided simulation must be in the INACTIVE state. Provided checkpoint must be in the COMPLETE state and must belong to the provided simulation. If not provided, the most recent complete checkpoint will be used. This simulation will be cloned into a new simulation set to DEMO state.

Required scope: air:marketplace_demo_write (roles: air_demo_manager, air_org_admin, air_user)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired1-96 characters
The name of the marketplace demo.
tagslist of stringsRequired

At least one tag name for the demo is required. Each is 2-32 characters; letters, numbers, spaces, hyphens (-), and underscores (_) only; must start and end with a letter or number. Stored lowercased.

simulationstringRequiredformat: "uuid"
Simulation to be used to provision the marketplace demo.
descriptionstring or nullOptional1-256 characters
Description of the marketplace demo.
documentationstring or nullOptional
The raw markdown documentation for the marketplace demo. Pass an empty string to blank the documentation. For backwards compatibility null is accepted and treated as an empty string.
repostring or nullOptionalformat: "uri"<=200 characters
The code repository of the marketplace demo.
publisherstringOptional<=32 characters

The name of the company or organization the marketplace demo is published under (e.g. NVIDIA, Google). Required before a marketplace demo can be published.

iconstring or nullOptional>=1 character

Icon for the marketplace demo as a base64-encoded image data URL (e.g. data:image/png;base64,...), up to 65536 bytes when decoded. Must be one of the following MIME types: image/gif, image/jpeg, image/png, image/svg+xml, image/webp, image/x-icon. Pass null to remove the icon.

checkpointstringOptionalformat: "uuid"

A COMPLETE checkpoint to clone from. Provided checkpoint must belong to the simulation. If not specified, latest COMPLETE checkpoint will be used.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
namestring<=96 characters
The name of the marketplace demo.
creatorstringRead-only

E-mail of the creator of the marketplace demo.

documentationstring or nullRead-only
The raw markdown documentation for the marketplace demo.
tagslist of stringsRead-only
Names of the tags of the marketplace demo.
publishedbooleanRead-only
Whether the marketplace demo is published.
is_owned_by_clientbooleanRead-only

If the marketplace demo is owned by the client. When true, the client can publish or unpublish the demo.

publicly_publishedbooleanRead-only

Whether the marketplace demo is visible to the entire catalog (true only when the demo is in the published catalog AND its publish access record is set to public).

previewbooleanRead-only

Whether the marketplace demo is listed for all authenticated users while provisioning stays allow-list gated. True only when the demo is in the published catalog and its publish access record has preview enabled.

access_request_statusstring or nullRead-only

Status of the caller’s organization’s access request for this demo, if any (REQUESTED, GRANTED, DENIED, REVOKED, CLOSED). Null when the organization has not requested access.

publish_access_record_idstring or nullRead-only

The id of the marketplace demo publish access record. Returned only to the owning organization, Air admins, and SREs; null otherwise.

provision_countintegerRead-only

Number of times a clone has been provisioned from this marketplace demo (counted when the provision request creates the clone; not decremented if that clone later fails to boot).

demostringformat: "uuid"
Demo simulation to be used as a base for cloned simulations.
demo_simulation_statestringRead-only

The state of the simulation instance associated with this demo which acts as the template for all provisioned simulations from this demo. If the demo was successfully created, this value will be DEMO or CLONING.

expected_resource_usageobject
The expected resource usage for the marketplace demo.
descriptionstring or nullOptional<=256 characters
Description of the marketplace demo.
repostring or nullOptionalformat: "uri"<=200 characters
The code repository of the marketplace demo.
publisherstringOptional<=32 characters

The name of the company or organization the marketplace demo is published under (e.g. NVIDIA, Google). Required before a marketplace demo can be published.

featuredbooleanOptional
Whether the marketplace demo is featured. This can be used to help order a group of marketplace demos before others.
orderinteger or nullOptional1-32767
A field used to help order specific marketplace demos before or after other specific marketplace demos.
iconstring or nullOptional<=1048576 characters

Public URL of the marketplace demo icon stored in the publicly-accessible bucket. Legacy rows may still contain raw icon data in data URL format until the icon is next updated.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error