Skip to main content
Version: v0.5 ๐Ÿšง

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โ€‹

MethodURINameSummary
DELETE/rest-api/v1/cluster/{clusterName}delete rest API v1 cluster cluster nameDelete removes a cluster resource by name.
GET/rest-api/v1/cluster/{clusterName}get rest API v1 cluster cluster nameGet returns a cluster resource by name.
GET/rest-api/v1/clustersget rest API v1 clustersList lists all cluster resources.
POST/rest-api/v1/cluster/{clusterName}post rest API v1 cluster cluster nameCreate creates a cluster resource.
POST/rest-api/v1/cluster/config/filepost rest API v1 cluster config fileUpload kubeConfig file for cluster
POST/rest-api/v1/cluster/config/validatepost rest API v1 cluster config validateValidate KubeConfig
PUT/rest-api/v1/cluster/{clusterName}put rest API v1 cluster cluster nameUpdate updates the cluster metadata by name.

debugโ€‹

MethodURINameSummary
GET/endpointsget endpointsList all available endpoints

insightโ€‹

MethodURINameSummary
GET/rest-api/v1/insight/auditget rest API v1 insight auditAudit based on resource group.
GET/rest-api/v1/insight/detailget rest API v1 insight detailGetDetail returns a Kubernetes resource by name, namespace, cluster, apiVersion and kind.
GET/rest-api/v1/insight/eventsget rest API v1 insight eventsGetEvents returns events for a Kubernetes resource by name, namespace, cluster, apiVersion and kind.
GET/rest-api/v1/insight/scoreget rest API v1 insight scoreScoreHandler calculates a score for the audited manifest.
GET/rest-api/v1/insight/statsget rest API v1 insight statsGet returns a global statistics info.
GET/rest-api/v1/insight/summaryget rest API v1 insight summaryGet returns a Kubernetes resource summary by name, namespace, cluster, apiVersion and kind.
GET/rest-api/v1/insight/topologyget rest API v1 insight topologyGetTopology returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind.

resourcegroupโ€‹

MethodURINameSummary
GET/rest-api/v1/resource-groups/{resourceGroupRuleName}get rest API v1 resource groups resource group rule nameList lists all ResourceGroups by rule name.

resourcegroupruleโ€‹

MethodURINameSummary
DELETE/rest-api/v1/resource-group-rule/{resourceGroupRuleName}delete rest API v1 resource group rule resource group rule nameDelete removes a ResourceGroupRule by name.
GET/rest-api/v1/resource-group-rule/{resourceGroupRuleName}get rest API v1 resource group rule resource group rule nameGet returns a ResourceGroupRule by name.
GET/rest-api/v1/resource-group-rulesget rest API v1 resource group rulesList lists all ResourceGroupRules.
POST/rest-api/v1/resource-group-rulepost rest API v1 resource group ruleCreate creates a ResourceGroupRule.
PUT/rest-api/v1/resource-group-ruleput rest API v1 resource group ruleUpdate updates the ResourceGroupRule metadata by name.
MethodURINameSummary
GET/rest-api/v1/searchget rest API v1 searchSearchForResource 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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
clusterNamepathstringstringโœ“The name of the cluster

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKOperation statusschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
resourceGroupRuleNamepathstringstringโœ“The name of the resource group rule

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKOperation statusschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

CodeStatusDescriptionHas headersSchema
200OKEndpoints listed successfullyschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
clusterNamepathstringstringโœ“The name of the cluster
formatquerystringstringThe format of the response. Either in json or yaml

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
descendingquerybooleanboolWhether to sort the list in descending order. Default to false
orderByquerystringstringThe order to list the cluster. Default to order by name
summaryquerybooleanboolWhether to display summary or not. Default to false

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKList of cluster objectsschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
forceNewquerybooleanboolSwitch for forced scanning, default is 'false'
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKAudit resultsschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'. Should be percent-encoded
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
formatquerystringstringThe format of the response. Either in json or yaml. Default to json
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'. Should be percent-encoded
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKList of eventsschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
forceNewquerybooleanboolSwitch for forced compute score, default is 'false'
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKScore calculation resultschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

