Skip to main content

Imports a cluster profile

POST 
/v1/clusterprofiles/import

Imports a cluster profile

Request​

Query Parameters

    publish boolean

    If true then cluster profile will be published post successful import

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    metadata

    object

    Cluster profile import metadata

    descriptionstring

    Cluster profile description

    labels

    object

    Cluster profile labels

    property name*string
    namestring

    Cluster profile name

    spec

    object

    Cluster profile import spec

    template

    object

    Cluster profile import template

    cloudTypestring

    Cluster profile cloud type

    packs

    object[]

    Cluster profile packs array

  • Array [

    • layerstring

    Pack layer [ "os", "k8s", "cni", "csi", "addon" ]

    manifests

    object[]

    Pack manifests array

  • Array [

    • contentstring

    Pack manifest content in yaml

    namestring

    Pack manifest name

  • ]

    • namestring

    Pack name

    registry

    object

    Pack registry import entity

    matchingRegistries

    object[]

  • Array [

    • isPrivateboolean

    If true then pack registry is private and is not accessible for the pack sync

    kindstring

    Pack registry kind [ "pack", "helm", "oci" ]

    namestring

    Pack registry name

    providerTypestring

    OCI registry provider type [ "helm", "pack", "zarf" ]

    uidstring

    Pack registry uid

  • ]

    • metadata

    object

    Pack registry metadata

    isPrivateboolean

    If true then pack registry is private and is not accessible for the pack sync

    kindstring

    Pack registry kind [ "pack", "helm", "oci" ]

    namestring

    Pack registry name

    providerTypestring

    OCI registry provider type [ "helm", "pack", "zarf" ]

    uidstring

    Pack registry uid

    tagstring

    Pack version tag

    typestring

    Pack type [ "spectro", "helm", "manifest", "oci" ]

    valuesstring

    Pack values are the customizable configurations for the pack

    versionstring

    Pack version

  • ]

    • typestring

    Cluster profile type [ "cluster", "infra", "add-on", "system" ]

    variables

    object[]

    List of unique variable fields defined for a cluster profile with schema constraints

  • Array [

    • defaultValuestring

    The default value of the variable

    descriptionstring

    Variable description

    displayNamestring

    Unique display name of the variable

    formatstring

    Possible values: [string, number, boolean, ipv4, ipv4cidr, ipv6, version]

    Default value: string

    Format type of the variable value

    hiddenboolean

    If true, then variable will be hidden for overriding the value. By default the hidden flag will be set to false

    immutableboolean

    If true, then variable value can't be editable. By default the immutable flag will be set to false

    isSensitiveboolean

    If true, then default value will be masked. By default the isSensitive flag will be set to false

    namestringrequired

    Variable name

    regexstring

    Regular expression pattern which the variable value must match

    requiredboolean

    Flag to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided

  • ]

    • versionstring

    Cluster profile version

Responses​

Created successfully

Response Headers

  • AuditUid

    string

    Audit uid for the request

Schema

    uidstringrequired
Loading...