NUnugen
BYOC

Get Cluster Health

Provisioning progress and health for one environment.

Path Parameters:

  • cluster_id: The environment to check

Returns:

  • cluster_id, cluster_name, mode
  • status: Provisioning status
  • message: What the status means
  • created_at: When the request was received

Raises:

  • 404: If the environment is not found or does not belong to you
get/api/v3/byoc/clusters/{cluster_id}/status

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Path parameters

cluster_idstring required

ID of the BYOC cluster, returned when it was registered

Response

Current status of a bring your own cloud environment.

cluster_idstring required

Identifier of this environment.

cluster_namestring required

Name given to the environment.

mode'managed_provisioning' | 'cluster_import' required

managed_provisioning or cluster_import.

statusstring required

Provisioning status.

messagestring required

Human-readable status detail.

created_atstring date-time nullable

When the request was received.

Changes

No recorded changes to this operation across all 1 revision of this API.