Package

List Packages

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.

GET

packages

{
  "$schema": "https://example.com/schemas/ListPackagesOutputBody.json",
  "pagination": {
    "continue": "<string>"
  },
  "results": [
    {
      "$schema": "https://example.com/schemas/Package.json",
      "aliases": [
        "helm-prom"
      ],
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "pkg_cec05b17-80d8-498f-8a38-fc8392604a5a",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "system": "helm",
      "title": "Prometheus Helm Chart",
      "versioning": {
        "release_cycle": "regular",
        "release_interval_days": 1,
        "scheme": "semantic",
        "support_model": "rolling"
      }
    }
  ]
}

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.

Create PackageCreate 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.

{
  "$schema": "https://example.com/schemas/ListPackagesOutputBody.json",
  "pagination": {
    "continue": "<string>"
  },
  "results": [
    {
      "$schema": "https://example.com/schemas/Package.json",
      "aliases": [
        "helm-prom"
      ],
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "pkg_cec05b17-80d8-498f-8a38-fc8392604a5a",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "system": "helm",
      "title": "Prometheus Helm Chart",
      "versioning": {
        "release_cycle": "regular",
        "release_interval_days": 1,
        "scheme": "semantic",
        "support_model": "rolling"
      }
    }
  ]
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Packages

Query Parameters

Response