/* Dark mode - visible underline for better contrast */
.dark .link {
    border-bottom-color: rgba(255, 255, 255, 0.8);
}


Create a new KubePlatform

A KubePlatform describes things like the cloud infrastructure provider and the
Kubernetes control plane provider.

An Organization can have one or more KubePlatforms.

Create KubePlatform

Simple string identifier for the provider of compute, network and storage resource for the Infrastructure.

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

Key information about the underlying provider of compute, network and storage resources for the KubePlatform.

Simple string identifier for the provider of the Kubernetes control plane for the KubePlatform.

Documentation

Introduction

Authenticate and obtain access credentials for authorized operations.

Get Access Token

List Risks matching one or more filter parameters.

List Risks

Returns the full details of a single Risk.

Get a specific Risk

Returns a paginated list of Kubernetes resources that are associated with the specified Operational Risk.

List resources for a specific Risk

List multiple Accounts

An Account is a container for resource ownership. Organizations can
have multiple Accounts, each representing a department or division of the
Organization that has ownership over some segment of the Organization's
resources.

Accounts are uniquely identified by a UUID, prefixed with the string
ac_, for example ac_c42014e7-baf5-4ec6-a502-858f98dca7c8

List Accounts

Create a new Account

An Account is a container for resource ownership. Organizations can
have multiple Accounts, each representing a department or division of the
Organization that has ownership over some segment of the Organization's
resources.

Accounts are uniquely identified by a UUID, prefixed with the string
ac_, for example ac_c42014e7-baf5-4ec6-a502-858f98dca7c8

Create Account

Gets a single Account

An Account is a container for resource ownership. Organizations can
have multiple Accounts, each representing a department or division of the
Organization that has ownership over some segment of the Organization's
resources.

Accounts are uniquely identified by a UUID, prefixed with the string
ac_, for example ac_c42014e7-baf5-4ec6-a502-858f98dca7c8

Get Account

Update an existing Account

An Account is a container for resource ownership. Organizations can
have multiple Accounts, each representing a department or division of the
Organization that has ownership over some segment of the Organization's
resources.

Accounts are uniquely identified by a UUID, prefixed with the string
ac_, for example ac_c42014e7-baf5-4ec6-a502-858f98dca7c8

Update Account

Delete a Account

An Account is a container for resource ownership. Organizations can
have multiple Accounts, each representing a department or division of the
Organization that has ownership over some segment of the Organization's
resources.

Accounts are uniquely identified by a UUID, prefixed with the string
ac_, for example ac_c42014e7-baf5-4ec6-a502-858f98dca7c8

Delete Account

List multiple KubeClusters

A KubeCluster describes a single Kubernetes cluster provisioned by a
KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within
the set of KubeCluster name for an Account, e.g. cluster1 or
k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the
customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current
Kubernetes control plane version.

List KubeClusters

Create a new KubeCluster

A KubeCluster describes a single Kubernetes cluster provisioned by a
KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within
the set of KubeCluster name for an Account, e.g. cluster1 or
k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the
customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current
Kubernetes control plane version.

Create KubeCluster

Gets a single KubeCluster

A KubeCluster describes a single Kubernetes cluster provisioned by a
KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within
the set of KubeCluster name for an Account, e.g. cluster1 or
k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the
customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current
Kubernetes control plane version.

Get KubeCluster

Update an existing KubeCluster

A KubeCluster describes a single Kubernetes cluster provisioned by a
KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within
the set of KubeCluster name for an Account, e.g. cluster1 or
k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the
customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current
Kubernetes control plane version.

Update KubeCluster

Delete a KubeCluster

A KubeCluster describes a single Kubernetes cluster provisioned by a
KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within
the set of KubeCluster name for an Account, e.g. cluster1 or
k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the
customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current
Kubernetes control plane version.

Delete KubeCluster

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.

List Resources

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

List multiple KubeClusterResourceContainers

A KubeClusterResource can have many KubeClusterResourceContainers.
When a KubeClusterResource refers to a Kubernetes Resource that is comprised of
one or more Kubernetes ContainerSpecs, we create a KubeClusterResourceContainer
corresponding to that ContainerSpec. This allows us to have fine-grained
knowledge of the specific Images referenced in all Kubernetes 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 Kubernetes 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 Kubernetes Resource
Container.

List Containers

Create a new KubeClusterResourceContainer

A KubeClusterResource can have many KubeClusterResourceContainers.
When a KubeClusterResource refers to a Kubernetes Resource that is comprised of
one or more Kubernetes ContainerSpecs, we create a KubeClusterResourceContainer
corresponding to that ContainerSpec. This allows us to have fine-grained
knowledge of the specific Images referenced in all Kubernetes 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 Kubernetes 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 Kubernetes Resource
Container.

Create Container

Gets a single KubeClusterResourceContainer

A KubeClusterResource can have many KubeClusterResourceContainers.
When a KubeClusterResource refers to a Kubernetes Resource that is comprised of
one or more Kubernetes ContainerSpecs, we create a KubeClusterResourceContainer
corresponding to that ContainerSpec. This allows us to have fine-grained
knowledge of the specific Images referenced in all Kubernetes 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 Kubernetes 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 Kubernetes Resource
Container.

Get Container

Update an existing KubeClusterResourceContainer

A KubeClusterResource can have many KubeClusterResourceContainers.
When a KubeClusterResource refers to a Kubernetes Resource that is comprised of
one or more Kubernetes ContainerSpecs, we create a KubeClusterResourceContainer
corresponding to that ContainerSpec. This allows us to have fine-grained
knowledge of the specific Images referenced in all Kubernetes 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 Kubernetes 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 Kubernetes Resource
Container.

Update Container

Delete a KubeClusterResourceContainer

A KubeClusterResource can have many KubeClusterResourceContainers.
When a KubeClusterResource refers to a Kubernetes Resource that is comprised of
one or more Kubernetes ContainerSpecs, we create a KubeClusterResourceContainer
corresponding to that ContainerSpec. This allows us to have fine-grained
knowledge of the specific Images referenced in all Kubernetes 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 Kubernetes 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 Kubernetes Resource
Container.

Delete Container

List multiple KubeClusterScans

A KubeClusterScan represents a single scan of a Kubernetes cluster.

List Scans

List multiple KubeClusterScanNamespaces

A KubeClusterScan can have many KubeClusterScanNamespaces. Each unique
Kubernetes Namespace discovered for a KubeClusterScan is represented by a
unique KubeClusterScanNamespace record.

List Namespaces

Gets a single KubeClusterScanNamespace

A KubeClusterScan can have many KubeClusterScanNamespaces. Each unique
Kubernetes Namespace discovered for a KubeClusterScan is represented by a
unique KubeClusterScanNamespace record.

Get Namespace

List multiple KubePlatforms

A KubePlatform describes things like the cloud infrastructure provider and the
Kubernetes control plane provider.

An Organization can have one or more KubePlatforms.

List KubePlatforms

