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

13 KiB

EnvironmentsApi

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

Method HTTP request Description
kmsCreateEnvironment POST /v1/kms/projects/{projectId}/environments Create an environment
kmsDeleteEnvironment DELETE /v1/kms/projects/{projectId}/environments/{envId} Delete an environment
kmsListEnvironments GET /v1/kms/projects/{projectId}/environments List project environments
kmsUpdateEnvironment PATCH /v1/kms/projects/{projectId}/environments/{envId} Update an environment
paasCreateEnvironment POST /v1/paas/org/{orgId}/project/{projectId}/env Create environment
paasDeleteEnvironment DELETE /v1/paas/org/{orgId}/project/{projectId}/env/{envId} Delete environment
paasGetEnvironment GET /v1/paas/org/{orgId}/project/{projectId}/env/{envId} Get environment
paasListEnvironments GET /v1/paas/org/{orgId}/project/{projectId}/env List environments

kmsCreateEnvironment

KmsCreateEnvironment200Response kmsCreateEnvironment(projectId, kmsCreateEnvironmentRequest)

Create an environment

Example

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

val apiInstance = EnvironmentsApi()
val projectId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val kmsCreateEnvironmentRequest : KmsCreateEnvironmentRequest =  // KmsCreateEnvironmentRequest | 
try {
    val result : KmsCreateEnvironment200Response = apiInstance.kmsCreateEnvironment(projectId, kmsCreateEnvironmentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#kmsCreateEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#kmsCreateEnvironment")
    e.printStackTrace()
}

Parameters

| projectId | java.util.UUID| | |

Name Type Description Notes
kmsCreateEnvironmentRequest KmsCreateEnvironmentRequest

Return type

KmsCreateEnvironment200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

kmsDeleteEnvironment

kotlin.Any kmsDeleteEnvironment(projectId, envId)

Delete an environment

Example

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

val apiInstance = EnvironmentsApi()
val projectId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val envId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : kotlin.Any = apiInstance.kmsDeleteEnvironment(projectId, envId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#kmsDeleteEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#kmsDeleteEnvironment")
    e.printStackTrace()
}

Parameters

| projectId | java.util.UUID| | |

Name Type Description Notes
envId java.util.UUID

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

kmsListEnvironments

KmsListEnvironments200Response kmsListEnvironments(projectId)

List project environments

Example

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

val apiInstance = EnvironmentsApi()
val projectId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : KmsListEnvironments200Response = apiInstance.kmsListEnvironments(projectId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#kmsListEnvironments")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#kmsListEnvironments")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
projectId java.util.UUID

Return type

KmsListEnvironments200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

kmsUpdateEnvironment

KmsCreateEnvironment200Response kmsUpdateEnvironment(projectId, envId, kmsUpdateEnvironmentRequest)

Update an environment

Example

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

val apiInstance = EnvironmentsApi()
val projectId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val envId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val kmsUpdateEnvironmentRequest : KmsUpdateEnvironmentRequest =  // KmsUpdateEnvironmentRequest | 
try {
    val result : KmsCreateEnvironment200Response = apiInstance.kmsUpdateEnvironment(projectId, envId, kmsUpdateEnvironmentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#kmsUpdateEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#kmsUpdateEnvironment")
    e.printStackTrace()
}

Parameters

| projectId | java.util.UUID| | | | envId | java.util.UUID| | |

Name Type Description Notes
kmsUpdateEnvironmentRequest KmsUpdateEnvironmentRequest

Return type

KmsCreateEnvironment200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

paasCreateEnvironment

kotlin.Any paasCreateEnvironment(orgId, projectId, autoCreateTableRequest)

Create environment

Example

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

val apiInstance = EnvironmentsApi()
val orgId : kotlin.String = orgId_example // kotlin.String | 
val projectId : kotlin.String = projectId_example // kotlin.String | 
val autoCreateTableRequest : AutoCreateTableRequest =  // AutoCreateTableRequest | 
try {
    val result : kotlin.Any = apiInstance.paasCreateEnvironment(orgId, projectId, autoCreateTableRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#paasCreateEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#paasCreateEnvironment")
    e.printStackTrace()
}

Parameters

| orgId | kotlin.String| | | | projectId | kotlin.String| | |

Name Type Description Notes
autoCreateTableRequest AutoCreateTableRequest

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

paasDeleteEnvironment

kotlin.Any paasDeleteEnvironment(orgId, projectId, envId)

Delete environment

Example

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

val apiInstance = EnvironmentsApi()
val orgId : kotlin.String = orgId_example // kotlin.String | 
val projectId : kotlin.String = projectId_example // kotlin.String | 
val envId : kotlin.String = envId_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.paasDeleteEnvironment(orgId, projectId, envId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#paasDeleteEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#paasDeleteEnvironment")
    e.printStackTrace()
}

Parameters

| orgId | kotlin.String| | | | projectId | kotlin.String| | |

Name Type Description Notes
envId 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

paasGetEnvironment

PaasEnvironment paasGetEnvironment(orgId, projectId, envId)

Get environment

Example

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

val apiInstance = EnvironmentsApi()
val orgId : kotlin.String = orgId_example // kotlin.String | 
val projectId : kotlin.String = projectId_example // kotlin.String | 
val envId : kotlin.String = envId_example // kotlin.String | 
try {
    val result : PaasEnvironment = apiInstance.paasGetEnvironment(orgId, projectId, envId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#paasGetEnvironment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#paasGetEnvironment")
    e.printStackTrace()
}

Parameters

| orgId | kotlin.String| | | | projectId | kotlin.String| | |

Name Type Description Notes
envId kotlin.String

Return type

PaasEnvironment

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

paasListEnvironments

kotlin.collections.List<PaasEnvironment> paasListEnvironments(orgId, projectId)

List environments

Example

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

val apiInstance = EnvironmentsApi()
val orgId : kotlin.String = orgId_example // kotlin.String | 
val projectId : kotlin.String = projectId_example // kotlin.String | 
try {
    val result : kotlin.collections.List<PaasEnvironment> = apiInstance.paasListEnvironments(orgId, projectId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnvironmentsApi#paasListEnvironments")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnvironmentsApi#paasListEnvironments")
    e.printStackTrace()
}

Parameters

| orgId | kotlin.String| | |

Name Type Description Notes
projectId kotlin.String

Return type

kotlin.collections.List<PaasEnvironment>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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