v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
enterprisePortal

Get an install options record

Retrieve the installation options that describe the installation configured for a customers install via the Enterprise Portal or API. Optionally include generated install instructions by setting the includeInstructions query parameter to true.

get/app/{app_id}/enterprise-portal/install-options/{option_id}

Path parameters

app_idstring required

App identifier

option_idstring required

The ID for a customer install options record (returned from create install options)

Query parameters

includeInstructionsboolean

Whether to include install instructions in the response

Response

GetInstallOptionsResponse contains the response from getting install options.

admin_console_urlstring
assets_downloaded_atstring date-time

New fields for tracking installation progress

channel_idstring
channel_release_sequenceinteger
customer_idstring
idstring
images_pulled_atstring date-time
install_typestring
installation_completed_atstring date-time
instance_idstring
instance_namestring
is_multi_nodeboolean
kubernetes_distributionstring
license_idstring
network_availabilitystring
os_distrostring
os_versionstring
registry_authenticated_atstring date-time
registry_availabilitystring
service_account_idstring
started_atstring date-time
statusstring