KubeCluster

List Resources

List multiple KubeClusterResources

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 Kubernetes Resource (Deployment, Daemonset, StatefulSet, etc) installed in a specific Kubernetes 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 Kubernetes 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 Kubernetes 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 Kubernetes 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 Kubernetes Resource.

GET

kubeclusters

{cluster}

resources

{
  "$schema": "https://example.com/schemas/ListKubeClusterResourcesOutputBody.json",
  "pagination": {
    "continue": "<string>"
  },
  "results": [
    {
      "$schema": "https://example.com/schemas/KubeClusterResource.json",
      "cluster": "k8scl_83eaa8d5-36ab-4814-9559-77518ec434cf",
      "deployment_system": "argocd",
      "external_id": "2aabf5d0-2f5c-4736-9863-27fd8ab7a756",
      "namespace": "kube-system",
      "package": "pkg_8897b911-950d-4485-93a9-2eedc6fac4fa",
      "package_component": "pkg_8897b911-950d-4485-93a9-2eedc6fac4fa:1:agent",
      "package_system": "helm",
      "resource_kind": "Deployment",
      "resource_name": "mysql-server",
      "scanned_on": 123
    }
  ]
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results).

integer

Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter.

Response

200

application/json

The response is of type object.

{
  "$schema": "https://example.com/schemas/ListKubeClusterResourcesOutputBody.json",
  "pagination": {
    "continue": "<string>"
  },
  "results": [
    {
      "$schema": "https://example.com/schemas/KubeClusterResource.json",
      "cluster": "k8scl_83eaa8d5-36ab-4814-9559-77518ec434cf",
      "deployment_system": "argocd",
      "external_id": "2aabf5d0-2f5c-4736-9863-27fd8ab7a756",
      "namespace": "kube-system",
      "package": "pkg_8897b911-950d-4485-93a9-2eedc6fac4fa",
      "package_component": "pkg_8897b911-950d-4485-93a9-2eedc6fac4fa:1:agent",
      "package_system": "helm",
      "resource_kind": "Deployment",
      "resource_name": "mysql-server",
      "scanned_on": 123
    }
  ]
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Resources

Query Parameters

Response