DocumentationSupport
API Reference
Log In

Create an installation options record

post
https://api.replicated.com/vendor/v3/app//enterprise-portal/install-options

Create an installation options record for a customer describing the installation configuration. Automatically creating a service account for the installation that can be used to perform the actual installation. Optionally include generated install instructions by setting the includeInstructions query parameter to true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App identifier

Query Params
boolean

Whether to include install instructions in the response

Body Params

JSON input

string

URL for the admin console, used for updates

string
required

Channel ID to use for the installation

int64
required

Channel release sequence number to use for the installation

string
required

The customer ID for which to create install options

string
enum
required

Type of installation

Allowed:
string
required

Name of the installation instance, also used as service account name - must be unique per customer

boolean

Whether this is a multi-node installation (only applicable for linux install type)

string
enum

Kubernetes distribution that will be used for the helm installation (only applicable for helm install type)

Allowed:
string
enum
required

Network availability for the installation environment

Allowed:
string
enum

Registry availability for helm installations (only applicable for helm install type)

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago