OpenAPI

Informations

Version

1.0

Contact

Content negotiation

URI Schemes

• http

Consumes

• application/json
• multipart/form-data
• text/plain

Produces

• application/json
• text/plain

All endpoints

cluster

Method	URI	Name	Summary
DELETE	/rest-api/v1/cluster/{clusterName}	delete rest API v1 cluster cluster name	Delete removes a cluster resource by name.
GET	/rest-api/v1/cluster/{clusterName}	get rest API v1 cluster cluster name	Get returns a cluster resource by name.
GET	/rest-api/v1/clusters	get rest API v1 clusters	List lists all cluster resources.
POST	/rest-api/v1/cluster/{clusterName}	post rest API v1 cluster cluster name	Create creates a cluster resource.
POST	/rest-api/v1/cluster/config/file	post rest API v1 cluster config file	Upload kubeConfig file for cluster
POST	/rest-api/v1/cluster/config/validate	post rest API v1 cluster config validate	Validate KubeConfig
PUT	/rest-api/v1/cluster/{clusterName}	put rest API v1 cluster cluster name	Update updates the cluster metadata by name.

debug

Method	URI	Name	Summary
GET	/endpoints	get endpoints	List all available endpoints

insight

Method	URI	Name	Summary
GET	/rest-api/v1/insight/audit	get rest API v1 insight audit	Audit based on resource group.
GET	/rest-api/v1/insight/detail	get rest API v1 insight detail	GetDetail returns a Kubernetes resource by name, namespace, cluster, apiVersion and kind.
GET	/rest-api/v1/insight/events	get rest API v1 insight events	GetEvents returns events for a Kubernetes resource by name, namespace, cluster, apiVersion and kind.
GET	/rest-api/v1/insight/score	get rest API v1 insight score	ScoreHandler calculates a score for the audited manifest.
GET	/rest-api/v1/insight/stats	get rest API v1 insight stats	Get returns a global statistics info.
GET	/rest-api/v1/insight/summary	get rest API v1 insight summary	Get returns a Kubernetes resource summary by name, namespace, cluster, apiVersion and kind.
GET	/rest-api/v1/insight/topology	get rest API v1 insight topology	GetTopology returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind.

resourcegroup

Method	URI	Name	Summary
GET	/rest-api/v1/resource-groups/{resourceGroupRuleName}	get rest API v1 resource groups resource group rule name	List lists all ResourceGroups by rule name.

resourcegrouprule

Method	URI	Name	Summary
DELETE	/rest-api/v1/resource-group-rule/{resourceGroupRuleName}	delete rest API v1 resource group rule resource group rule name	Delete removes a ResourceGroupRule by name.
GET	/rest-api/v1/resource-group-rule/{resourceGroupRuleName}	get rest API v1 resource group rule resource group rule name	Get returns a ResourceGroupRule by name.
GET	/rest-api/v1/resource-group-rules	get rest API v1 resource group rules	List lists all ResourceGroupRules.
POST	/rest-api/v1/resource-group-rule	post rest API v1 resource group rule	Create creates a ResourceGroupRule.
PUT	/rest-api/v1/resource-group-rule	put rest API v1 resource group rule	Update updates the ResourceGroupRule metadata by name.

search

Method	URI	Name	Summary
GET	/rest-api/v1/search	get rest API v1 search	SearchForResource returns an array of Kubernetes runtime Object matched using the query from context.

Paths

Delete removes a cluster resource by name. (DeleteRestAPIV1ClusterClusterName)

DELETE /rest-api/v1/cluster/{clusterName}

This endpoint deletes the cluster resource by name.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
clusterName	path	string	string		✓		The name of the cluster

All responses

Code	Status	Description	Has headers	Schema
200	OK	Operation status		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Operation status

Status: OK

Schema

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Delete removes a ResourceGroupRule by name. (DeleteRestAPIV1ResourceGroupRuleResourceGroupRuleName)

DELETE /rest-api/v1/resource-group-rule/{resourceGroupRuleName}

This endpoint deletes the ResourceGroupRule by name.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
resourceGroupRuleName	path	string	string		✓		The name of the resource group rule

All responses

Code	Status	Description	Has headers	Schema
200	OK	Operation status		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Operation status

Status: OK

Schema

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

List all available endpoints (GetEndpoints)

GET /endpoints

List all registered endpoints in the router

Consumes

• text/plain

Produces

• text/plain

All responses

Code	Status	Description	Has headers	Schema
200	OK	Endpoints listed successfully		schema

Responses

