Files
sdk/docs/ClusterApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

7.6 KiB

ClusterApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
paasAddClusterDomain POST /v1/paas/cluster/domains Add cluster domain
paasGetClusterInfo GET /v1/paas/cluster/info Get cluster info
paasGetSetupStatus GET /v1/paas/cluster/setup-status Check cluster setup status
paasListClusterDomains GET /v1/paas/cluster/domains List cluster domains
paasRemoveClusterDomain DELETE /v1/paas/cluster/domains/{domain} Remove cluster domain
platformClusterGetNodes GET /v1/platform/cluster/getNodes List Docker Swarm nodes

paasAddClusterDomain

kotlin.Any paasAddClusterDomain(flowCreateCustomDomainRequest)

Add cluster domain

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
val flowCreateCustomDomainRequest : FlowCreateCustomDomainRequest =  // FlowCreateCustomDomainRequest | 
try {
    val result : kotlin.Any = apiInstance.paasAddClusterDomain(flowCreateCustomDomainRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#paasAddClusterDomain")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#paasAddClusterDomain")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
flowCreateCustomDomainRequest FlowCreateCustomDomainRequest

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

paasGetClusterInfo

PaasCluster paasGetClusterInfo()

Get cluster info

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
try {
    val result : PaasCluster = apiInstance.paasGetClusterInfo()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#paasGetClusterInfo")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#paasGetClusterInfo")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PaasCluster

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

paasGetSetupStatus

PaasGetSetupStatus200Response paasGetSetupStatus()

Check cluster setup status

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
try {
    val result : PaasGetSetupStatus200Response = apiInstance.paasGetSetupStatus()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#paasGetSetupStatus")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#paasGetSetupStatus")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PaasGetSetupStatus200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

paasListClusterDomains

kotlin.collections.List<kotlin.String> paasListClusterDomains()

List cluster domains

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
try {
    val result : kotlin.collections.List<kotlin.String> = apiInstance.paasListClusterDomains()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#paasListClusterDomains")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#paasListClusterDomains")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<kotlin.String>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

paasRemoveClusterDomain

kotlin.Any paasRemoveClusterDomain(domain)

Remove cluster domain

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
val domain : kotlin.String = domain_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.paasRemoveClusterDomain(domain)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#paasRemoveClusterDomain")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#paasRemoveClusterDomain")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
domain kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

platformClusterGetNodes

PlatformTRPCResult platformClusterGetNodes(input)

List Docker Swarm nodes

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ClusterApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
    val result : PlatformTRPCResult = apiInstance.platformClusterGetNodes(input)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ClusterApi#platformClusterGetNodes")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ClusterApi#platformClusterGetNodes")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
input kotlin.String URL-encoded JSON input for tRPC queries [optional]

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json