Gets a single KubePlatform

A KubePlatform describes things like the cloud infrastructure provider and the
Kubernetes control plane provider.

An Organization can have one or more KubePlatforms.

Get KubePlatform

Update an existing KubePlatform

A KubePlatform describes things like the cloud infrastructure provider and the
Kubernetes control plane provider.

An Organization can have one or more KubePlatforms.

Update KubePlatform

Delete a KubePlatform

A KubePlatform describes things like the cloud infrastructure provider and the
Kubernetes control plane provider.

An Organization can have one or more KubePlatforms.

Delete KubePlatform

List multiple OCIArtifacts

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact
contains. For OCIArtifacts with a MediaType of
application/vnd.oci.image.manifest.v1+json or
application/vnd.docker.container.image.v1+json, the Architecture
field will show the compute architecture that the OCI Image was built for (e.g.
"amd64")

OCIArtifacts can be associated with zero or more ProjectReleases and
PackageReleases.

List Artifacts

Create a new OCIArtifact

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact
contains. For OCIArtifacts with a MediaType of
application/vnd.oci.image.manifest.v1+json or
application/vnd.docker.container.image.v1+json, the Architecture
field will show the compute architecture that the OCI Image was built for (e.g.
"amd64")

OCIArtifacts can be associated with zero or more ProjectReleases and
PackageReleases.

Create Artifact

Gets a single OCIArtifact

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact
contains. For OCIArtifacts with a MediaType of
application/vnd.oci.image.manifest.v1+json or
application/vnd.docker.container.image.v1+json, the Architecture
field will show the compute architecture that the OCI Image was built for (e.g.
"amd64")

OCIArtifacts can be associated with zero or more ProjectReleases and
PackageReleases.

Get Artifact

Update an existing OCIArtifact

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact
contains. For OCIArtifacts with a MediaType of
application/vnd.oci.image.manifest.v1+json or
application/vnd.docker.container.image.v1+json, the Architecture
field will show the compute architecture that the OCI Image was built for (e.g.
"amd64")

OCIArtifacts can be associated with zero or more ProjectReleases and
PackageReleases.

Update Artifact

Delete a OCIArtifact

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact
contains. For OCIArtifacts with a MediaType of
application/vnd.oci.image.manifest.v1+json or
application/vnd.docker.container.image.v1+json, the Architecture
field will show the compute architecture that the OCI Image was built for (e.g.
"amd64")

OCIArtifacts can be associated with zero or more ProjectReleases and
PackageReleases.

Delete Artifact

List multiple OCITags

An OCIReference represents a relationship between an OCITag and an
OCIArtifact.

When attempting to match a customer's container image to a known
OCIArtifact, we look up an OCITag that matches a particular digest. For
mutable OCITags, that digest association, however, changes over time. Until
OCIReference was introduced, we were only storing the first known
digest for these mutable tags, which ended up introducing a lot of stale
data into the digest classification process: the classifiers were not able
to find OCITags that match newer digests for these mutable tags and
therefore less accurate classifiers like ruleset and deduction classifier
needed to try and classify the cluster inventory record.

For OCITags that are mutable -- e.g. "latest" or "stable" or "v1" -- there
can be many digests that an OCITag has previously pointed to.
Previously-referred digests for an OCITag are made available through the
OCIReference object model. You may be wondering why we don't have an
References field on OCITag that just returns the digests that have been
previously associated with this OCITag. The reason for that is because the
list of previously-known digest associations can be very long (it's
unbounded) and so having this information in a separately-fetched object
model that can be paginated/controlled seemed like a better design.

List Tags

Create a new OCIReference

An OCIReference represents a relationship between an OCITag and an
OCIArtifact.

When attempting to match a customer's container image to a known
OCIArtifact, we look up an OCITag that matches a particular digest. For
mutable OCITags, that digest association, however, changes over time. Until
OCIReference was introduced, we were only storing the first known
digest for these mutable tags, which ended up introducing a lot of stale
data into the digest classification process: the classifiers were not able
to find OCITags that match newer digests for these mutable tags and
therefore less accurate classifiers like ruleset and deduction classifier
needed to try and classify the cluster inventory record.

For OCITags that are mutable -- e.g. "latest" or "stable" or "v1" -- there
can be many digests that an OCITag has previously pointed to.
Previously-referred digests for an OCITag are made available through the
OCIReference object model. You may be wondering why we don't have an
References field on OCITag that just returns the digests that have been
previously associated with this OCITag. The reason for that is because the
list of previously-known digest associations can be very long (it's
unbounded) and so having this information in a separately-fetched object
model that can be paginated/controlled seemed like a better design.

Create Reference

Gets a single OCIReference

An OCIReference represents a relationship between an OCITag and an
OCIArtifact.

When attempting to match a customer's container image to a known
OCIArtifact, we look up an OCITag that matches a particular digest. For
mutable OCITags, that digest association, however, changes over time. Until
OCIReference was introduced, we were only storing the first known
digest for these mutable tags, which ended up introducing a lot of stale
data into the digest classification process: the classifiers were not able
to find OCITags that match newer digests for these mutable tags and
therefore less accurate classifiers like ruleset and deduction classifier
needed to try and classify the cluster inventory record.

For OCITags that are mutable -- e.g. "latest" or "stable" or "v1" -- there
can be many digests that an OCITag has previously pointed to.
Previously-referred digests for an OCITag are made available through the
OCIReference object model. You may be wondering why we don't have an
References field on OCITag that just returns the digests that have been
previously associated with this OCITag. The reason for that is because the
list of previously-known digest associations can be very long (it's
unbounded) and so having this information in a separately-fetched object
model that can be paginated/controlled seemed like a better design.

Get Reference

Update an existing OCIReference

An OCIReference represents a relationship between an OCITag and an
OCIArtifact.

When attempting to match a customer's container image to a known
OCIArtifact, we look up an OCITag that matches a particular digest. For
mutable OCITags, that digest association, however, changes over time. Until
OCIReference was introduced, we were only storing the first known
digest for these mutable tags, which ended up introducing a lot of stale
data into the digest classification process: the classifiers were not able
to find OCITags that match newer digests for these mutable tags and
therefore less accurate classifiers like ruleset and deduction classifier
needed to try and classify the cluster inventory record.

For OCITags that are mutable -- e.g. "latest" or "stable" or "v1" -- there
can be many digests that an OCITag has previously pointed to.
Previously-referred digests for an OCITag are made available through the
OCIReference object model. You may be wondering why we don't have an
References field on OCITag that just returns the digests that have been
previously associated with this OCITag. The reason for that is because the
list of previously-known digest associations can be very long (it's
unbounded) and so having this information in a separately-fetched object
model that can be paginated/controlled seemed like a better design.

Update Reference

Delete an OCIReference

An OCIReference represents a relationship between an OCITag and an
OCIArtifact.

