Skip to main content

Returns the specified pack

GET 

/v1/packs/:uid

Returns the specified pack

Request

Path Parameters

    uid stringrequired

    Pack uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

A pack for the specified uid

Schema

    addonSubTypestring

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

    addonTypestring

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

    cloudTypesstring[]

    Pack supported cloud types

    displayNamestring

    Pack display name

    layerstring

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

    logoUrlstring

    Pack logo url

    namestring

    Pack name

    packValues

    object[]

    Pack values array

  • Array [

  • annotations

    object

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

    property name*string

    dependencies

    object[]

    Pack dependencies array

  • Array [

  • displayNamestring

    Pack display name

    logoUrlstring

    Pack logo url

    namestring

    Pack name

    registryUidstring

    Pack registry uid

    uidstring

    Pack uid

    versionstring

    Pack version

  • ]

  • packUidstring

    Pack uid

    presets

    object[]

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

  • Array [

  • addstring
    displayNamestring
    groupstring
    namestring
    removestring[]
  • ]

  • readmestring

    Readme describes the documentation of the specified pack

    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

    valuesstring

    Pack values represents the values.yaml used as input parameters

  • ]

  • registryUidstring

    Pack registry uid

    tags

    object[]

    Pack version tags array

  • Array [

  • groupstring

    Pack group

    packUidstring

    Pack uid

    parentTagsstring[]

    Pack version parent tags

    tagstring

    Pack version tag

    versionstring

    Pack version

  • ]

Loading...