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]>
12 KiB
DomainApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| platformDomainByApplicationId | GET /v1/platform/domain/byApplicationId | List domains for an application |
| platformDomainByComposeId | GET /v1/platform/domain/byComposeId | List domains for a compose service |
| platformDomainCreate | POST /v1/platform/domain/create | Create a domain mapping |
| platformDomainDelete | POST /v1/platform/domain/delete | Delete a domain |
| platformDomainGenerateDomain | POST /v1/platform/domain/generateDomain | Generate a traefik.me auto-domain |
| platformDomainOne | GET /v1/platform/domain/one | Get a domain by ID |
| platformDomainUpdate | POST /v1/platform/domain/update | Update a domain mapping |
| platformDomainValidateDomain | POST /v1/platform/domain/validateDomain | Validate DNS for a domain |
platformDomainByApplicationId
PlatformTRPCResult platformDomainByApplicationId(input)
List domains for an application
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
val result : PlatformTRPCResult = apiInstance.platformDomainByApplicationId(input)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainByApplicationId")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainByApplicationId")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| input | kotlin.String | URL-encoded JSON input for tRPC queries | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
platformDomainByComposeId
PlatformTRPCResult platformDomainByComposeId(input)
List domains for a compose service
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
val result : PlatformTRPCResult = apiInstance.platformDomainByComposeId(input)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainByComposeId")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainByComposeId")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| input | kotlin.String | URL-encoded JSON input for tRPC queries | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
platformDomainCreate
PlatformTRPCResult platformDomainCreate(platformDomainCreateRequest)
Create a domain mapping
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val platformDomainCreateRequest : PlatformDomainCreateRequest = // PlatformDomainCreateRequest |
try {
val result : PlatformTRPCResult = apiInstance.platformDomainCreate(platformDomainCreateRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainCreate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainCreate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| platformDomainCreateRequest | PlatformDomainCreateRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
platformDomainDelete
PlatformTRPCResult platformDomainDelete(platformDomainDeleteRequest)
Delete a domain
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val platformDomainDeleteRequest : PlatformDomainDeleteRequest = // PlatformDomainDeleteRequest |
try {
val result : PlatformTRPCResult = apiInstance.platformDomainDelete(platformDomainDeleteRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainDelete")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainDelete")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| platformDomainDeleteRequest | PlatformDomainDeleteRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
platformDomainGenerateDomain
PlatformTRPCResult platformDomainGenerateDomain(platformDomainGenerateDomainRequest)
Generate a traefik.me auto-domain
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val platformDomainGenerateDomainRequest : PlatformDomainGenerateDomainRequest = // PlatformDomainGenerateDomainRequest |
try {
val result : PlatformTRPCResult = apiInstance.platformDomainGenerateDomain(platformDomainGenerateDomainRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainGenerateDomain")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainGenerateDomain")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| platformDomainGenerateDomainRequest | PlatformDomainGenerateDomainRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
platformDomainOne
PlatformTRPCResult platformDomainOne(input)
Get a domain by ID
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val input : kotlin.String = input_example // kotlin.String | URL-encoded JSON input for tRPC queries
try {
val result : PlatformTRPCResult = apiInstance.platformDomainOne(input)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainOne")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainOne")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| input | kotlin.String | URL-encoded JSON input for tRPC queries | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
platformDomainUpdate
PlatformTRPCResult platformDomainUpdate(platformDomainUpdateRequest)
Update a domain mapping
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val platformDomainUpdateRequest : PlatformDomainUpdateRequest = // PlatformDomainUpdateRequest |
try {
val result : PlatformTRPCResult = apiInstance.platformDomainUpdate(platformDomainUpdateRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainUpdate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainUpdate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| platformDomainUpdateRequest | PlatformDomainUpdateRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
platformDomainValidateDomain
PlatformTRPCResult platformDomainValidateDomain(platformDomainValidateDomainRequest)
Validate DNS for a domain
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DomainApi()
val platformDomainValidateDomainRequest : PlatformDomainValidateDomainRequest = // PlatformDomainValidateDomainRequest |
try {
val result : PlatformTRPCResult = apiInstance.platformDomainValidateDomain(platformDomainValidateDomainRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DomainApi#platformDomainValidateDomain")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DomainApi#platformDomainValidateDomain")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| platformDomainValidateDomainRequest | PlatformDomainValidateDomainRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json