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

15 KiB

MachineAPIApi

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

Method HTTP request Description
cloudApiControllerAddMachine POST /v1/cloud/add-machine Api Controller Add Machine
cloudApiControllerDeleteMachine POST /v1/cloud/delete-machine Api Controller Delete Machine
cloudApiControllerGetMachine GET /v1/cloud/get-machine Api Controller Get Machine
cloudApiControllerGetMachines GET /v1/cloud/get-machines Api Controller Get Machines
cloudApiControllerUpdateMachine POST /v1/cloud/update-machine Api Controller Update Machine
nexusAddMachine POST /v1/nexus/add-machine add Machine
nexusDeleteMachine POST /v1/nexus/delete-machine delete Machine
nexusGetMachine GET /v1/nexus/get-machine get Machine
nexusGetMachines GET /v1/nexus/get-machines get Machines
nexusUpdateMachine POST /v1/nexus/update-machine update Machine

cloudApiControllerAddMachine

CloudControllersResponse cloudApiControllerAddMachine(cloudObjectMachine)

Api Controller Add Machine

add a machine

Example

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

val apiInstance = MachineAPIApi()
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerAddMachine(cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#cloudApiControllerAddMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#cloudApiControllerAddMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerDeleteMachine

CloudControllersResponse cloudApiControllerDeleteMachine(cloudObjectMachine)

Api Controller Delete Machine

delete a machine

Example

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

val apiInstance = MachineAPIApi()
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteMachine(cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#cloudApiControllerDeleteMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#cloudApiControllerDeleteMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetMachine

CloudObjectMachine cloudApiControllerGetMachine(id)

Api Controller Get Machine

get machine

Example

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

val apiInstance = MachineAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the machine
try {
    val result : CloudObjectMachine = apiInstance.cloudApiControllerGetMachine(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#cloudApiControllerGetMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#cloudApiControllerGetMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id ( owner/name ) of the machine

Return type

CloudObjectMachine

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerGetMachines

CloudObjectMachine cloudApiControllerGetMachines(pageSize, p)

Api Controller Get Machines

get all machines

Example

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

val apiInstance = MachineAPIApi()
val pageSize : kotlin.String = pageSize_example // kotlin.String | The size of each page
val p : kotlin.String = p_example // kotlin.String | The number of the page
try {
    val result : CloudObjectMachine = apiInstance.cloudApiControllerGetMachines(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#cloudApiControllerGetMachines")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#cloudApiControllerGetMachines")
    e.printStackTrace()
}

Parameters

| pageSize | kotlin.String| The size of each page | |

Name Type Description Notes
p kotlin.String The number of the page

Return type

CloudObjectMachine

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

cloudApiControllerUpdateMachine

CloudControllersResponse cloudApiControllerUpdateMachine(id, cloudObjectMachine)

Api Controller Update Machine

update machine

Example

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

val apiInstance = MachineAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the machine
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateMachine(id, cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#cloudApiControllerUpdateMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#cloudApiControllerUpdateMachine")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id ( owner/name ) of the machine | |

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

CloudControllersResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusAddMachine

NexusResponse nexusAddMachine(cloudObjectMachine)

add Machine

Add a machine

Example

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

val apiInstance = MachineAPIApi()
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : NexusResponse = apiInstance.nexusAddMachine(cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#nexusAddMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#nexusAddMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusDeleteMachine

NexusResponse nexusDeleteMachine(cloudObjectMachine)

delete Machine

Delete a machine

Example

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

val apiInstance = MachineAPIApi()
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : NexusResponse = apiInstance.nexusDeleteMachine(cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#nexusDeleteMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#nexusDeleteMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetMachine

CloudObjectMachine nexusGetMachine(id)

get Machine

Get a machine

Example

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

val apiInstance = MachineAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the machine
try {
    val result : CloudObjectMachine = apiInstance.nexusGetMachine(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#nexusGetMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#nexusGetMachine")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The id (owner/name) of the machine

Return type

CloudObjectMachine

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusGetMachines

CloudObjectMachine nexusGetMachines(pageSize, p)

get Machines

Get all machines

Example

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

val apiInstance = MachineAPIApi()
val pageSize : kotlin.String = pageSize_example // kotlin.String | The size of each page
val p : kotlin.String = p_example // kotlin.String | The page number
try {
    val result : CloudObjectMachine = apiInstance.nexusGetMachines(pageSize, p)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#nexusGetMachines")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#nexusGetMachines")
    e.printStackTrace()
}

Parameters

| pageSize | kotlin.String| The size of each page | |

Name Type Description Notes
p kotlin.String The page number

Return type

CloudObjectMachine

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

nexusUpdateMachine

NexusResponse nexusUpdateMachine(id, cloudObjectMachine)

update Machine

Update a machine

Example

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

val apiInstance = MachineAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the machine
val cloudObjectMachine : CloudObjectMachine =  // CloudObjectMachine | The details of the machine
try {
    val result : NexusResponse = apiInstance.nexusUpdateMachine(id, cloudObjectMachine)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MachineAPIApi#nexusUpdateMachine")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MachineAPIApi#nexusUpdateMachine")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The id (owner/name) of the machine | |

Name Type Description Notes
cloudObjectMachine CloudObjectMachine The details of the machine

Return type

NexusResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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