Skip to main content
GET
/
kubeclusters
/
{cluster}
/
resources
/
{resource}
Get Resource
curl --request GET \
  --url https://api.example.com/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

OK

​
cluster
string
required

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

Example:

"k8scl_83eaa8d5-36ab-4814-9559-77518ec434cf"

​
external_id
string
required

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

Example:

"2aabf5d0-2f5c-4736-9863-27fd8ab7a756"

​
namespace
string
required

The namespace in which the KubeClusterResource resides.

Example:

"kube-system"

​
resource_kind
enum<string>
required

The Resource Kind.

Available options:
Deployment,
DaemonSet,
StatefulSet
Example:

"Deployment"

​
resource_name
string
required

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

Example:

"mysql-server"

​
scanned_on
integer<int64>
required

The timestamp the KubeClusterScan occurred.

​
$schema
string<uri>

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/KubeClusterResource.json"

​
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.

Example:

"argocd"

​
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.

Example:

"pkg_8897b911-950d-4485-93a9-2eedc6fac4fa"

​
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.

Example:

"pkg_8897b911-950d-4485-93a9-2eedc6fac4fa:1:agent"

​
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.

Example:

"helm"