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

GetInstallerState

Retrieve the current installer state machine status and wizard progress

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • versionInteger

    Schema version of the installer state record

    Example: 1

  • stateString

    Current state of the installer state machine

    Example: configuring

  • currentStepInteger

    Current wizard step index the user is on

    Example: 2

  • depotConnectedBoolean

    Whether a depot connection has been successfully established

    Example: true

  • depotConnectedAtString

    Depot connected at

    Example: 2026-01-15T08:00:00Z

  • wizardConfigObject

    Wizard config

    • 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

  • downloadsLinkedHashMap

    Package download status entries

    Example: (nested object)

    • *Object

      Map value

  • precheckObject

    Precheck for this resource

    • idString

      Unique identifier for this precheck session

      Example: precheck-a1b2c3d4

    • statusString

      Current status of the precheck session

      Example: passed

    • resultsList

      Results for this resource

      Example: (nested array)

      • nameString

        Name of the individual precheck item

        Example: agent-connectivity

      • passedBoolean

        Whether this check item passed

        Example: true

      • messageString

        Human-readable message describing the check result

        Example: All agents are reachable

      • fixString

        Suggested remediation action if the check did not pass

        Example: Ensure all agents have active heartbeats before proceeding

  • deployObject

    Deploy for this resource

    • idString

      Unique identifier for this deploy session

      Example: deploy-a1b2c3d4

    • statusString

      Current status of the deploy session

      Example: running

    • progressInteger

      Overall deployment progress as a percentage from 0 to 100

      Example: 55

    • currentPhaseString

      Name of the currently executing deployment phase

      Example: installing-postgresql

    • currentComponentString

      Name of the component currently being deployed

      Example: postgresql

    • startedAtString

      Started at

      Example: 2026-01-15T08:00:00Z

    • completedAtString

      Completed at

      Example: 2026-01-15T08:00:00Z

    • logsList

      The logs value

      Example: (nested array)

      • timeString

        Timestamp of the log entry in RFC3339 format

        Example: 2026-04-16T10:00:00Z

      • levelString

        Log level of the entry

        Example: INFO

      • messageString

        Log message content

        Example: PostgreSQL installation complete

    • registrationsList

      Registrations for this resource

      Example: (nested array)

      • nameString

        Name of the service being registered with the control plane

        Example: postgresql

      • endpointString

        Network endpoint at which the service is accessible

        Example: 192.168.1.10:5432

      • statusString

        Registration status for this service

        Example: registered

      • registeredAtString

        Registered at

        Example: 2026-01-15T08:00:00Z

      • errorString

        Error message if registration failed

        Example: connection timeout

  • errorString

    Error message if the installer entered a failed state

    Example: SSH connection refused

  • updatedAtString

    Updated at

    Example: 2026-01-15T08:00:00Z

Endpoint

GET/api/v1/installer/state

/api/v1/installer/state

Operation ID

GetInstallerState

Permalink

Request Example

curl -X GET '{host}/api/v1/installer/state' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "version": 1,
  "state": "configuring",
  "currentStep": 2,
  "depotConnected": true,
  "depotConnectedAt": "example",
  "wizardConfig": {},
  "downloads": null,
  "precheck": {}
}

Change History

This API has no change history records yet.

View all change history