When attempting to match a customer's container image to a known
OCIArtifact, we look up an OCITag that matches a particular digest. For
mutable OCITags, that digest association, however, changes over time. Until
OCIReference was introduced, we were only storing the first known
digest for these mutable tags, which ended up introducing a lot of stale
data into the digest classification process: the classifiers were not able
to find OCITags that match newer digests for these mutable tags and
therefore less accurate classifiers like ruleset and deduction classifier
needed to try and classify the cluster inventory record.

For OCITags that are mutable -- e.g. "latest" or "stable" or "v1" -- there
can be many digests that an OCITag has previously pointed to.
Previously-referred digests for an OCITag are made available through the
OCIReference object model. You may be wondering why we don't have an
References field on OCITag that just returns the digests that have been
previously associated with this OCITag. The reason for that is because the
list of previously-known digest associations can be very long (it's
unbounded) and so having this information in a separately-fetched object
model that can be paginated/controlled seemed like a better design.

Delete Reference

List multiple OCIRepositories

An OCIRepository represents a single namespace within an OCI Registry.

OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.

Examples of OCIRepository identifiers:

* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
 registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator<//b>: The
 bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.

List Repositories

Create a new OCIRepository

An OCIRepository represents a single namespace within an OCI Registry.

OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.

Examples of OCIRepository identifiers:

* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
 registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator<//b>: The
 bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.

Create Repository

Gets a single OCIRepository

An OCIRepository represents a single namespace within an OCI Registry.

OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.

Examples of OCIRepository identifiers:

* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
 registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator<//b>: The
 bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.

Get Repository

Update an existing OCIRepository

An OCIRepository represents a single namespace within an OCI Registry.

OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.

Examples of OCIRepository identifiers:

* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
 registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator<//b>: The
 bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.

Update Repository

Delete an OCIRepository

An OCIRepository represents a single namespace within an OCI Registry.

OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.

Examples of OCIRepository identifiers:

* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
 registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator<//b>: The
 bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.

Delete Repository

List multiple OCITags

An OCIRepository can publish zero or more OCITags. OCITags are names that
point to a unique OCIArtifact digest.

An OCITag's ID is comprised of the OCIRepository ID followed by a : and the
Tag name.

Examples of OCITag identifiers:

* docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot
 OCIRepository.
* public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the
 public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

Create a new OCITag

An OCIRepository can publish zero or more OCITags. OCITags are names that
point to a unique OCIArtifact digest.

An OCITag's ID is comprised of the OCIRepository ID followed by a : and the
Tag name.

Examples of OCITag identifiers:

* docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot
 OCIRepository.
* public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the
 public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

Create Tag

Gets a single OCITag

An OCIRepository can publish zero or more OCITags. OCITags are names that
point to a unique OCIArtifact digest.

An OCITag's ID is comprised of the OCIRepository ID followed by a : and the
Tag name.

Examples of OCITag identifiers:

* docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot
 OCIRepository.
* public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the
 public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

Get Tag

Update an existing OCITag

An OCIRepository can publish zero or more OCITags. OCITags are names that
point to a unique OCIArtifact digest.

An OCITag's ID is comprised of the OCIRepository ID followed by a : and the
Tag name.

Examples of OCITag identifiers:

* docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot
 OCIRepository.
* public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the
 public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

Update Tag

Delete a OCITag

An OCIRepository can publish zero or more OCITags. OCITags are names that
point to a unique OCIArtifact digest.

An OCITag's ID is comprised of the OCIRepository ID followed by a : and the
Tag name.

Examples of OCITag identifiers:

* docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot
 OCIRepository.
* public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the
 public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

Delete Tag

List multiple Organizations

An Organization is the top-level object that models a Chkk customer.

Organizations are uniquely identified by a UUID, prefixed with the string
org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

List Organizations

Create a new Organization

An Organization is the top-level object that models a Chkk customer.

Organizations are uniquely identified by a UUID, prefixed with the string
org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

Create Organization

Gets a single Organization

An Organization is the top-level object that models a Chkk customer.

Organizations are uniquely identified by a UUID, prefixed with the string
org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

Get Organization

Update an existing Organization

An Organization is the top-level object that models a Chkk customer.

Organizations are uniquely identified by a UUID, prefixed with the string
org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

Update Organization

Delete a Organization

An Organization is the top-level object that models a Chkk customer.

Organizations are uniquely identified by a UUID, prefixed with the string
org_, for example org_c42014e7-baf5-4ec6-a502-858f98dca7c8

Delete Organization

List multiple Packages

A Package is a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.

A PackageSystem is an identifier of a packaging ecosystem.

Packages can use one of the following PackageSystems:

* helm for Helm charts
* kube for raw YAML manifests or Kustomize overlays that install one or
 more Kubernetes resources

A Package is identified by a globally-unique ID field which is a UUID string
prefixed with the string 'pkg_', for example
'pkg_c42014e7-baf5-4ec6-a502-858f98dca7c8'.

A Package may be associated with one or more Projects and zero or more
ProjectComponents.

A Package may have one or more links associated with it. There are two types
of links that hold special significance to a package: 'package.archive' and
'package.source'. The 'package.archive' link is used to indicate the location
of the package's archive, which is the file that contains the package's
contents. The 'package.source' link is used to indicate a location on the web
where the package may be observed in an un-archived format. For example, the
cert-manager helm chart package can have the following links

- 'package.archive': https:charts.jetstack.io/cert-manager
- 'package.source': https:github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager

A Package may have zero or more aliases associated with it in the 'Aliases'
field. An alias for a Package is a human readable string that uniquely
identifies the Package.

A Package may be associated with one or more ProjectComponents. Packages with
PackageSystem helm or kube are associated with ProjectComponents
via the Package's collection of PackageComponents. A PackageComponent, which
corresponds to a specific Kubernetes Resource of Kind Deployment, DaemonSet or
StatefulSet, may reference one or more Docker Images. Those Docker Images
correspond to a ProjectComponent for one or more Projects.

List Packages

Create a new Package

A Package is a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.

A PackageSystem is an identifier of a packaging ecosystem.

Packages can use one of the following PackageSystems:

* helm for Helm charts
* kube for raw YAML manifests or Kustomize overlays that install one or
 more Kubernetes resources

A Package is identified by a globally-unique ID field which is a UUID string
prefixed with the string 'pkg_', for example
'pkg_c42014e7-baf5-4ec6-a502-858f98dca7c8'.

A Package may be associated with one or more Projects and zero or more
ProjectComponents.

A Package may have one or more links associated with it. There are two types
of links that hold special significance to a package: 'package.archive' and
'package.source'. The 'package.archive' link is used to indicate the location
of the package's archive, which is the file that contains the package's
contents. The 'package.source' link is used to indicate a location on the web
where the package may be observed in an un-archived format. For example, the
cert-manager helm chart package can have the following links

- 'package.archive': https:charts.jetstack.io/cert-manager
- 'package.source': https:github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager

A Package may have zero or more aliases associated with it in the 'Aliases'
field. An alias for a Package is a human readable string that uniquely
identifies the Package.