CodeStatusDescriptionHas headersSchema
200OKGlobal statistics infoschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'. Should be percent-encoded
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKResource Summaryschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
apiVersionquerystringstringThe specified apiVersion, such as 'apps/v1'. Should be percent-encoded
clusterquerystringstringThe specified cluster name, such as 'example-cluster'
forceNewquerybooleanboolForce re-generating the topology, default is 'false'
kindquerystringstringThe specified kind, such as 'Deployment'
namequerystringstringThe specified resource name, such as 'foo'
namespacequerystringstringThe specified namespace, such as 'default'

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKmap from string to resource.ResourceTopologyschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
resourceGroupRuleNamepathstringstringโœ“The name of the resource group rule

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
descendingquerybooleanboolWhether to sort the list in descending order. Default to false
orderByquerystringstringThe order to list the resourceGroupRule. Default to order by name
summaryquerybooleanboolWhether to display summary or not. Default to false

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKList of resourceGroupRule objectsschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
resourceGroupRuleNamepathstringstringโœ“The name of the resource group rule

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKList of resourceGroup objectsschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
pagequerystringstringThe current page to fetch. Default to 1
pageSizequerystringstringThe size of the page. Default to 10
patternquerystringstringโœ“The search pattern. Can be either sql or dsl. Required
queryquerystringstringโœ“The query to use for search. Required

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKArray of runtime.Objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
clusterNamepathstringstringโœ“The name of the cluster
requestbodyClusterClusterPayloadmodels.ClusterClusterPayloadโœ“cluster to create (either plain text or JSON format)

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
descriptionformDatastringstringโœ“cluster description
displayNameformDatastringstringโœ“cluster display name
fileformDatafileio.ReadCloserโœ“Upload file with field name 'file'
nameformDatastringstringโœ“cluster name

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKReturns the content of the uploaded KubeConfig file.schema
400Bad RequestThe uploaded file is too large or the request is invalid.schema
500Internal Server ErrorInternal 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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
requestbodyClusterValidatePayloadmodels.ClusterValidatePayloadโœ“KubeConfig payload to validate

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKVerification passed server versionschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
requestbodyResourcegroupruleResourceGroupRulePayloadmodels.ResourcegroupruleResourceGroupRulePayloadโœ“resourceGroupRule to create (either plain text or JSON format)

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
clusterNamepathstringstringโœ“The name of the cluster
requestbodyClusterClusterPayloadmodels.ClusterClusterPayloadโœ“cluster to update (either plain text or JSON format)

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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โ€‹

NameSourceTypeGo typeSeparatorRequiredDefaultDescription
requestbodyResourcegroupruleResourceGroupRulePayloadmodels.ResourcegroupruleResourceGroupRulePayloadโœ“resourceGroupRule to update (either plain text or JSON format)

All responsesโ€‹

CodeStatusDescriptionHas headersSchema
200OKUnstructured objectschema
400Bad RequestBad Requestschema
401UnauthorizedUnauthorizedschema
404Not FoundNot Foundschema
405Method Not AllowedMethod Not Allowedschema
429Too Many RequestsToo Many Requestsschema
500Internal Server ErrorInternal Server Errorschema

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

NameTypeGo typeRequiredDefaultDescriptionExample
descriptionstringstringClusterDescription is the description of cluster to be created
displayNamestringstringClusterDisplayName is the display name of cluster to be created
kubeconfigstringstringClusterKubeConfig is the kubeconfig of cluster to be created

cluster.UploadDataโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
contentstringstring
fileNamestringstring
fileSizeintegerint64
sanitizedClusterContentstringstring

cluster.ValidatePayloadโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
kubeConfigstringstring

entity.ResourceGroupโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
annotationsmap of stringmap[string]string
apiVersionstringstring
clusterstringstring
kindstringstring
labelsmap of stringmap[string]string
namestringstring
namespacestringstring

insight.ResourceSummaryโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
creationTimestampstringstring
resourceEntityResourceGroupEntityResourceGroup
resourceVersionstringstring
uidstringstring

insight.ResourceTopologyโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
children[]string[]string
parents[]string[]string
resourceGroupEntityResourceGroupEntityResourceGroup

insight.ScoreDataโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
issuesTotalintegerint64IssuesTotal 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.
resourceTotalintegerint64ResourceTotal is the count of unique resources audited during the scan.
scorenumberfloat64Score 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.
severityStatisticmap of integermap[string]int64SeverityStatistic 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

NameTypeGo typeRequiredDefaultDescriptionExample
clusterCountintegerint64
resourceCountintegerint64
resourceGroupRuleCountintegerint64

resourcegrouprule.ResourceGroupRulePayloadโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
descriptionstringstring
fields[]string[]string
namestringstring

scanner.AuditDataโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
bySeveritymap of integermap[string]int64
issueGroups[][ScannerIssueGroup](#scanner-issue-group)[]*ScannerIssueGroup
issueTotalintegerint64
resourceTotalintegerint64

scanner.Issueโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
messagestringstringMessage provides a detailed human-readable description of the issue.
scannerstringstringScanner is the name of the scanner that discovered the issue.
severityintegerint64Severity indicates how critical the issue is, using the IssueSeverityLevel constants.
titlestringstringTitle is a brief summary of the issue.

scanner.IssueGroupโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
issueScannerIssueScannerIssue
resourceGroups[][EntityResourceGroup](#entity-resource-group)[]*EntityResourceGroup

unstructured.Unstructuredโ€‹

Properties

NameTypeGo typeRequiredDefaultDescriptionExample
objectinterface{}interface{}Object is a JSON compatible map with string, float, int, bool, []interface{}, or
map[string]interface{}
children.