Skip to main content

Retrieves a list of cluster profiles filter summary Supported filter fields - ['profileName', 'tags', 'profileType', 'environment'] Supported sort fields - ['profileName', 'environment', 'profileType', 'creationTimestamp', 'lastModifiedTimestamp']

POST 

/v1/dashboard/clusterprofiles

Retrieves a list of cluster profiles filter summary Supported filter fields - ["profileName", "tags", "profileType", "environment"] Supported sort fields - ["profileName", "environment", "profileType", "creationTimestamp", "lastModifiedTimestamp"]

Request

Query Parameters

    limit int64

    Possible values: <= 50

    limit is a maximum number of responses to return for a list call. 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

Body

    filter

    Cluster profile filter spec

    environmentstring[]
    fipsstring

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

    Default value: none

    profileName

    object

    beginsWithstringnullable
    containsstringnullable
    eqstringnullable
    ignoreCaseboolean

    Default value: true

    nestringnullable
    profileTypestring[]

    Possible values: [cluster, infra, add-on, system]

    scopestring

    Possible values: [system, tenant, project]

    tags

    object

    beginsWithstring[]nullable
    eqstring[]nullable
    ignoreCaseboolean

    Default value: true

    nestring[]nullable

    version

    object

    beginsWithstringnullable
    eqstringnullable
    gtstringnullable
    ltstringnullable
    nestringnullable

    sort

    undefined[]

  • Array [

  • fieldstringnullable

    Possible values: [profileName, environment, profileType, creationTimestamp, lastModifiedTimestamp]

    orderstring

    Possible values: [asc, desc]

    Default value: asc

  • ]

Responses

An array of cluster profiles summary items

Schema

    items

    object[]

    required

  • Array [

  • 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

    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

  • ]

  • 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.

Loading...