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]>
7.3 KiB
ScansApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| registryGetScanReport | GET /v1/registry/projects/{name}/repositories/{repo}/artifacts/{digest}/scan/report | Get scan report |
| registryTriggerScan | POST /v1/registry/projects/{name}/repositories/{repo}/artifacts/{digest}/scan | Trigger vulnerability scan |
| securitySecurityGetScan | GET /v1/security/scans/{id} | Get a scan with its findings |
| securitySecurityListScans | GET /v1/security/scans | List scans |
| securitySecuritySubmitScan | POST /v1/security/scans | Submit a scan |
registryGetScanReport
RegistryScanReport registryGetScanReport(name, repo, digest)
Get scan report
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ScansApi()
val name : kotlin.String = name_example // kotlin.String |
val repo : kotlin.String = repo_example // kotlin.String |
val digest : kotlin.String = digest_example // kotlin.String |
try {
val result : RegistryScanReport = apiInstance.registryGetScanReport(name, repo, digest)
println(result)
} catch (e: ClientException) {
println("4xx response calling ScansApi#registryGetScanReport")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ScansApi#registryGetScanReport")
e.printStackTrace()
}
Parameters
| name | kotlin.String| | | | repo | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| digest | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
registryTriggerScan
registryTriggerScan(name, repo, digest)
Trigger vulnerability scan
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ScansApi()
val name : kotlin.String = name_example // kotlin.String |
val repo : kotlin.String = repo_example // kotlin.String |
val digest : kotlin.String = digest_example // kotlin.String |
try {
apiInstance.registryTriggerScan(name, repo, digest)
} catch (e: ClientException) {
println("4xx response calling ScansApi#registryTriggerScan")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ScansApi#registryTriggerScan")
e.printStackTrace()
}
Parameters
| name | kotlin.String| | | | repo | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| digest | kotlin.String |
Return type
null (empty response body)
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
securitySecurityGetScan
SecuritySecurityGetScan200Response securitySecurityGetScan(id)
Get a scan with its findings
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ScansApi()
val id : kotlin.String = id_example // kotlin.String |
try {
val result : SecuritySecurityGetScan200Response = apiInstance.securitySecurityGetScan(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling ScansApi#securitySecurityGetScan")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ScansApi#securitySecurityGetScan")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String |
Return type
SecuritySecurityGetScan200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
securitySecurityListScans
SecuritySecurityListScans200Response securitySecurityListScans(limit)
List scans
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ScansApi()
val limit : kotlin.Int = 56 // kotlin.Int |
try {
val result : SecuritySecurityListScans200Response = apiInstance.securitySecurityListScans(limit)
println(result)
} catch (e: ClientException) {
println("4xx response calling ScansApi#securitySecurityListScans")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ScansApi#securitySecurityListScans")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | kotlin.Int | [optional] |
Return type
SecuritySecurityListScans200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
securitySecuritySubmitScan
SecurityScan securitySecuritySubmitScan(securityScanRequest)
Submit a scan
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ScansApi()
val securityScanRequest : SecurityScanRequest = // SecurityScanRequest |
try {
val result : SecurityScan = apiInstance.securitySecuritySubmitScan(securityScanRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling ScansApi#securitySecuritySubmitScan")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ScansApi#securitySecuritySubmitScan")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| securityScanRequest | SecurityScanRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json