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

POST 
https://api.spectrocloud.com/v1/dashboard/clusterprofiles

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 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: <= 20

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

application/json

Body

filter
Cluster profile filter spec
environmentstring[]
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
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

200

An array of cluster profiles summary items

application/json

Schema

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

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.504Z",
        "deletionTimestamp": "2023-12-01T21:31:48.504Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.504Z",
        "name": "string",
        "uid": "string"
      },
      "specSummary": {
        "draft": {
          "cloudType": "string",
          "packs": [
            {
              "addonType": "string",
              "annotations": {},
              "displayName": "string",
              "layer": "kernel",
              "logoUrl": "string",
              "name": "string",
              "packUid": "string",
              "tag": "string",
              "type": "string",
              "version": "string"
            }
          ],
          "type": "string"
        },
        "published": {
          "cloudType": "string",
          "packs": [
            {
              "addonType": "string",
              "annotations": {},
              "displayName": "string",
              "layer": "kernel",
              "logoUrl": "string",
              "name": "string",
              "packUid": "string",
              "tag": "string",
              "type": "string",
              "version": "string"
            }
          ],
          "type": "string"
        },
        "version": "string",
        "versions": [
          {
            "uid": "string",
            "version": "string"
          }
        ]
      },
      "status": {
        "fips": {
          "mode": "none"
        },
        "inUseClusterUids": [
          "string"
        ],
        "inUseClusters": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "isPublished": true,
        "pack": {
          "deleted": 0,
          "deprecated": 0,
          "disabled": 0
        }
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/dashboard/clusterprofiles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "environment": [
      "all"
    ],
    "fips": "none",
    "profileName": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "profileType": [
      "cluster"
    ],
    "scope": "system",
    "tags": {
      "beginsWith": [
        "string"
      ],
      "eq": [
        "string"
      ],
      "ignoreCase": true,
      "ne": [
        "string"
      ]
    },
    "version": {
      "beginsWith": "string",
      "eq": "string",
      "gt": "string",
      "lt": "string",
      "ne": "string"
    }
  },
  "sort": [
    {
      "field": "profileName",
      "order": "asc"
    }
  ]
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

limit — query

offset — query

continue — query

ProjectUid — header

Body

{
  "filter": {
    "environment": [
      "all"
    ],
    "fips": "none",
    "profileName": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "profileType": [
      "cluster"
    ],
    "scope": "system",
    "tags": {
      "beginsWith": [
        "string"
      ],
      "eq": [
        "string"
      ],
      "ignoreCase": true,
      "ne": [
        "string"
      ]
    },
    "version": {
      "beginsWith": "string",
      "eq": "string",
      "gt": "string",
      "lt": "string",
      "ne": "string"
    }
  },
  "sort": [
    {
      "field": "profileName",
      "order": "asc"
    }
  ]
}