Skip to main content
ZStack
Infrastructure/Installer

SaveWizardProgress

Persist the current wizard step and configuration to allow resuming later

PUT/api/v1/installer/wizard/progress

Operation ID

SaveWizardProgress

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • currentStep
    IntegerRequired

    Wizard step index to save as the current progress point

    Example: 3

  • config
    ObjectRequired

    Configuration data as key-value pairs

    • selectedComponents
      List

      Selected components

      Example: item1,item2

    • instanceName
      String

      Display name for this ZCF installation instance

      Example: my-zcf

    • deployMode
      String

      Deployment topology mode for this installation

      Example: single

    • dns
      List

      The DNS value

      Example: item1,item2

    • ntp
      List

      The ntp value

      Example: item1,item2

    • depotMode
      String

      Package source mode for installation

      Example: online

    • depotBaseUrl
      String

      Base URL of the upstream depot for package downloads

      Example: https://depot.example.com

    • depotToken
      String

      Authentication token for the upstream depot

      Example: ****

    • postgresql
      Object

      Postgresql for this resource

      • node
        Object

        The node value

        • role
          String

          Role of this node in the cluster topology

          Example: primary

        • fqdn
          String

          Fully qualified domain name of this node

          Example: node01.example.com

        • username
          String

          SSH username for connecting to this node

          Example: root

        • password
          String

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPath
          String

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPort
          Integer

          SSH port to connect on

          Example: 22

      • port
        Integer

        Port on which PostgreSQL listens

        Example: 5432

      • password
        String

        PostgreSQL superuser password (sensitive)

        Example: ****

      • image
        String

        Container image reference for the PostgreSQL deployment

        Example: postgres:14-alpine

      • dataDir
        String

        Host directory for PostgreSQL data persistence

        Example: /var/lib/postgresql/data

    • lifecycle
      Object

      Lifecycle for this resource

      • applianceSize
        String

        Appliance resource profile for this lifecycle service instance

        Example: medium

      • nodes
        List

        Nodes for this resource

        Example: (nested array)

        • role
          String

          Role of this node in the cluster topology

          Example: primary

        • fqdn
          String

          Fully qualified domain name of this node

          Example: node01.example.com

        • username
          String

          SSH username for connecting to this node

          Example: root

        • password
          String

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPath
          String

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPort
          Integer

          SSH port to connect on

          Example: 22

      • vip
        String

        Virtual IP address for HA lifecycle service access

        Example: 192.168.1.100

      • adminPassword
        String

        Administrator account password (sensitive)

        Example: ****

      • vipInterface
        String

        Network interface that owns the lifecycle VIP

        Example: ens192

    • idp
      Object

      The idp value

      • applianceSize
        String

        Appliance resource profile for this IDP instance

        Example: small

      • nodes
        List

        Nodes for this resource

        Example: (nested array)

        • role
          String

          Role of this node in the cluster topology

          Example: primary

        • fqdn
          String

          Fully qualified domain name of this node

          Example: node01.example.com

        • username
          String

          SSH username for connecting to this node

          Example: root

        • password
          String

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPath
          String

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPort
          Integer

          SSH port to connect on

          Example: 22

      • vip
        String

        Virtual IP address for HA IDP access

        Example: 192.168.1.101

      • adminPassword
        String

        IDP admin account password (sensitive)

        Example: ****

      • rootPassword
        String

        IDP root account password (sensitive)

        Example: ****

    • extensions
      List

      Extension configuration entries

      Example: (nested array)

      • componentType
        String

        Component type identifier for this extension

        Example: monitoring

      • version
        String

        Version of this extension to install

        Example: 1.2.0

      • applianceSize
        String

        Appliance resource profile for this extension

        Example: small

      • nodes
        List

        Nodes for this resource

        Example: (nested array)

        • role
          String

          Role of this node in the cluster topology

          Example: primary

        • fqdn
          String

          Fully qualified domain name of this node

          Example: node01.example.com

        • username
          String

          SSH username for connecting to this node

          Example: root

        • password
          String

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPath
          String

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPort
          Integer

          SSH port to connect on

          Example: 22

      • vip
        String

        Virtual IP for HA extension access

        Example: 192.168.1.102

      • adminPassword
        String

        Admin password for this extension (sensitive)

        Example: ****

    • cloud
      List

      Cloud management nodes

      Example: (nested array)

      • address
        StringRequired

        IP address or FQDN of the cloud management node

        Example: 192.168.1.50

      • port
        Integer

        SSH port for the cloud management node

        Example: 22

      • user
        StringRequired

        SSH username for the cloud management node

        Example: root

      • password
        String

        SSH password for the cloud management node (sensitive)

        Example: ****

    • env
      LinkedHashMap

      Environment configuration

      Example: (nested object)

    • versionPins
      List

      Version pins for this resource

      Example: (nested array)

      • product
        String

        Product for this resource

        Example: value

      • version
        String

        Version for this resource

        Example: value

      • release
        String

        Release for this resource

        Example: value

    • depotChannel
      String

      Depot channel for this resource

      Example: value

    • placementPins
      List

      Placement pins for this resource

      Example: item1,item2

    • configOverwrite
      Object

      Config overwrite for this resource

      Example: (nested object)

    • noDumpState
      Boolean

      No dump state for this resource

      Example: true

    • licenseServer
      ObjectRequired

      External License Server used by ZCF services

      • host
        StringRequired

        IP address or FQDN of the external License Server

        Example: 172.24.243.148

      • http
        IntegerRequired

        HTTPS API port of the external License Server

        Example: 8201

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • currentStep
    Integer

    Confirmed step index that was saved

    Example: 3

Change History

View all change history

  • Change Time

    AddedRequest body fields host, http, licenseServer
    View API

  • Change Time

    AddedRequest body fields address, userDeletedRequest body fields nodeIp
    View API

  • Change Time

    AddedRequest body fields configOverwrite, depotChannel, noDumpState...
    View API