A Package may be associated with one or more ProjectComponents. Packages with
PackageSystem helm or kube are associated with ProjectComponents
via the Package's collection of PackageComponents. A PackageComponent, which
corresponds to a specific Kubernetes Resource of Kind Deployment, DaemonSet or
StatefulSet, may reference one or more Docker Images. Those Docker Images
correspond to a ProjectComponent for one or more Projects.

Create Package

Gets a single Package

A Package is a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.

A PackageSystem is an identifier of a packaging ecosystem.

Packages can use one of the following PackageSystems:

* helm for Helm charts
* kube for raw YAML manifests or Kustomize overlays that install one or
 more Kubernetes resources

A Package is identified by a globally-unique ID field which is a UUID string
prefixed with the string 'pkg_', for example
'pkg_c42014e7-baf5-4ec6-a502-858f98dca7c8'.

A Package may be associated with one or more Projects and zero or more
ProjectComponents.

A Package may have one or more links associated with it. There are two types
of links that hold special significance to a package: 'package.archive' and
'package.source'. The 'package.archive' link is used to indicate the location
of the package's archive, which is the file that contains the package's
contents. The 'package.source' link is used to indicate a location on the web
where the package may be observed in an un-archived format. For example, the
cert-manager helm chart package can have the following links

- 'package.archive': https:charts.jetstack.io/cert-manager
- 'package.source': https:github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager

A Package may have zero or more aliases associated with it in the 'Aliases'
field. An alias for a Package is a human readable string that uniquely
identifies the Package.

A Package may be associated with one or more ProjectComponents. Packages with
PackageSystem helm or kube are associated with ProjectComponents
via the Package's collection of PackageComponents. A PackageComponent, which
corresponds to a specific Kubernetes Resource of Kind Deployment, DaemonSet or
StatefulSet, may reference one or more Docker Images. Those Docker Images
correspond to a ProjectComponent for one or more Projects.

Get Package

Update an existing Package

A Package is a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.

A PackageSystem is an identifier of a packaging ecosystem.

Packages can use one of the following PackageSystems:

* helm for Helm charts
* kube for raw YAML manifests or Kustomize overlays that install one or
 more Kubernetes resources

A Package is identified by a globally-unique ID field which is a UUID string
prefixed with the string 'pkg_', for example
'pkg_c42014e7-baf5-4ec6-a502-858f98dca7c8'.

A Package may be associated with one or more Projects and zero or more
ProjectComponents.

A Package may have one or more links associated with it. There are two types
of links that hold special significance to a package: 'package.archive' and
'package.source'. The 'package.archive' link is used to indicate the location
of the package's archive, which is the file that contains the package's
contents. The 'package.source' link is used to indicate a location on the web
where the package may be observed in an un-archived format. For example, the
cert-manager helm chart package can have the following links

- 'package.archive': https:charts.jetstack.io/cert-manager
- 'package.source': https:github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager

A Package may have zero or more aliases associated with it in the 'Aliases'
field. An alias for a Package is a human readable string that uniquely
identifies the Package.

A Package may be associated with one or more ProjectComponents. Packages with
PackageSystem helm or kube are associated with ProjectComponents
via the Package's collection of PackageComponents. A PackageComponent, which
corresponds to a specific Kubernetes Resource of Kind Deployment, DaemonSet or
StatefulSet, may reference one or more Docker Images. Those Docker Images
correspond to a ProjectComponent for one or more Projects.

Update Package

Delete a Package

A Package is a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.

A PackageSystem is an identifier of a packaging ecosystem.

Packages can use one of the following PackageSystems:

* helm for Helm charts
* kube for raw YAML manifests or Kustomize overlays that install one or
 more Kubernetes resources

A Package is identified by a globally-unique ID field which is a UUID string
prefixed with the string 'pkg_', for example
'pkg_c42014e7-baf5-4ec6-a502-858f98dca7c8'.

A Package may be associated with one or more Projects and zero or more
ProjectComponents.

A Package may have one or more links associated with it. There are two types
of links that hold special significance to a package: 'package.archive' and
'package.source'. The 'package.archive' link is used to indicate the location
of the package's archive, which is the file that contains the package's
contents. The 'package.source' link is used to indicate a location on the web
where the package may be observed in an un-archived format. For example, the
cert-manager helm chart package can have the following links

- 'package.archive': https:charts.jetstack.io/cert-manager
- 'package.source': https:github.com/cert-manager/cert-manager/tree/master/deploy/charts/cert-manager

A Package may have zero or more aliases associated with it in the 'Aliases'
field. An alias for a Package is a human readable string that uniquely
identifies the Package.

A Package may be associated with one or more ProjectComponents. Packages with
PackageSystem helm or kube are associated with ProjectComponents
via the Package's collection of PackageComponents. A PackageComponent, which
corresponds to a specific Kubernetes Resource of Kind Deployment, DaemonSet or
StatefulSet, may reference one or more Docker Images. Those Docker Images
correspond to a ProjectComponent for one or more Projects.

Delete Package

List multiple PackageReleases

A Package may have one or more PackageReleases. A PackageRelease is
the coordinated publication of one or more Packages for the Package having the
same Version string.

A PackageRelease is uniquely identified by the combination of the Package UUID
or Package Alias and a version string separated by an @ character.

Example PackageRelease identifiers:

* helm-chkk-operator@0.0.13: the Chkk Operator Helm Chart Package Alias of
 helm-chkk-operator with a version string of 0.0.13
* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a@1.24.12: the Package UUID of the
 Cilium Helm Chart and the version string 1.24.12
* helm-kube-prometheus-stack@65.4.0: the Kube Prometheus Helm Chart Package
 Alias of helm-kube-prometheus-stack with a version string of 65.4.0

A PackageRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the PackageRelease.

List Releases

Create a new PackageRelease

A Package may have one or more PackageReleases. A PackageRelease is
the coordinated publication of one or more Packages for the Package having the
same Version string.

A PackageRelease is uniquely identified by the combination of the Package UUID
or Package Alias and a version string separated by an @ character.

Example PackageRelease identifiers:

* helm-chkk-operator@0.0.13: the Chkk Operator Helm Chart Package Alias of
 helm-chkk-operator with a version string of 0.0.13
* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a@1.24.12: the Package UUID of the
 Cilium Helm Chart and the version string 1.24.12
* helm-kube-prometheus-stack@65.4.0: the Kube Prometheus Helm Chart Package
 Alias of helm-kube-prometheus-stack with a version string of 65.4.0

A PackageRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the PackageRelease.

Create Release

Gets a single PackageRelease

A Package may have one or more PackageReleases. A PackageRelease is
the coordinated publication of one or more Packages for the Package having the
same Version string.

A PackageRelease is uniquely identified by the combination of the Package UUID
or Package Alias and a version string separated by an @ character.

Example PackageRelease identifiers:

