# Functions
Get a []apicontracts.Cluster by a apicontracts.Filter object provided in the body.
Check if clusterid exists.
Get a apicontracts.Cluster by its clusterid.
Get a []apicontracts.Cluster by a workspaceId Will only provide clusters the identity is authorized to view
@Summary Get clusters by workspace @Schemes @Description Get clusters by workspace @Tags clusters @Accept application/json @Produce application/json @Success 200 {array} apicontracts.Cluster @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/workspace/{workspaceId}/filter [get] @Param filter body apicontracts.Filter true "Filter" @Param workspaceId path string true "workspaceId" @Security ApiKey || AccessToken.
View for compliance reports
@Summary Compliance reports view @Schemes @Description A structured presentation of compliance reports @Tags clusters @Accept application/json @Produce application/json @Param clusterid path string true "clusterid" @Success 200 {array} viewsmodels.ComplianceReport @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/:clusterid/views/compliancereports [get] @Security ApiKey || AccessToken.
ComplianceReportsGlobal godoc
@Summary Get compliance reports summary per cluster @Schemes @Description Shows a summary of trivy compliance reports per cluster categorized by amount failed or passed.
Create a cluster
@Summary Create a cluster @Schemes @Description Create a cluster @Tags clusters @Accept application/json @Produce application/json @Param credentials body apicontracts.Cluster true "Credentials" @Success 200 {string} ClusterId @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters [post] @Security ApiKey || AccessToken.
Placeholder for views not yet implemented
@Summary This is a dummy view @Schemes @Description Just a dummy view @Tags clusters @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/{clusterid}/views/ingresses [get] @Router /v1/clusters/{clusterid}/views/nodes [get] @Router /v1/clusters/{clusterid}/views/applications [get] @Router /v1/clusters/views/errorlist [get] @Router /v1/clusters/views/clusterlist [get] @Security ApiKey || AccessToken.
Get a list of control planes metadata for clusters.
Get a kubeconfig by clusterid.
Get a list of metadata for clusters.
@Summary Get cluster self data @Schemes https @Description Get cluster self data @Tags clusters @Accept application/json @Produce application/json
@Success 200 {string} Get data for the cluster @Failure 403 {string} Forbidden @Failure 401 {string} Unauthorized @Failure 500 {string} Failure message @Router /v1/clusters/self [get] @Security ApiKey || AccessToken.
View for vulnerability reports by CVE ID
@Summary Vulnerability reports view by CVE ID @Schemes @Description A structured presentation of vulnerability reports by CVE ID @Accept application/json @Produce application/json @Query cveid {string} @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/views/vulnerabilityreports/byid [get] @Security ApiKey || AccessToken.
View for policy reports
@Summary Policy report view @Schemes @Description A structured presentation of policyreports @Tags clusters @Accept application/json @Produce application/json @Param type query viewsmodels.PolicyreportGlobalQueryType true "type" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/{clusterid}/views/policyreports [get] @Security ApiKey || AccessToken.
View for policy reports
@Summary Policy report view @Schemes @Description A structured presentation of policyreports @Tags clusters @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/{clusterid}/views/policyreports [get] @Security ApiKey || AccessToken.
Register a cluster hearbeat report, the hearbeat is in the payload.
Update metadata for a cluster.
VulnerabilityReportsGlobal godoc
@Summary Get vulnerability reports summary per cluster @Schemes @Description Shows a summary of trivy vulnerability reports per cluster categorized by amount of critical/high/medium/low vulnerabilities.
View for policy reports
@Summary Policy report view @Schemes @Description A structured presentation of policyreports @Tags clusters @Accept application/json @Produce application/json @Param type query viewsmodels.PolicyreportGlobalQueryType true "type" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/{clusterid}/views/policyreports [get] @Security ApiKey || AccessToken.
View for vulnerability reports
@Summary Vulnerability reports view @Schemes @Description A structured presentation of vulnerability reports @Tags clusters @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/{clusterid}/views/vulnerabilityreports [get] @Security ApiKey || AccessToken.
View for vulnerability reports
@Summary Vulnerability reports view @Schemes @Description A structured presentation of vulnerability reports @Tags clusters @Accept application/json @Produce application/json @Param cveid path string true "cveid" @Success 200 {string} This is not the view you are looking for @Failure 403 {string} Forbidden @Failure 400 {object} rorerror.RorError @Failure 401 {object} rorerror.RorError @Failure 500 {string} Failure message @Router /v1/clusters/views/vulnerabilityreports/byid/:cveid [get] @Security ApiKey || AccessToken.