Skip to main content
Infrastructure/Installer

GetDeployRegistrations

Retrieve the service registration results for a completed deployment

GET/api/v1/installer/deploy/registrations

Operation ID

GetDeployRegistrations

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • deployId
    String

    ID of the deploy session these registrations belong to

    Example: deploy-a1b2c3d4

  • status
    String

    Overall registration status for this deployment

    Example: completed

  • items
    List

    Collection of result items

    Example: (nested array)

    • name
      String

      Name of the service being registered with the control plane

      Example: postgresql

    • endpoint
      String

      Network endpoint at which the service is accessible

      Example: 192.168.1.10:5432

    • status
      String

      Registration status for this service

      Example: registered

    • registeredAt
      String

      Registered at

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

    • error
      String

      Error message if registration failed

      Example: connection timeout