* helm-chkk-operator@0.0.13: the Chkk Operator Helm Chart Package Alias of
 helm-chkk-operator with a version string of 0.0.13
* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a@1.24.12: the Package UUID of the
 Cilium Helm Chart and the version string 1.24.12
* helm-kube-prometheus-stack@65.4.0: the Kube Prometheus Helm Chart Package
 Alias of helm-kube-prometheus-stack with a version string of 65.4.0

A PackageRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the PackageRelease.

Get Release

Update an existing PackageRelease

A Package may have one or more PackageReleases. A PackageRelease is
the coordinated publication of one or more Packages for the Package having the
same Version string.

A PackageRelease is uniquely identified by the combination of the Package UUID
or Package Alias and a version string separated by an @ character.

Example PackageRelease identifiers:

* helm-chkk-operator@0.0.13: the Chkk Operator Helm Chart Package Alias of
 helm-chkk-operator with a version string of 0.0.13
* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a@1.24.12: the Package UUID of the
 Cilium Helm Chart and the version string 1.24.12
* helm-kube-prometheus-stack@65.4.0: the Kube Prometheus Helm Chart Package
 Alias of helm-kube-prometheus-stack with a version string of 65.4.0

A PackageRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the PackageRelease.

Update Release

Delete a PackageRelease

A Package may have one or more PackageReleases. A PackageRelease is
the coordinated publication of one or more Packages for the Package having the
same Version string.

A PackageRelease is uniquely identified by the combination of the Package UUID
or Package Alias and a version string separated by an @ character.

Example PackageRelease identifiers:

* helm-chkk-operator@0.0.13: the Chkk Operator Helm Chart Package Alias of
 helm-chkk-operator with a version string of 0.0.13
* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a@1.24.12: the Package UUID of the
 Cilium Helm Chart and the version string 1.24.12
* helm-kube-prometheus-stack@65.4.0: the Kube Prometheus Helm Chart Package
 Alias of helm-kube-prometheus-stack with a version string of 65.4.0

A PackageRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the PackageRelease.

Delete Release

List multiple PackageVersionSets

A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.

A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.

PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.

Examples of PackageVersionSet identifiers:

* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
 Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
 the Argo Workflows Package, using the Argo Workflow Package's UUID as the
 identifier.

Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.

List VersionSets

Create a new PackageVersionSet

A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.

A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.

PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.

Examples of PackageVersionSet identifiers:

* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
 Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
 the Argo Workflows Package, using the Argo Workflow Package's UUID as the
 identifier.

Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.

Create VersionSet

Gets a single PackageVersionSet

A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.

A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.

PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.

Examples of PackageVersionSet identifiers:

* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
 Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
 the Argo Workflows Package, using the Argo Workflow Package's UUID as the
 identifier.

Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.

Get VersionSet

Update an existing PackageVersionSet

A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.

A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.

PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.

Examples of PackageVersionSet identifiers:

* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
 Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
 the Argo Workflows Package, using the Argo Workflow Package's UUID as the
 identifier.

Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.

Update VersionSet

Delete a PackageVersionSet

A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.

A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.

PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.

Examples of PackageVersionSet identifiers:

* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
 Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
 the Argo Workflows Package, using the Argo Workflow Package's UUID as the
 identifier.

Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.

Delete VersionSet

List multiple PackageComponents

A Package has zero or more *PackageComponents*. A PackageComponent is a
separate Project, ProjectComponent, daemon, subsystem or binary distributed as
part of a PackageVersionSet.

A PackageComponent is uniquely identified by the combination of the
PackageVersionSet identifier and the Component name separated by a :
character. The Component name may be a Project identifier, a URL or
filepath-like identifier or just a string name.

Examples of PackageComponent identifiers:

* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a:1:agent: The agent Component of
 the first versionset (:1) of the Cilium Helm Chart Package specified by
 that Package's UUID.
* helm-kube-prometheus-stack:3:prometheus-operator: The prometheus-operator
 Component of the third versionset (:3) of the Kube Prometheus Helm Chart
 Package specified by that Package's Alias (helm-kube-prometheus-stack)

> **IMPORTANT**: For Packages using the helm or kube PackageSystem, these
> PackageComponents represent a Kubernetes Resource (Deployment, DaemonSet
> or StatefulSet) that is installed by the Package.

Simple examples of PackageComponents would be the Bitnami Cert-Manager Helm
Chart Package's controller Deployment, the webhook Deployment and the
cainjector Deployment.

More complex examples of PackageComponents might be the ArgoCD Official
Upstream Helm Chart Package's extensive collection of controllers, caches and
persistent database storage components installed in Deployment, Daemonset and
StatefulSet resources.

List Components

Create a new PackageComponent

A Package has zero or more *PackageComponents*. A PackageComponent is a
separate Project, ProjectComponent, daemon, subsystem or binary distributed as
part of a PackageVersionSet.

A PackageComponent is uniquely identified by the combination of the
PackageVersionSet identifier and the Component name separated by a :
character. The Component name may be a Project identifier, a URL or
filepath-like identifier or just a string name.

Examples of PackageComponent identifiers:

* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a:1:agent: The agent Component of
 the first versionset (:1) of the Cilium Helm Chart Package specified by
 that Package's UUID.
* helm-kube-prometheus-stack:3:prometheus-operator: The prometheus-operator
 Component of the third versionset (:3) of the Kube Prometheus Helm Chart
 Package specified by that Package's Alias (helm-kube-prometheus-stack)

> **IMPORTANT**: For Packages using the helm or kube PackageSystem, these
> PackageComponents represent a Kubernetes Resource (Deployment, DaemonSet
> or StatefulSet) that is installed by the Package.

Simple examples of PackageComponents would be the Bitnami Cert-Manager Helm
Chart Package's controller Deployment, the webhook Deployment and the
cainjector Deployment.

More complex examples of PackageComponents might be the ArgoCD Official
Upstream Helm Chart Package's extensive collection of controllers, caches and
persistent database storage components installed in Deployment, Daemonset and
StatefulSet resources.

Create Component

Gets a single PackageComponent

A Package has zero or more *PackageComponents*. A PackageComponent is a
separate Project, ProjectComponent, daemon, subsystem or binary distributed as
part of a PackageVersionSet.

A PackageComponent is uniquely identified by the combination of the
PackageVersionSet identifier and the Component name separated by a :
character. The Component name may be a Project identifier, a URL or
filepath-like identifier or just a string name.

Examples of PackageComponent identifiers:

* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a:1:agent: The agent Component of
 the first versionset (:1) of the Cilium Helm Chart Package specified by
 that Package's UUID.
* helm-kube-prometheus-stack:3:prometheus-operator: The prometheus-operator
 Component of the third versionset (:3) of the Kube Prometheus Helm Chart
 Package specified by that Package's Alias (helm-kube-prometheus-stack)

> **IMPORTANT**: For Packages using the helm or kube PackageSystem, these
> PackageComponents represent a Kubernetes Resource (Deployment, DaemonSet
> or StatefulSet) that is installed by the Package.

