KubeCluster

Get Resource

Gets a single KubeClusterResource

A KubeCluster can have many KubeClusterResources. Each time a KubeCluster’s inventory is scanned, one or more KubeClusterResources are created for the KubeCluster and scan date.

KubeClusterResource represents a single Resource (Deployment, Daemonset, StatefulSet, etc) installed in a specific namespace in the KubeCluster.

A KubeClusterResource may be assigned a known KubeDeploymentSystem. When the KubeClusterResource’s DeploymentSystem field is empty, that means that the classification process was unable to determine a matching KubeDeploymentSystem for the discovered Resource.

A KubeClusterResource may be assigned a known PackageSystem. When the KubeClusterResource’s PackageSystem field is empty, that means that the classification process was unable to determine a matching PackageSystem for the discovered Resource.

A KubeClusterResource may be associated with a known Package. When the KubeClusterResource’s Package field is empty, that means that the classification process was unable to determine a matching Package for the discovered Resource.

A KubeClusterResource may be associated with a known PackageComponent. When the KubeClusterResource’s PackageComponent field is empty, that means that the classification process was unable to determine a matching PackageComponent for the discovered Resource.

GET

kubeclusters

{cluster}

resources

{resource}

{
  "cluster": "<string>",
  "external_id": "<string>",
  "namespace": "<string>",
  "resource_kind": "Deployment",
  "resource_name": "<string>",
  "scanned_on": 123,
  "$schema": "<string>",
  "deployment_system": "<string>",
  "package": "<string>",
  "package_component": "<string>",
  "package_system": "<string>"
}

Response

cluster

string

required

Cluster is the ID of the KubeCluster in which this KubeClusterResource resides.

external_id

string

required

The value of the metadata.name field in the resource manifest.

namespace

string

required

The namespace in which the KubeClusterResource resides.

resource_kind

enum<string>

required

The Resource Kind.

Available options:

Deployment,

DaemonSet,

StatefulSet

resource_name

string

required

The value of the metadata.name field in the resource manifest.

scanned_on

integer<int64>

required

The timestamp the KubeClusterScan occurred.

$schema

string<uri>

A URL to the JSON Schema for this object.

deployment_system

string

During classification, if Chkk was able to determine what was used to deploy the resource, this field will contain the KubeDeploymentSystem that was identified.

package

string

During classification, if Chkk was able to determine the specific Package contained the resource, this field will contain the ID of the Package.

package_component

string

During classification, if Chkk was able to determine the specific PackageComponent that was associated with the resource, this field will contain the ID of the PackageComponent.

package_system

string

During classification, if Chkk was able to determine what packaging system was used to bundle the resource, this field will contain the PackageSystem that was identified.

List ContainersList multiple KubeClusterResourceContainers A KubeClusterResource can have many KubeClusterResourceContainers. When a KubeClusterResource refers to a Resource that is comprised of one or more ContainerSpecs, we create a KubeClusterResourceContainer corresponding to that ContainerSpec. This allows us to have fine-grained knowledge of the specific Images referenced in all Resources in the KubeCluster. A KubeClusterResourceContainer may be associated with a known Project. When the KubeClusterResourceContainer's Project field is empty, that means that the classification process was unable to determine a matching Project for the discovered Resource Container. A KubeClusterResourceContainer may be associated with a known ProjectContainer. When the KubeClusterResourceContainer's ProjectContainer field is empty, that means that the classification process was unable to determine a matching ProjectContainer for the discovered Resource Container.

⌘I

{
  "cluster": "<string>",
  "external_id": "<string>",
  "namespace": "<string>",
  "resource_kind": "Deployment",
  "resource_name": "<string>",
  "scanned_on": 123,
  "$schema": "<string>",
  "deployment_system": "<string>",
  "package": "<string>",
  "package_component": "<string>",
  "package_system": "<string>"
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

Get Resource

Response