Retrieves a list of packs

GET /v1/packs

Request

Query Parameters

fields string

Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

filters string

Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

Server will be restricted to certain fields based on the indexed data for each resource.

orderBy string

Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

limit int64

Default value: 50

limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

offset int64

offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

continue string

continue token to paginate the subsequent data items

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

An array of pack summary items

application/json

Schema
Example (from schema)

Schema

items

object[]

required

Packs array

Array [

apiVersionstring

Pack api version

kindstring

Pack kind

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

Pack object

addonSubTypestring

Pack add-on sub type such as monitoring, db etc

addonTypestring

Pack add-on type such as logging, monitoring, security etc

annotations

object

Pack annotations is used to allow pack to add more arbitrary configurations

property name*string

cloudTypesstring[]

Pack supported cloud types

digeststring

Pack digest

displayNamestring

Pack display name

eolstring

Pack end of life, date format: yyyy-MM-dd

groupstring

Pack group

layerstring

Possible values: [kernel, os, k8s, cni, csi, addon]

logoUrlstring

Pack logo url

manifests

object[]

Pack manifests are additional content as part of the cluster profile

Array [

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

]

namestring

Pack name

presets

object[]

Pack presets are the set of configurations applied on user selection of presets

Array [

addstring

displayNamestring

groupstring

namestring

removestring[]

]

registryUidstring

Pack registry uid

schema

object[]

Pack schema contains constraints such as data type, format, hints for the pack values

Array [

formatstring

hintsstring[]

listOptionsstring[]

namestring

readonlyboolean

regexstring

requiredboolean

typestring

]

template

Pack template configuration

manifeststring

Pack template manifest content

parameters

Pack template parameters

inputParameters

undefined[]

Pack template input parameters array

Array [

descriptionstring

Pack template parameter description

displayNamestring

Pack template parameter display name

formatstring

Pack template parameter format

hiddenboolean

Pack template parameter hidden flag, if true then the parameter is hidden in the UI

listOptionsstring[]

Pack template parameter list options as string array

namestring

Pack template parameter name

optionalboolean

Pack template parameter optional flag, if true then the parameter value is not mandatory

options

object

Pack template parameter options array

property name*

object

Pack template parameter option

dependencies

object[]

Pack template parameter dependencies

Array [

layerstring

Pack template dependency pack layer

namestring

Pack template dependency pack name

readOnlyboolean

If true then dependency pack values can't be overridden

]

descriptionstring

Pack template parameter description

labelstring

Pack template parameter label

readOnlyboolean

Pack template parameter readonly flag, if true then the parameter value can't be overridden

regexstring

Pack template parameter regex, if set then parameter value must match with specified regex

targetKeystring

Pack template parameter target key which is mapped to the key defined in the pack values

typestring

Pack template parameter data type

valuestring

Pack template parameter value

]

outputParameters

undefined[]

Pack template output parameters array

Array [

descriptionstring

Pack template parameter description

displayNamestring

Pack template parameter display name

formatstring

Pack template parameter format

hiddenboolean

Pack template parameter hidden flag, if true then the parameter is hidden in the UI

listOptionsstring[]

Pack template parameter list options as string array

namestring

Pack template parameter name

optionalboolean

Pack template parameter optional flag, if true then the parameter value is not mandatory

options

object

Pack template parameter options array

property name*

object

Pack template parameter option

dependencies

object[]

Pack template parameter dependencies

Array [

layerstring

Pack template dependency pack layer

namestring

Pack template dependency pack name

readOnlyboolean

If true then dependency pack values can't be overridden

]

descriptionstring

Pack template parameter description

labelstring

Pack template parameter label

readOnlyboolean

Pack template parameter readonly flag, if true then the parameter value can't be overridden

regexstring

Pack template parameter regex, if set then parameter value must match with specified regex

targetKeystring

Pack template parameter target key which is mapped to the key defined in the pack values

typestring

Pack template parameter data type

valuestring

Pack template parameter value

]

valuesstring

Pack template values

typestring

Possible values: [spectro, helm, manifest, oci]

Default value: spectro

valuesstring

Pack values

versionstring

Pack version

statusobject

Pack status

]

listmeta

object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-03T13:23:53.443Z",
        "deletionTimestamp": "2024-07-03T13:23:53.443Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-03T13:23:53.443Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "addonSubType": "string",
        "addonType": "string",
        "annotations": {},
        "cloudTypes": [
          "string"
        ],
        "digest": "string",
        "displayName": "string",
        "eol": "string",
        "group": "string",
        "layer": "kernel",
        "logoUrl": "string",
        "manifests": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "presets": [
          {
            "add": "string",
            "displayName": "string",
            "group": "string",
            "name": "string",
            "remove": [
              "string"
            ]
          }
        ],
        "registryUid": "string",
        "schema": [
          {
            "format": "string",
            "hints": [
              "string"
            ],
            "listOptions": [
              "string"
            ],
            "name": "string",
            "readonly": true,
            "regex": "string",
            "required": true,
            "type": "string"
          }
        ],
        "template": {
          "manifest": "string",
          "parameters": {
            "inputParameters": [
              {
                "description": "string",
                "displayName": "string",
                "format": "string",
                "hidden": true,
                "listOptions": [
                  "string"
                ],
                "name": "string",
                "optional": true,
                "options": {},
                "readOnly": true,
                "regex": "string",
                "targetKey": "string",
                "type": "string",
                "value": "string"
              }
            ],
            "outputParameters": [
              {
                "description": "string",
                "displayName": "string",
                "format": "string",
                "hidden": true,
                "listOptions": [
                  "string"
                ],
                "name": "string",
                "optional": true,
                "options": {},
                "readOnly": true,
                "regex": "string",
                "targetKey": "string",
                "type": "string",
                "value": "string"
              }
            ]
          },
          "values": "string"
        },
        "type": "spectro",
        "values": "string",
        "version": "string"
      },
      "status": {}
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Retrieves a list of packs

/v1/packs

Request​

Query Parameters

Header Parameters

Responses​

Request

Responses