Simple examples of PackageComponents would be the Bitnami Cert-Manager Helm
Chart Package's controller Deployment, the webhook Deployment and the
cainjector Deployment.

More complex examples of PackageComponents might be the ArgoCD Official
Upstream Helm Chart Package's extensive collection of controllers, caches and
persistent database storage components installed in Deployment, Daemonset and
StatefulSet resources.

Get Component

Update an existing PackageComponent

A Package has zero or more *PackageComponents*. A PackageComponent is a
separate Project, ProjectComponent, daemon, subsystem or binary distributed as
part of a PackageVersionSet.

A PackageComponent is uniquely identified by the combination of the
PackageVersionSet identifier and the Component name separated by a :
character. The Component name may be a Project identifier, a URL or
filepath-like identifier or just a string name.

Examples of PackageComponent identifiers:

* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a:1:agent: The agent Component of
 the first versionset (:1) of the Cilium Helm Chart Package specified by
 that Package's UUID.
* helm-kube-prometheus-stack:3:prometheus-operator: The prometheus-operator
 Component of the third versionset (:3) of the Kube Prometheus Helm Chart
 Package specified by that Package's Alias (helm-kube-prometheus-stack)

> **IMPORTANT**: For Packages using the helm or kube PackageSystem, these
> PackageComponents represent a Kubernetes Resource (Deployment, DaemonSet
> or StatefulSet) that is installed by the Package.

Simple examples of PackageComponents would be the Bitnami Cert-Manager Helm
Chart Package's controller Deployment, the webhook Deployment and the
cainjector Deployment.

More complex examples of PackageComponents might be the ArgoCD Official
Upstream Helm Chart Package's extensive collection of controllers, caches and
persistent database storage components installed in Deployment, Daemonset and
StatefulSet resources.

Update Component

Delete a PackageComponent

A Package has zero or more *PackageComponents*. A PackageComponent is a
separate Project, ProjectComponent, daemon, subsystem or binary distributed as
part of a PackageVersionSet.

A PackageComponent is uniquely identified by the combination of the
PackageVersionSet identifier and the Component name separated by a :
character. The Component name may be a Project identifier, a URL or
filepath-like identifier or just a string name.

Examples of PackageComponent identifiers:

* pkg_aae8471b-cf66-41d0-b72b-b44d3278d35a:1:agent: The agent Component of
 the first versionset (:1) of the Cilium Helm Chart Package specified by
 that Package's UUID.
* helm-kube-prometheus-stack:3:prometheus-operator: The prometheus-operator
 Component of the third versionset (:3) of the Kube Prometheus Helm Chart
 Package specified by that Package's Alias (helm-kube-prometheus-stack)

> **IMPORTANT**: For Packages using the helm or kube PackageSystem, these
> PackageComponents represent a Kubernetes Resource (Deployment, DaemonSet
> or StatefulSet) that is installed by the Package.

Simple examples of PackageComponents would be the Bitnami Cert-Manager Helm
Chart Package's controller Deployment, the webhook Deployment and the
cainjector Deployment.

More complex examples of PackageComponents might be the ArgoCD Official
Upstream Helm Chart Package's extensive collection of controllers, caches and
persistent database storage components installed in Deployment, Daemonset and
StatefulSet resources.

Delete Component

List multiple Projects

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string
proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form.
They can be a URL, like github.com/kubernetes/kubernetes or a short string
like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

* platform: The Project represents a software platform, such as the
 Kubernetes Project itself.
* kube-addon: The Project represents a Kubernetes Addon, which is defined as
 some software that extends the functionality of the Kubernetes cluster and
 its API.
* kube-operator: The Project represents a Kubernetes [Operator][operator],
 which is defined as software written specifically against the Kubernetes API
 and is responsible for installing and managing the lifecycle of a Kubernetes
 Addon or Application Service.
* kube-control-plane-provider: The Project represents a Kubernetes control
 plane service, such as RKE, GKE or EKS.
* application-service: The Project represents application code that provides
 essential services to the rest of the application stack.
* application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of
Projects is described by the Package model.

List Projects

Create a new Project

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string
proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form.
They can be a URL, like github.com/kubernetes/kubernetes or a short string
like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

* platform: The Project represents a software platform, such as the
 Kubernetes Project itself.
* kube-addon: The Project represents a Kubernetes Addon, which is defined as
 some software that extends the functionality of the Kubernetes cluster and
 its API.
* kube-operator: The Project represents a Kubernetes [Operator][operator],
 which is defined as software written specifically against the Kubernetes API
 and is responsible for installing and managing the lifecycle of a Kubernetes
 Addon or Application Service.
* kube-control-plane-provider: The Project represents a Kubernetes control
 plane service, such as RKE, GKE or EKS.
* application-service: The Project represents application code that provides
 essential services to the rest of the application stack.
* application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of
Projects is described by the Package model.

Create Project

Gets a single Project

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string
proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form.
They can be a URL, like github.com/kubernetes/kubernetes or a short string
like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

* platform: The Project represents a software platform, such as the
 Kubernetes Project itself.
* kube-addon: The Project represents a Kubernetes Addon, which is defined as
 some software that extends the functionality of the Kubernetes cluster and
 its API.
* kube-operator: The Project represents a Kubernetes [Operator][operator],
 which is defined as software written specifically against the Kubernetes API
 and is responsible for installing and managing the lifecycle of a Kubernetes
 Addon or Application Service.
* kube-control-plane-provider: The Project represents a Kubernetes control
 plane service, such as RKE, GKE or EKS.
* application-service: The Project represents application code that provides
 essential services to the rest of the application stack.
* application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of
Projects is described by the Package model.

Get Project

Update an existing Project

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string
proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form.
They can be a URL, like github.com/kubernetes/kubernetes or a short string
like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

* platform: The Project represents a software platform, such as the
 Kubernetes Project itself.
* kube-addon: The Project represents a Kubernetes Addon, which is defined as
 some software that extends the functionality of the Kubernetes cluster and
 its API.
* kube-operator: The Project represents a Kubernetes [Operator][operator],
 which is defined as software written specifically against the Kubernetes API
 and is responsible for installing and managing the lifecycle of a Kubernetes
 Addon or Application Service.
* kube-control-plane-provider: The Project represents a Kubernetes control
 plane service, such as RKE, GKE or EKS.
* application-service: The Project represents application code that provides
 essential services to the rest of the application stack.
* application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of
Projects is described by the Package model.

Update Project

Delete a Project

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string
proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form.
They can be a URL, like github.com/kubernetes/kubernetes or a short string
like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

* platform: The Project represents a software platform, such as the
 Kubernetes Project itself.
* kube-addon: The Project represents a Kubernetes Addon, which is defined as
 some software that extends the functionality of the Kubernetes cluster and
 its API.
* kube-operator: The Project represents a Kubernetes [Operator][operator],
 which is defined as software written specifically against the Kubernetes API
 and is responsible for installing and managing the lifecycle of a Kubernetes
 Addon or Application Service.
