Skip to main content
API Explorer|API Explorer
Infrastructure/Installer
PUTInstallerSince 1.0SynchronousAuth Required

SaveWizardProgress

Persist the current wizard step and configuration to allow resuming later

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • currentStepIntegerRequired

    Wizard step index to save as the current progress point

    Example: 3

  • configObjectRequired

    Configuration data as key-value pairs

    • selectedComponentsList

      Selected components

      Example: item1,item2

    • instanceNameString

      Display name for this ZCF installation instance

      Example: my-zcf

    • deployModeString

      Deployment topology mode for this installation

      Example: single

    • dnsList

      The DNS value

      Example: item1,item2

    • ntpList

      The ntp value

      Example: item1,item2

    • depotModeString

      Package source mode for installation

      Example: online

    • depotBaseUrlString

      Base URL of the upstream depot for package downloads

      Example: https://depot.example.com

    • depotTokenString

      Authentication token for the upstream depot

      Example: ****

    • postgresqlObject

      Postgresql for this resource

      • nodeObject

        The node value

        • roleString

          Role of this node in the cluster topology

          Example: primary

        • fqdnString

          Fully qualified domain name of this node

          Example: node01.example.com

        • usernameString

          SSH username for connecting to this node

          Example: root

        • passwordString

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPathString

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPortInteger

          SSH port to connect on

          Example: 22

      • portInteger

        Port on which PostgreSQL listens

        Example: 5432

      • passwordString

        PostgreSQL superuser password (sensitive)

        Example: ****

      • imageString

        Container image reference for the PostgreSQL deployment

        Example: postgres:14-alpine

      • dataDirString

        Host directory for PostgreSQL data persistence

        Example: /var/lib/postgresql/data

    • lifecycleObject

      Lifecycle for this resource

      • applianceSizeString

        Appliance resource profile for this lifecycle service instance

        Example: medium

      • nodesList

        Nodes for this resource

        Example: (nested array)

        • roleString

          Role of this node in the cluster topology

          Example: primary

        • fqdnString

          Fully qualified domain name of this node

          Example: node01.example.com

        • usernameString

          SSH username for connecting to this node

          Example: root

        • passwordString

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPathString

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPortInteger

          SSH port to connect on

          Example: 22

      • vipString

        Virtual IP address for HA lifecycle service access

        Example: 192.168.1.100

      • adminPasswordString

        Administrator account password (sensitive)

        Example: ****

    • idpObject

      The idp value

      • applianceSizeString

        Appliance resource profile for this IDP instance

        Example: small

      • nodesList

        Nodes for this resource

        Example: (nested array)

        • roleString

          Role of this node in the cluster topology

          Example: primary

        • fqdnString

          Fully qualified domain name of this node

          Example: node01.example.com

        • usernameString

          SSH username for connecting to this node

          Example: root

        • passwordString

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPathString

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPortInteger

          SSH port to connect on

          Example: 22

      • vipString

        Virtual IP address for HA IDP access

        Example: 192.168.1.101

      • adminPasswordString

        IDP admin account password (sensitive)

        Example: ****

      • rootPasswordString

        IDP root account password (sensitive)

        Example: ****

    • extensionsList

      Extension configuration entries

      Example: (nested array)

      • componentTypeString

        Component type identifier for this extension

        Example: monitoring

      • versionString

        Version of this extension to install

        Example: 1.2.0

      • applianceSizeString

        Appliance resource profile for this extension

        Example: small

      • nodesList

        Nodes for this resource

        Example: (nested array)

        • roleString

          Role of this node in the cluster topology

          Example: primary

        • fqdnString

          Fully qualified domain name of this node

          Example: node01.example.com

        • usernameString

          SSH username for connecting to this node

          Example: root

        • passwordString

          SSH password for connecting to this node (sensitive)

          Example: ****

        • sshKeyPathString

          Path to SSH private key for key-based authentication

          Example: /root/.ssh/id_rsa

        • sshPortInteger

          SSH port to connect on

          Example: 22

      • vipString

        Virtual IP for HA extension access

        Example: 192.168.1.102

      • adminPasswordString

        Admin password for this extension (sensitive)

        Example: ****

    • cloudObject

      Cloud for this resource

      • nodeIpString

        IP address of the cloud management node

        Example: 192.168.1.50

      • usernameString

        Username for accessing the cloud management node

        Example: admin

      • passwordString

        Password for accessing the cloud management node (sensitive)

        Example: ****

    • envLinkedHashMap

      Environment configuration

      Example: (nested object)

    • versionPinsList

      Version pins for this resource

      Example: (nested array)

      • productString

        Product for this resource

        Example: value

      • versionString

        Version for this resource

        Example: value

      • releaseString

        Release for this resource

        Example: value

Responses

200 OK

On success, this API returns the following response structure.

  • currentStepInteger

    Confirmed step index that was saved

    Example: 3

Endpoint

PUT/api/v1/installer/wizard/progress

/api/v1/installer/wizard/progress

Operation ID

SaveWizardProgress

Permalink

Request Example

curl -X PUT '{host}/api/v1/installer/wizard/progress' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"currentStep":3,"config":{"selectedComponents":"item1,item2","instanceName":"my-zcf","deployMode":"single","dns":"item1,item2","ntp":"item1,item2","depotMode":"online","depotBaseUrl":"https://depot.example.com","depotToken":"****","postgresql":{"node":{"role":"primary","fqdn":"node01.example.com","username":"root","password":"****","sshKeyPath":"/root/.ssh/id_rsa","sshPort":22},"port":5432,"password":"****","image":"postgres:14-alpine","dataDir":"/var/lib/postgresql/data"},"lifecycle":{"applianceSize":"medium","nodes":"(nested array)","vip":"192.168.1.100","adminPassword":"****"},"idp":{"applianceSize":"small","nodes":"(nested array)","vip":"192.168.1.101","adminPassword":"****","rootPassword":"****"},"extensions":"(nested array)","cloud":{"nodeIp":"192.168.1.50","username":"admin","password":"****"},"env":"(nested object)","versionPins":"(nested array)"}}'

Response Example

200
{
  "currentStep": 3
}

Change History

This API has no change history records yet.

View all change history