Skip to main content

Retrieves a specified cluster profile summary

GET 
https://api.spectrocloud.com/v1/dashboard/clusterprofiles/:uid

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Retrieves a specified cluster profile summary

Request​

Path Parameters

    uid stringrequired

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

Cluster profile summary response

Schema
    metadata object

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

    annotations object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

    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

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    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 of the resource

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    Populated by the system. Read-only.

    specSummary object

    Cluster profile spec summary

    draft object

    Cluster profile template summary

    cloudTypestring
    packs undefined[]
  • Array [
    • addonTypestring
    annotations object
    property name*string
    displayNamestring
    layerstring

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

    logoUrlstring
    namestring
    packUidstring
    tagstring
    typestring
    versionstring
  • ]
    • typestring
    published object

    Cluster profile template summary

    cloudTypestring
    packs undefined[]
  • Array [
    • addonTypestring
    annotations object
    property name*string
    displayNamestring
    layerstring

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

    logoUrlstring
    namestring
    packUidstring
    tagstring
    typestring
    versionstring
  • ]
    • typestring
    versionstring

    Cluster profile's latest version

    versions undefined[]

    Cluster profile's list of all the versions

  • Array [
    • uidstring
    versionstring
  • ]
    • status object

    ClusterProfileStatusSummary defines the observed state of ClusterProfile

    fips

    Cluster profile fips compliance status

    modestring

    Possible values: [full, none, partial, unknown]

    Default value: none

    inUseClusterUidsstring[]

    Deprecated. Use inUseClusters

    inUseClusters object[]
  • Array [
    • namestring
    uidstring
  • ]
    • isPublishedboolean
    pack object

    Cluster profile packs summary about the deprecated, disabled, deleted packs count

    deletednumber

    Total count of deleted packs in a cluster profile

    deprecatednumber

    Total count of deprecated packs in a cluster profile

    disablednumber

    Total count of disabled packs in a cluster profile

curl -L -X GET 'https://api.spectrocloud.com/v1/dashboard/clusterprofiles/:uid' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— header