* kube-control-plane-provider: The Project represents a Kubernetes control
 plane service, such as RKE, GKE or EKS.
* application-service: The Project represents application code that provides
 essential services to the rest of the application stack.
* application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of
Projects is described by the Package model.

Delete Project

List multiple ProjectReleases

A Project may have one or more ProjectReleases. A ProjectRelease is
the coordinated publication of one or more Packages for the Project having the
same Version string.

A ProjectRelease is always associated with a single ProjectRelease.

A ProjectRelease is uniquely identified by the combination of the Project
identifier and the Version string, separated by an '@' character, e.g.
proj_a858f4d4-6e5b-4ab5-8d92-e9715b584ec1@1.5.12

A ProjectRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the ProjectRelease.

Create a new ProjectRelease

A Project may have one or more ProjectReleases. A ProjectRelease is
the coordinated publication of one or more Packages for the Project having the
same Version string.

A ProjectRelease is always associated with a single ProjectRelease.

A ProjectRelease is uniquely identified by the combination of the Project
identifier and the Version string, separated by an '@' character, e.g.
proj_a858f4d4-6e5b-4ab5-8d92-e9715b584ec1@1.5.12

A ProjectRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the ProjectRelease.

Gets a single ProjectRelease

A Project may have one or more ProjectReleases. A ProjectRelease is
the coordinated publication of one or more Packages for the Project having the
same Version string.

A ProjectRelease is always associated with a single ProjectRelease.

A ProjectRelease is uniquely identified by the combination of the Project
identifier and the Version string, separated by an '@' character, e.g.
proj_a858f4d4-6e5b-4ab5-8d92-e9715b584ec1@1.5.12

A ProjectRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the ProjectRelease.

Update an existing ProjectRelease

A Project may have one or more ProjectReleases. A ProjectRelease is
the coordinated publication of one or more Packages for the Project having the
same Version string.

A ProjectRelease is always associated with a single ProjectRelease.

A ProjectRelease is uniquely identified by the combination of the Project
identifier and the Version string, separated by an '@' character, e.g.
proj_a858f4d4-6e5b-4ab5-8d92-e9715b584ec1@1.5.12

A ProjectRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the ProjectRelease.

Delete a ProjectRelease

A Project may have one or more ProjectReleases. A ProjectRelease is
the coordinated publication of one or more Packages for the Project having the
same Version string.

A ProjectRelease is always associated with a single ProjectRelease.

A ProjectRelease is uniquely identified by the combination of the Project
identifier and the Version string, separated by an '@' character, e.g.
proj_a858f4d4-6e5b-4ab5-8d92-e9715b584ec1@1.5.12

A ProjectRelease can have zero or more Changes associated with it that describe
the bug fixes and new features that were included in the ProjectRelease.

List multiple ProjectReleaseSeries

A Project may have one or more ProjectReleaseSeries. A
ProjectReleaseSeries describes a single release series for a Project.

ProjectReleaseSeries are identified by a simple string that must be unique
for the Project. Typically the ProjectReleaseSeries Name will be a major or
major.minor version series, e.g. "4" or "1.28", however this is not
universally true. Some Projects use date-based names like "2024.04".

A ProjectReleaseSeries has a PublishedOn date which indicates when the
release was originally "cut".

List ReleaseSeries

Create a new ProjectReleaseSeries

A Project may have one or more ProjectReleaseSeries. A
ProjectReleaseSeries describes a single release series for a Project.

ProjectReleaseSeries are identified by a simple string that must be unique
for the Project. Typically the ProjectReleaseSeries Name will be a major or
major.minor version series, e.g. "4" or "1.28", however this is not
universally true. Some Projects use date-based names like "2024.04".

A ProjectReleaseSeries has a PublishedOn date which indicates when the
release was originally "cut".

Create ReleaseSeries

Gets a single ProjectReleaseSeries

A Project may have one or more ProjectReleaseSeries. A
ProjectReleaseSeries describes a single release series for a Project.

ProjectReleaseSeries are identified by a simple string that must be unique
for the Project. Typically the ProjectReleaseSeries Name will be a major or
major.minor version series, e.g. "4" or "1.28", however this is not
universally true. Some Projects use date-based names like "2024.04".

A ProjectReleaseSeries has a PublishedOn date which indicates when the
release was originally "cut".

Get ReleaseSeries

Update an existing ProjectReleaseSeries

A Project may have one or more ProjectReleaseSeries. A
ProjectReleaseSeries describes a single release series for a Project.

ProjectReleaseSeries are identified by a simple string that must be unique
for the Project. Typically the ProjectReleaseSeries Name will be a major or
major.minor version series, e.g. "4" or "1.28", however this is not
universally true. Some Projects use date-based names like "2024.04".

A ProjectReleaseSeries has a PublishedOn date which indicates when the
release was originally "cut".

Update ReleaseSeries

Delete a ProjectReleaseSeries

A Project may have one or more ProjectReleaseSeries. A
ProjectReleaseSeries describes a single release series for a Project.

ProjectReleaseSeries are identified by a simple string that must be unique
for the Project. Typically the ProjectReleaseSeries Name will be a major or
major.minor version series, e.g. "4" or "1.28", however this is not
universally true. Some Projects use date-based names like "2024.04".

A ProjectReleaseSeries has a PublishedOn date which indicates when the
release was originally "cut".

Delete ReleaseSeries

List multiple ProjectVersionSets

A ProjectVersionSet represents a configuration, layout or structure of
a Project that is consistent for a range of ProjectReleases.

A ProjectComponent is associated with a single ProjectVersionSet. We track
changes to the componentry and structure of a Project over time using
ProjectVersionSets.

ProjectVersionSets are uniquely identified by the Project ID or Alias and
a simple integer, separated by a ':' character.

Examples of ProjectVersionSet identifiers:

* argo-workflows:1: the first ProjectVersionSet of the Argo Workflows
 Project, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of
 the Argo Workflows Project, using the Argo Workflow Project's UUID as the
 identifier.

Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which ProjectReleases the ProjectVersionSet describes.

Create a new ProjectVersionSet

A ProjectVersionSet represents a configuration, layout or structure of
a Project that is consistent for a range of ProjectReleases.

A ProjectComponent is associated with a single ProjectVersionSet. We track
changes to the componentry and structure of a Project over time using
ProjectVersionSets.

ProjectVersionSets are uniquely identified by the Project ID or Alias and
a simple integer, separated by a ':' character.

Examples of ProjectVersionSet identifiers:

* argo-workflows:1: the first ProjectVersionSet of the Argo Workflows
 Project, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of
 the Argo Workflows Project, using the Argo Workflow Project's UUID as the
 identifier.

Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which ProjectReleases the ProjectVersionSet describes.

Gets a single ProjectVersionSet

A ProjectVersionSet represents a configuration, layout or structure of
a Project that is consistent for a range of ProjectReleases.

