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

List Resources

curl --request GET \
  --url https://api.example.com/kubeclusters/{cluster}/resources

{
  "results": [
    {
      "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>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Query Parameters

continue

string

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

integer<int64>

Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter.

Response

results

object[] | null

required

Show child attributes

$schema

string<uri>

A URL to the JSON Schema for this object.

Example:

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

pagination

object

Show child attributes

⌘I

List Resources

curl --request GET \
  --url https://api.example.com/kubeclusters/{cluster}/resources

{
  "results": [
    {
      "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>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Resources

Query Parameters

Response