200 - Endpoints listed successfully

Status: OK

Schema

Get returns a cluster resource by name. (GetRestAPIV1ClusterClusterName)

GET /rest-api/v1/cluster/{clusterName}

This endpoint returns a cluster resource by name.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
clusterName	path	string	string		✓		The name of the cluster
format	query	string	string				The format of the response. Either in json or yaml

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

List lists all cluster resources. (GetRestAPIV1Clusters)

GET /rest-api/v1/clusters

This endpoint lists all cluster resources.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
descending	query	boolean	bool				Whether to sort the list in descending order. Default to false
orderBy	query	string	string				The order to list the cluster. Default to order by name
summary	query	boolean	bool				Whether to display summary or not. Default to false

All responses

Code	Status	Description	Has headers	Schema
200	OK	List of cluster objects		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - List of cluster objects

Status: OK

Schema

[][UnstructuredUnstructured](#unstructured-unstructured)

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Audit based on resource group. (GetRestAPIV1InsightAudit)

GET /rest-api/v1/insight/audit

This endpoint audits based on the specified resource group.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
forceNew	query	boolean	bool				Switch for forced scanning, default is 'false'
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	Audit results		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Audit results

Status: OK

Schema

ScannerAuditData

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

GetDetail returns a Kubernetes resource by name, namespace, cluster, apiVersion and kind. (GetRestAPIV1InsightDetail)

GET /rest-api/v1/insight/detail

This endpoint returns a Kubernetes resource by name, namespace, cluster, apiVersion and kind.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'. Should be percent-encoded
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
format	query	string	string				The format of the response. Either in json or yaml. Default to json
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

GetEvents returns events for a Kubernetes resource by name, namespace, cluster, apiVersion and kind. (GetRestAPIV1InsightEvents)

GET /rest-api/v1/insight/events

This endpoint returns events for a Kubernetes resource YAML by name, namespace, cluster, apiVersion and kind.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'. Should be percent-encoded
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	List of events		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - List of events

Status: OK

Schema

[][UnstructuredUnstructured](#unstructured-unstructured)

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

ScoreHandler calculates a score for the audited manifest. (GetRestAPIV1InsightScore)

GET /rest-api/v1/insight/score

This endpoint calculates a score for the provided manifest based on the number and severity of issues detected during the audit.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
forceNew	query	boolean	bool				Switch for forced compute score, default is 'false'
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	Score calculation result		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Score calculation result

Status: OK

Schema

InsightScoreData

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Get returns a global statistics info. (GetRestAPIV1InsightStats)

GET /rest-api/v1/insight/stats

This endpoint returns a global statistics info.

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Global statistics info		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Global statistics info

Status: OK

Schema

InsightStatistics

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Get returns a Kubernetes resource summary by name, namespace, cluster, apiVersion and kind. (GetRestAPIV1InsightSummary)

GET /rest-api/v1/insight/summary

This endpoint returns a Kubernetes resource summary by name, namespace, cluster, apiVersion and kind.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'. Should be percent-encoded
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	Resource Summary		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Resource Summary

Status: OK

Schema

InsightResourceSummary

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

GetTopology returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind. (GetRestAPIV1InsightTopology)

GET /rest-api/v1/insight/topology

This endpoint returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiVersion	query	string	string				The specified apiVersion, such as 'apps/v1'. Should be percent-encoded
cluster	query	string	string				The specified cluster name, such as 'example-cluster'
forceNew	query	boolean	bool				Force re-generating the topology, default is 'false'
kind	query	string	string				The specified kind, such as 'Deployment'
name	query	string	string				The specified resource name, such as 'foo'
namespace	query	string	string				The specified namespace, such as 'default'

All responses

Code	Status	Description	Has headers	Schema
200	OK	map from string to resource.ResourceTopology		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - map from string to resource.ResourceTopology

Status: OK

Schema

map of InsightResourceTopology

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Get returns a ResourceGroupRule by name. (GetRestAPIV1ResourceGroupRuleResourceGroupRuleName)

GET /rest-api/v1/resource-group-rule/{resourceGroupRuleName}

This endpoint returns a ResourceGroupRule by name.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
resourceGroupRuleName	path	string	string		✓		The name of the resource group rule

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

List lists all ResourceGroupRules. (GetRestAPIV1ResourceGroupRules)

GET /rest-api/v1/resource-group-rules

This endpoint lists all ResourceGroupRules.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
descending	query	boolean	bool				Whether to sort the list in descending order. Default to false
orderBy	query	string	string				The order to list the resourceGroupRule. Default to order by name
summary	query	boolean	bool				Whether to display summary or not. Default to false

All responses

Code	Status	Description	Has headers	Schema
200	OK	List of resourceGroupRule objects		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - List of resourceGroupRule objects

Status: OK

Schema

[][UnstructuredUnstructured](#unstructured-unstructured)

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

List lists all ResourceGroups by rule name. (GetRestAPIV1ResourceGroupsResourceGroupRuleName)

GET /rest-api/v1/resource-groups/{resourceGroupRuleName}

This endpoint lists all ResourceGroups.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
resourceGroupRuleName	path	string	string		✓		The name of the resource group rule

All responses

Code	Status	Description	Has headers	Schema
200	OK	List of resourceGroup objects		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - List of resourceGroup objects

Status: OK

Schema

[][UnstructuredUnstructured](#unstructured-unstructured)

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

SearchForResource returns an array of Kubernetes runtime Object matched using the query from context. (GetRestAPIV1Search)

GET /rest-api/v1/search

This endpoint returns an array of Kubernetes runtime Object matched using the query from context.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
page	query	string	string				The current page to fetch. Default to 1
pageSize	query	string	string				The size of the page. Default to 10
pattern	query	string	string		✓		The search pattern. Can be either sql or dsl. Required
query	query	string	string		✓		The query to use for search. Required

All responses

Code	Status	Description	Has headers	Schema
200	OK	Array of runtime.Object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Array of runtime.Object

Status: OK

Schema

[][interface{}](#interface)

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Create creates a cluster resource. (PostRestAPIV1ClusterClusterName)

POST /rest-api/v1/cluster/{clusterName}

This endpoint creates a new cluster resource using the payload.

Consumes

• application/json
• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
clusterName	path	string	string		✓		The name of the cluster
request	body	ClusterClusterPayload	models.ClusterClusterPayload		✓		cluster to create (either plain text or JSON format)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Upload kubeConfig file for cluster (PostRestAPIV1ClusterConfigFile)

POST /rest-api/v1/cluster/config/file

Uploads a KubeConfig file for cluster, with a maximum size of 2MB.

Consumes

• multipart/form-data

Produces

• text/plain

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
description	formData	string	string		✓		cluster description
displayName	formData	string	string		✓		cluster display name
file	formData	file	io.ReadCloser		✓		Upload file with field name 'file'
name	formData	string	string		✓		cluster name

All responses

Code	Status	Description	Has headers	Schema
200	OK	Returns the content of the uploaded KubeConfig file.		schema
400	Bad Request	The uploaded file is too large or the request is invalid.		schema
500	Internal Server Error	Internal server error.		schema

Responses

200 - Returns the content of the uploaded KubeConfig file.

Status: OK

Schema

ClusterUploadData

400 - The uploaded file is too large or the request is invalid.

Status: Bad Request

Schema

500 - Internal server error.

Status: Internal Server Error

Schema

Validate KubeConfig (PostRestAPIV1ClusterConfigValidate)

POST /rest-api/v1/cluster/config/validate

Validates the provided KubeConfig using cluster manager methods.

Consumes

• application/json
• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	ClusterValidatePayload	models.ClusterValidatePayload		✓		KubeConfig payload to validate

All responses

Code	Status	Description	Has headers	Schema
200	OK	Verification passed server version		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Verification passed server version

Status: OK

Schema

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Create creates a ResourceGroupRule. (PostRestAPIV1ResourceGroupRule)

POST /rest-api/v1/resource-group-rule

This endpoint creates a new ResourceGroupRule using the payload.

Consumes

• application/json
• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	ResourcegroupruleResourceGroupRulePayload	models.ResourcegroupruleResourceGroupRulePayload		✓		resourceGroupRule to create (either plain text or JSON format)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Update updates the cluster metadata by name. (PutRestAPIV1ClusterClusterName)

PUT /rest-api/v1/cluster/{clusterName}

This endpoint updates the display name and description of an existing cluster resource.

Consumes

• application/json
• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
clusterName	path	string	string		✓		The name of the cluster
request	body	ClusterClusterPayload	models.ClusterClusterPayload		✓		cluster to update (either plain text or JSON format)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Update updates the ResourceGroupRule metadata by name. (PutRestAPIV1ResourceGroupRule)

PUT /rest-api/v1/resource-group-rule

This endpoint updates the display name and description of an existing ResourceGroupRule.

Consumes

• application/json
• text/plain

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
request	body	ResourcegroupruleResourceGroupRulePayload	models.ResourcegroupruleResourceGroupRulePayload		✓		resourceGroupRule to update (either plain text or JSON format)

All responses

Code	Status	Description	Has headers	Schema
200	OK	Unstructured object		schema
400	Bad Request	Bad Request		schema
401	Unauthorized	Unauthorized		schema
404	Not Found	Not Found		schema
405	Method Not Allowed	Method Not Allowed		schema
429	Too Many Requests	Too Many Requests		schema
500	Internal Server Error	Internal Server Error		schema

Responses

200 - Unstructured object

Status: OK

Schema

UnstructuredUnstructured

400 - Bad Request

Status: Bad Request

Schema

401 - Unauthorized

Status: Unauthorized

Schema

404 - Not Found

Status: Not Found

Schema

405 - Method Not Allowed

Status: Method Not Allowed

Schema

429 - Too Many Requests

Status: Too Many Requests

Schema

500 - Internal Server Error

Status: Internal Server Error

Schema

Models

cluster.ClusterPayload

Properties

Name	Type	Go type	Required	Default	Description	Example
description	string	string			ClusterDescription is the description of cluster to be created
displayName	string	string			ClusterDisplayName is the display name of cluster to be created
kubeconfig	string	string			ClusterKubeConfig is the kubeconfig of cluster to be created

cluster.UploadData

Properties

Name	Type	Go type	Required	Default	Description	Example
content	string	string
fileName	string	string
fileSize	integer	int64
sanitizedClusterContent	string	string

cluster.ValidatePayload

Properties

Name	Type	Go type	Required	Default	Description	Example
kubeConfig	string	string

entity.ResourceGroup

Properties

Name	Type	Go type	Required	Default	Description	Example
annotations	map of string	map[string]string
apiVersion	string	string
cluster	string	string
kind	string	string
labels	map of string	map[string]string
name	string	string
namespace	string	string

insight.ResourceSummary

Properties

Name	Type	Go type	Required	Default	Description	Example
creationTimestamp	string	string
resource	EntityResourceGroup	EntityResourceGroup
resourceVersion	string	string
uid	string	string

insight.ResourceTopology

Properties

Name	Type	Go type	Required	Default	Description	Example
children	[]string	[]string
parents	[]string	[]string
resourceGroup	EntityResourceGroup	EntityResourceGroup

insight.ScoreData

Properties

Name	Type	Go type	Required	Default	Description	Example
issuesTotal	integer	int64			IssuesTotal is the total count of all issues found during the audit.
This count can be used to understand the overall number of problems
that need to be addressed.
resourceTotal	integer	int64			ResourceTotal is the count of unique resources audited during the scan.
score	number	float64			Score represents the calculated score of the audited manifest based on
the number and severity of issues. It provides a quantitative measure
of the security posture of the resources in the manifest.
severityStatistic	map of integer	map[string]int64			SeverityStatistic is a mapping of severity levels to their respective
number of occurrences. It allows for a quick overview of the distribution
of issues across different severity categories.

insight.Statistics

Properties

Name	Type	Go type	Required	Default	Description	Example
clusterCount	integer	int64
resourceCount	integer	int64
resourceGroupRuleCount	integer	int64

resourcegrouprule.ResourceGroupRulePayload

Properties

Name	Type	Go type	Required	Default	Description	Example
description	string	string
fields	[]string	[]string
name	string	string

scanner.AuditData

Properties

Name	Type	Go type	Required	Default	Description	Example
bySeverity	map of integer	map[string]int64
issueGroups	[][ScannerIssueGroup](#scanner-issue-group)	[]*ScannerIssueGroup
issueTotal	integer	int64
resourceTotal	integer	int64

scanner.Issue

Properties

Name	Type	Go type	Required	Default	Description	Example
message	string	string			Message provides a detailed human-readable description of the issue.
scanner	string	string			Scanner is the name of the scanner that discovered the issue.
severity	integer	int64			Severity indicates how critical the issue is, using the IssueSeverityLevel constants.
title	string	string			Title is a brief summary of the issue.

scanner.IssueGroup

Properties

Name	Type	Go type	Required	Default	Description	Example
issue	ScannerIssue	ScannerIssue
resourceGroups	[][EntityResourceGroup](#entity-resource-group)	[]*EntityResourceGroup

unstructured.Unstructured

Properties

Name	Type	Go type	Required	Default	Description	Example
object	interface{}	interface{}			Object is a JSON compatible map with string, float, int, bool, []interface{}, or
map[string]interface{}
children.