API Documentation
K8s Bench 0.9.0
Endpoints
POST /core/add-namespace
Add K8S Namespace
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "NamespaceDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/delete-namespace
Delete K8S Namespace
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "NamespaceDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/add-secret
Add K8S Secret
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"string_data": null,
"secret_type": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"string_data": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "String Data"
},
"secret_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Type"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "SecretDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/delete-secret
Delete K8S Secret
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"string_data": null,
"secret_type": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"string_data": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "String Data"
},
"secret_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Type"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "SecretDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/update-secret
Update K8S Secret
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"string_data": null,
"secret_type": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"string_data": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "String Data"
},
"secret_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Type"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "SecretDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/create-pod
Create K8S Pod
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"image": "string",
"sites_pvc": "string",
"annotations": null,
"labels": null,
"command": null,
"args": null,
"image_pull_policy": "string",
"image_pull_secrets": null,
"ctr_name": "string",
"resources": null,
"logs_pvc": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"image": {
"type": "string",
"title": "Image"
},
"sites_pvc": {
"type": "string",
"title": "Sites Pvc"
},
"annotations": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
},
"labels": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels"
},
"command": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Command"
},
"args": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Args"
},
"image_pull_policy": {
"type": "string",
"title": "Image Pull Policy",
"default": "Always"
},
"image_pull_secrets": {
"anyOf": [
{
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Image Pull Secrets"
},
"ctr_name": {
"type": "string",
"title": "Ctr Name",
"default": "console"
},
"resources": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Resources"
},
"logs_pvc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logs Pvc"
}
},
"type": "object",
"required": [
"name",
"namespace",
"image",
"sites_pvc"
],
"title": "PodDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /core/delete-pod
Delete K8S Pod
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "MetaDataDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /core/get-pod-status
Fetch Job Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /jobs/bench-command
Execute Bench Command
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"job_name": "string",
"sites_pvc": "string",
"args": [
"string"
],
"command": null,
"logs_pvc": null,
"namespace": null,
"image_pull_secrets": null,
"image": null,
"annotations": null,
"node_selector": null,
"resources": null,
"additional_volumes": null
}
Schema of the request body
{
"properties": {
"job_name": {
"type": "string",
"title": "Job Name"
},
"sites_pvc": {
"type": "string",
"title": "Sites Pvc"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"title": "Args"
},
"command": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Command"
},
"logs_pvc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logs Pvc"
},
"namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Namespace"
},
"image_pull_secrets": {
"anyOf": [
{
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Image Pull Secrets"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"annotations": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
},
"node_selector": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Node Selector"
},
"resources": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Resources"
},
"additional_volumes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AdditionalVolumesDto"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Additional Volumes"
}
},
"type": "object",
"required": [
"job_name",
"sites_pvc",
"args"
],
"title": "BenchCommandDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /jobs/build-bench
Execute Build Bench
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"job_name": "string",
"namespace": "string",
"push_secret_name": "string",
"destination_image_name": "string",
"container_file_path": null,
"frappe_path": null,
"frappe_branch": null,
"python_version": null,
"node_version": null,
"apps_json": null,
"git_repo_context": null,
"node_selector": null,
"insecure_registry": null,
"host_aliases": null,
"snapshot_mode": null,
"use_new_run": null,
"cache": null,
"resources": null,
"kaniko_image": null,
"compressed_cache": null
}
Schema of the request body
{
"properties": {
"job_name": {
"type": "string",
"title": "Job Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"push_secret_name": {
"type": "string",
"title": "Push Secret Name"
},
"destination_image_name": {
"type": "string",
"title": "Destination Image Name"
},
"container_file_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Container File Path"
},
"frappe_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Frappe Path"
},
"frappe_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Frappe Branch"
},
"python_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Python Version"
},
"node_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Node Version"
},
"apps_json": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/FrappeAppDto"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Apps Json"
},
"git_repo_context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Git Repo Context"
},
"node_selector": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Node Selector"
},
"insecure_registry": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Insecure Registry"
},
"host_aliases": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/HostAliasDto"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Host Aliases"
},
"snapshot_mode": {
"anyOf": [
{
"$ref": "#/components/schemas/SnapshotMode"
},
{
"type": "null"
}
]
},
"use_new_run": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use New Run"
},
"cache": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Cache"
},
"resources": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Resources"
},
"kaniko_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Kaniko Image"
},
"compressed_cache": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Compressed Cache"
}
},
"type": "object",
"required": [
"job_name",
"namespace",
"push_secret_name",
"destination_image_name"
],
"title": "BuildBenchDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /jobs/get-status
Fetch Job Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
job_name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /jobs/delete-job
Delete K8S Job
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"job_name": "string",
"namespace": "string"
}
Schema of the request body
{
"properties": {
"job_name": {
"type": "string",
"title": "Job Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
}
},
"type": "object",
"required": [
"job_name",
"namespace"
],
"title": "FetchJobStatusDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /flux/get-helmrelease-status
Get K8S Flux Helmrelease Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/add-helmrelease
Add Flux Bench
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"release_interval": "string",
"chart_interval": "string",
"chart": "string",
"source_ref": {
"kind": "string",
"name": "string",
"namespace": "string"
},
"values": {},
"remediate_last_failure": true,
"version": null,
"timeout": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"release_interval": {
"type": "string",
"title": "Release Interval"
},
"chart_interval": {
"type": "string",
"title": "Chart Interval"
},
"chart": {
"type": "string",
"title": "Chart",
"description": "path to chart in case of git repo, e.g. \"./erpnext\"\n or chart name in case of helm repo, e.g. \"erpnext\"."
},
"source_ref": {
"$ref": "#/components/schemas/SourceRefDto"
},
"values": {
"type": "object",
"title": "Values"
},
"remediate_last_failure": {
"type": "boolean",
"title": "Remediate Last Failure"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version"
},
"timeout": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timeout"
}
},
"type": "object",
"required": [
"name",
"namespace",
"release_interval",
"chart_interval",
"chart",
"source_ref",
"values",
"remediate_last_failure"
],
"title": "AddBenchDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/update-helmrelease
Update Flux Bench
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"release_interval": "string",
"chart_interval": "string",
"chart": "string",
"source_ref": {
"kind": "string",
"name": "string",
"namespace": "string"
},
"values": {},
"remediate_last_failure": true,
"version": null,
"timeout": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"release_interval": {
"type": "string",
"title": "Release Interval"
},
"chart_interval": {
"type": "string",
"title": "Chart Interval"
},
"chart": {
"type": "string",
"title": "Chart",
"description": "path to chart in case of git repo, e.g. \"./erpnext\"\n or chart name in case of helm repo, e.g. \"erpnext\"."
},
"source_ref": {
"$ref": "#/components/schemas/SourceRefDto"
},
"values": {
"type": "object",
"title": "Values"
},
"remediate_last_failure": {
"type": "boolean",
"title": "Remediate Last Failure"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version"
},
"timeout": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timeout"
}
},
"type": "object",
"required": [
"name",
"namespace",
"release_interval",
"chart_interval",
"chart",
"source_ref",
"values",
"remediate_last_failure"
],
"title": "AddBenchDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/delete-helmrelease
Delete Flux Bench
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "BenchDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /flux/get-helmsource-status
Get K8S Flux Helmsource Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
kind |
query | string | No | ||
name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/add-helmsource
Add K8S Flux Helm Source
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"kind": "string",
"interval": null,
"url": null,
"secret_ref": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"kind": {
"type": "string",
"title": "Kind"
},
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Interval"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"secret_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Ref"
}
},
"type": "object",
"required": [
"name",
"namespace",
"kind"
],
"title": "HelmSourceDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/update-helmsource
Update K8S Flux Helm Source
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"kind": "string",
"interval": null,
"url": null,
"secret_ref": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"kind": {
"type": "string",
"title": "Kind"
},
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Interval"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"secret_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Ref"
}
},
"type": "object",
"required": [
"name",
"namespace",
"kind"
],
"title": "HelmSourceDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /flux/delete-helmsource
Delete K8S Flux Helm Source
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"kind": "string",
"interval": null,
"url": null,
"secret_ref": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"kind": {
"type": "string",
"title": "Kind"
},
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Interval"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"secret_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secret Ref"
}
},
"type": "object",
"required": [
"name",
"namespace",
"kind"
],
"title": "HelmSourceDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /ingress/get-status
Get K8S Ingress Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /ingress/create
Create K8S Ingress Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"host": null,
"service_name": null,
"service_port": null,
"cert_secret_name": null,
"is_wildcard": null,
"annotations": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Host"
},
"service_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Name"
},
"service_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Service Port"
},
"cert_secret_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cert Secret Name"
},
"is_wildcard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Wildcard"
},
"annotations": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "IngressDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /ingress/patch
Patch K8S Ingress Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"host": null,
"service_name": null,
"service_port": null,
"cert_secret_name": null,
"is_wildcard": null,
"annotations": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Host"
},
"service_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Name"
},
"service_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Service Port"
},
"cert_secret_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cert Secret Name"
},
"is_wildcard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Wildcard"
},
"annotations": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "IngressDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /ingress/delete
Delete K8S Ingress Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"host": null,
"service_name": null,
"service_port": null,
"cert_secret_name": null,
"is_wildcard": null,
"annotations": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Host"
},
"service_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Service Name"
},
"service_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Service Port"
},
"cert_secret_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cert Secret Name"
},
"is_wildcard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Wildcard"
},
"annotations": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "IngressDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /cronjobs/add
Create Cronjob
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string",
"sites_pvc": "string",
"cronstring": "string",
"image": null,
"args": null,
"backoff_limit": 0,
"command": null,
"logs_pvc": null,
"image_pull_secrets": null,
"annotations": null,
"node_selector": null,
"resources": null,
"env_vars": null
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
},
"sites_pvc": {
"type": "string",
"title": "Sites Pvc"
},
"cronstring": {
"type": "string",
"title": "Cronstring"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"args": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Args"
},
"backoff_limit": {
"type": "integer",
"title": "Backoff Limit",
"default": 0
},
"command": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Command"
},
"logs_pvc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logs Pvc"
},
"image_pull_secrets": {
"anyOf": [
{
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Image Pull Secrets"
},
"annotations": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Annotations"
},
"node_selector": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Node Selector"
},
"resources": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Resources"
},
"env_vars": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EnvVarDto"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Env Vars"
}
},
"type": "object",
"required": [
"name",
"namespace",
"sites_pvc",
"cronstring"
],
"title": "CronJobDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /cronjobs/get-status
Fetch Cronjob Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
name |
query | string | No | ||
namespace |
query | string | No |
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /cronjobs/delete
Remove Cronjob
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Request body
{
"name": "string",
"namespace": "string"
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"namespace": {
"type": "string",
"title": "Namespace"
}
},
"type": "object",
"required": [
"name",
"namespace"
],
"title": "MetaDataDto"
}
Response 200 OK
Schema of the response body
Response 422 Unprocessable Entity
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /terminal/get-short-token
Fetch Cronjob Status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
HTTPBasic |
header | string | N/A | No | Basic authentication |
Response 200 OK
Schema of the response body
GET /healthz
Healthcheck
Response 200 OK
Schema of the response body
Schemas
AddBenchDto
| Name | Type |
|---|---|
chart |
string |
chart_interval |
string |
name |
string |
namespace |
string |
release_interval |
string |
remediate_last_failure |
boolean |
source_ref |
SourceRefDto |
timeout |
|
values |
|
version |
AdditionalVolumesDto
| Name | Type |
|---|---|
mount_path |
string |
pvc_name |
string |
read_only |
|
volume_name |
string |
BenchCommandDto
| Name | Type |
|---|---|
additional_volumes |
|
annotations |
|
args |
Array<string> |
command |
|
image |
|
image_pull_secrets |
|
job_name |
string |
logs_pvc |
|
namespace |
|
node_selector |
|
resources |
|
sites_pvc |
string |
BenchDto
| Name | Type |
|---|---|
name |
string |
namespace |
string |
BuildBenchDto
| Name | Type |
|---|---|
apps_json |
|
cache |
|
compressed_cache |
|
container_file_path |
|
destination_image_name |
string |
frappe_branch |
|
frappe_path |
|
git_repo_context |
|
host_aliases |
|
insecure_registry |
|
job_name |
string |
kaniko_image |
|
namespace |
string |
node_selector |
|
node_version |
|
push_secret_name |
string |
python_version |
|
resources |
|
snapshot_mode |
|
use_new_run |
CronJobDto
| Name | Type |
|---|---|
annotations |
|
args |
|
backoff_limit |
integer |
command |
|
cronstring |
string |
env_vars |
|
image |
|
image_pull_secrets |
|
logs_pvc |
|
name |
string |
namespace |
string |
node_selector |
|
resources |
|
sites_pvc |
string |
EnvVarDto
| Name | Type |
|---|---|
name |
string |
value |
|
value_from |
FetchJobStatusDto
| Name | Type |
|---|---|
job_name |
string |
namespace |
string |
FrappeAppDto
| Name | Type |
|---|---|
branch |
string |
url |
string |
HelmSourceDto
| Name | Type |
|---|---|
interval |
|
kind |
string |
name |
string |
namespace |
string |
secret_ref |
|
url |
HostAliasDto
| Name | Type |
|---|---|
hostnames |
Array<string> |
ip |
string |
HTTPValidationError
| Name | Type |
|---|---|
detail |
Array<ValidationError> |
IngressDto
| Name | Type |
|---|---|
annotations |
|
cert_secret_name |
|
host |
|
is_wildcard |
|
name |
string |
namespace |
string |
service_name |
|
service_port |
MetaDataDto
| Name | Type |
|---|---|
name |
string |
namespace |
string |
NamespaceDto
| Name | Type |
|---|---|
name |
string |
PodDto
| Name | Type |
|---|---|
annotations |
|
args |
|
command |
|
ctr_name |
string |
image |
string |
image_pull_policy |
string |
image_pull_secrets |
|
labels |
|
logs_pvc |
|
name |
string |
namespace |
string |
resources |
|
sites_pvc |
string |
SecretDto
| Name | Type |
|---|---|
name |
string |
namespace |
string |
secret_type |
|
string_data |
SnapshotMode
Type: string
SourceRefDto
| Name | Type |
|---|---|
kind |
string |
name |
string |
namespace |
string |
ValidationError
| Name | Type |
|---|---|
loc |
Array<> |
msg |
string |
type |
string |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| HTTPBasic | http | basic |