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

GetDeployStatus

Poll the overall deployment status and progress of the current deploy session

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.

  • statusString

    Current deployment status

    Example: running

  • sessionObject

    Session 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

Endpoint

GET/api/v1/installer/deploy/status

/api/v1/installer/deploy/status

Operation ID

GetDeployStatus

Permalink

Request Example

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

Response Example

200
{
  "status": "running",
  "session": {}
}

Change History

This API has no change history records yet.

View all change history