Files
sdk/docs/ServerApi.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

16 KiB

ServerApi

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

Method HTTP request Description
platformServerAll GET /v1/platform/server/all List all servers with service counts
platformServerCreate POST /v1/platform/server/create Register a new remote server
platformServerGetServerMetrics GET /v1/platform/server/getServerMetrics Fetch server metrics (CPU, memory, disk, network)
platformServerOne GET /v1/platform/server/one Get server details
platformServerPublicIp GET /v1/platform/server/publicIp Get platform host public IP
platformServerRemove POST /v1/platform/server/remove Remove a server (must have no active services)
platformServerSecurity GET /v1/platform/server/security Run security audit (ufw, ssh, fail2ban)
platformServerSetup POST /v1/platform/server/setup Run initial setup (install Docker, Traefik, etc.)
platformServerSetupMonitoring POST /v1/platform/server/setupMonitoring Configure and deploy monitoring agent
platformServerUpdate POST /v1/platform/server/update Update server configuration
platformServerValidate GET /v1/platform/server/validate Validate server capabilities

platformServerAll

PlatformTRPCResult platformServerAll()

List all servers with service counts

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerCreate

PlatformTRPCResult platformServerCreate(platformServerCreateRequest)

Register a new remote server

Example

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

val apiInstance = ServerApi()
val platformServerCreateRequest : PlatformServerCreateRequest =  // PlatformServerCreateRequest | 
try {
    val result : PlatformTRPCResult = apiInstance.platformServerCreate(platformServerCreateRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
platformServerCreateRequest PlatformServerCreateRequest

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerGetServerMetrics

PlatformTRPCResult platformServerGetServerMetrics(input)

Fetch server metrics (CPU, memory, disk, network)

Example

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

val apiInstance = ServerApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
    val result : PlatformTRPCResult = apiInstance.platformServerGetServerMetrics(input)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerGetServerMetrics")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerGetServerMetrics")
    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

platformServerOne

PlatformTRPCResult platformServerOne(input)

Get server details

Example

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

val apiInstance = ServerApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
    val result : PlatformTRPCResult = apiInstance.platformServerOne(input)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerOne")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerOne")
    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

platformServerPublicIp

PlatformTRPCResult platformServerPublicIp()

Get platform host public IP

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerRemove

PlatformTRPCResult platformServerRemove(platformServerRemoveRequest)

Remove a server (must have no active services)

Example

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

val apiInstance = ServerApi()
val platformServerRemoveRequest : PlatformServerRemoveRequest =  // PlatformServerRemoveRequest | 
try {
    val result : PlatformTRPCResult = apiInstance.platformServerRemove(platformServerRemoveRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerRemove")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerRemove")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
platformServerRemoveRequest PlatformServerRemoveRequest

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerSecurity

PlatformTRPCResult platformServerSecurity(input)

Run security audit (ufw, ssh, fail2ban)

Example

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

val apiInstance = ServerApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
    val result : PlatformTRPCResult = apiInstance.platformServerSecurity(input)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerSecurity")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerSecurity")
    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

platformServerSetup

PlatformTRPCResult platformServerSetup(platformServerRemoveRequest)

Run initial setup (install Docker, Traefik, etc.)

Example

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

val apiInstance = ServerApi()
val platformServerRemoveRequest : PlatformServerRemoveRequest =  // PlatformServerRemoveRequest | 
try {
    val result : PlatformTRPCResult = apiInstance.platformServerSetup(platformServerRemoveRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerSetup")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerSetup")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
platformServerRemoveRequest PlatformServerRemoveRequest

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerSetupMonitoring

PlatformTRPCResult platformServerSetupMonitoring(platformServerSetupMonitoringRequest)

Configure and deploy monitoring agent

Example

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

val apiInstance = ServerApi()
val platformServerSetupMonitoringRequest : PlatformServerSetupMonitoringRequest =  // PlatformServerSetupMonitoringRequest | 
try {
    val result : PlatformTRPCResult = apiInstance.platformServerSetupMonitoring(platformServerSetupMonitoringRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerSetupMonitoring")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerSetupMonitoring")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
platformServerSetupMonitoringRequest PlatformServerSetupMonitoringRequest

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerUpdate

PlatformTRPCResult platformServerUpdate(platformServerUpdateRequest)

Update server configuration

Example

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

val apiInstance = ServerApi()
val platformServerUpdateRequest : PlatformServerUpdateRequest =  // PlatformServerUpdateRequest | 
try {
    val result : PlatformTRPCResult = apiInstance.platformServerUpdate(platformServerUpdateRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
platformServerUpdateRequest PlatformServerUpdateRequest

Return type

PlatformTRPCResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

platformServerValidate

PlatformTRPCResult platformServerValidate(input)

Validate server capabilities

Example

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

val apiInstance = ServerApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
    val result : PlatformTRPCResult = apiInstance.platformServerValidate(input)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ServerApi#platformServerValidate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ServerApi#platformServerValidate")
    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