A ProjectComponent is associated with a single ProjectVersionSet. We track
changes to the componentry and structure of a Project over time using
ProjectVersionSets.

ProjectVersionSets are uniquely identified by the Project ID or Alias and
a simple integer, separated by a ':' character.

Examples of ProjectVersionSet identifiers:

* argo-workflows:1: the first ProjectVersionSet of the Argo Workflows
 Project, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of
 the Argo Workflows Project, using the Argo Workflow Project's UUID as the
 identifier.

Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which ProjectReleases the ProjectVersionSet describes.

Update an existing ProjectVersionSet

A ProjectVersionSet represents a configuration, layout or structure of
a Project that is consistent for a range of ProjectReleases.

A ProjectComponent is associated with a single ProjectVersionSet. We track
changes to the componentry and structure of a Project over time using
ProjectVersionSets.

ProjectVersionSets are uniquely identified by the Project ID or Alias and
a simple integer, separated by a ':' character.

Examples of ProjectVersionSet identifiers:

* argo-workflows:1: the first ProjectVersionSet of the Argo Workflows
 Project, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of
 the Argo Workflows Project, using the Argo Workflow Project's UUID as the
 identifier.

Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which ProjectReleases the ProjectVersionSet describes.

Delete a ProjectVersionSet

A ProjectVersionSet represents a configuration, layout or structure of
a Project that is consistent for a range of ProjectReleases.

A ProjectComponent is associated with a single ProjectVersionSet. We track
changes to the componentry and structure of a Project over time using
ProjectVersionSets.

ProjectVersionSets are uniquely identified by the Project ID or Alias and
a simple integer, separated by a ':' character.

Examples of ProjectVersionSet identifiers:

* argo-workflows:1: the first ProjectVersionSet of the Argo Workflows
 Project, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third ProjectVersionSet of
 the Argo Workflows Project, using the Argo Workflow Project's UUID as the
 identifier.

Each ProjectVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which ProjectReleases the ProjectVersionSet describes.

List multiple ProjectComponents

A ProjectComponent is a separate binary, daemon, or subsystem of a
Project.

> **NOTE**: ProjectComponents that are associated with a PackageComponent for a
> Package with PackageSystem kube or helm can be thought of as
> roughly equivalent to OCI/Docker Images, since the ProjectComponent
> describes a container within a Kubernetes Resource described by that
> PackageComponent.

A ProjectComponent is uniquely identified by the combination of a
ProjectVersionSet identifier and the Component name separated by a :
character. The Component name is a simple name indicating the binary, daemon
or subsystem.

Examples of ProjectComponent identifiers:

* argo-workflows:1:workflow-controller: the
 workflow-controller binary of the first versionset of the Argo Workflows
 Project, using the argo-workflows Alias as the Project identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the
 workflow-controller binary of the third ProjectVersionSet of the Argo
 Workflows Project, using the Argo Workflow Project's UUID as the identifier.

Create a new ProjectComponent

A ProjectComponent is a separate binary, daemon, or subsystem of a
Project.

> **NOTE**: ProjectComponents that are associated with a PackageComponent for a
> Package with PackageSystem kube or helm can be thought of as
> roughly equivalent to OCI/Docker Images, since the ProjectComponent
> describes a container within a Kubernetes Resource described by that
> PackageComponent.

A ProjectComponent is uniquely identified by the combination of a
ProjectVersionSet identifier and the Component name separated by a :
character. The Component name is a simple name indicating the binary, daemon
or subsystem.

Examples of ProjectComponent identifiers:

* argo-workflows:1:workflow-controller: the
 workflow-controller binary of the first versionset of the Argo Workflows
 Project, using the argo-workflows Alias as the Project identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the
 workflow-controller binary of the third ProjectVersionSet of the Argo
 Workflows Project, using the Argo Workflow Project's UUID as the identifier.

Gets a single ProjectComponent

A ProjectComponent is a separate binary, daemon, or subsystem of a
Project.

> **NOTE**: ProjectComponents that are associated with a PackageComponent for a
> Package with PackageSystem kube or helm can be thought of as
> roughly equivalent to OCI/Docker Images, since the ProjectComponent
> describes a container within a Kubernetes Resource described by that
> PackageComponent.

A ProjectComponent is uniquely identified by the combination of a
ProjectVersionSet identifier and the Component name separated by a :
character. The Component name is a simple name indicating the binary, daemon
or subsystem.

Examples of ProjectComponent identifiers:

* argo-workflows:1:workflow-controller: the
 workflow-controller binary of the first versionset of the Argo Workflows
 Project, using the argo-workflows Alias as the Project identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the
 workflow-controller binary of the third ProjectVersionSet of the Argo
 Workflows Project, using the Argo Workflow Project's UUID as the identifier.

Update an existing ProjectComponent

A ProjectComponent is a separate binary, daemon, or subsystem of a
Project.

> **NOTE**: ProjectComponents that are associated with a PackageComponent for a
> Package with PackageSystem kube or helm can be thought of as
> roughly equivalent to OCI/Docker Images, since the ProjectComponent
> describes a container within a Kubernetes Resource described by that
> PackageComponent.

A ProjectComponent is uniquely identified by the combination of a
ProjectVersionSet identifier and the Component name separated by a :
character. The Component name is a simple name indicating the binary, daemon
or subsystem.

Examples of ProjectComponent identifiers:

* argo-workflows:1:workflow-controller: the
 workflow-controller binary of the first versionset of the Argo Workflows
 Project, using the argo-workflows Alias as the Project identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the
 workflow-controller binary of the third ProjectVersionSet of the Argo
 Workflows Project, using the Argo Workflow Project's UUID as the identifier.

Delete a ProjectComponent

A ProjectComponent is a separate binary, daemon, or subsystem of a
Project.

> **NOTE**: ProjectComponents that are associated with a PackageComponent for a
> Package with PackageSystem kube or helm can be thought of as
> roughly equivalent to OCI/Docker Images, since the ProjectComponent
> describes a container within a Kubernetes Resource described by that
> PackageComponent.

A ProjectComponent is uniquely identified by the combination of a
ProjectVersionSet identifier and the Component name separated by a :
character. The Component name is a simple name indicating the binary, daemon
or subsystem.

Examples of ProjectComponent identifiers:

* argo-workflows:1:workflow-controller: the
 workflow-controller binary of the first versionset of the Argo Workflows
 Project, using the argo-workflows Alias as the Project identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the
 workflow-controller binary of the third ProjectVersionSet of the Argo
 Workflows Project, using the Argo Workflow Project's UUID as the identifier.

Your Upgrade Copilot for Kubernetes and 100s of Addons

Welcome to Chkk

Understanding Chkk

This Quick Start Guide provides a streamlined, step-by-step process for onboarding to Chkk, ensuring users can quickly start leveraging its risk detection, artifact tracking, and upgrade planning capabilities.

Getting Started

An overview of Chkk Kubernetes Connector — what it is, why you need it, and how to install and configure it.

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

Create KubePlatform

Response