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

4.9 KiB

OverviewApi

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

Method HTTP request Description
adminAdminOverview GET /v1/admin/overview Fleet overview tiles
adminAdminProducts GET /v1/admin/products Product / workload registry
adminAdminSync POST /v1/admin/sync Trigger a fleet re-read
adminAdminUsage GET /v1/admin/usage Fleet usage roll-up

adminAdminOverview

AdminAdminOverview200Response adminAdminOverview()

Fleet overview tiles

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

AdminAdminOverview200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

adminAdminProducts

AdminAdminProducts200Response adminAdminProducts()

Product / workload registry

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

AdminAdminProducts200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

adminAdminSync

AdminAdminSync200Response adminAdminSync()

Trigger a fleet re-read

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

AdminAdminSync200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

adminAdminUsage

AdminAdminUsage200Response adminAdminUsage(org)

Fleet usage roll-up

Example

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

val apiInstance = OverviewApi()
val org : kotlin.String = org_example // kotlin.String | Scope to one org (default fleet)
try {
    val result : AdminAdminUsage200Response = apiInstance.adminAdminUsage(org)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OverviewApi#adminAdminUsage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OverviewApi#adminAdminUsage")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
org kotlin.String Scope to one org (default fleet) [optional]

Return type

AdminAdminUsage200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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