Skip to main content

Retrieves a list of cluster summary with provided search filter spec Supported sort fields - ['environment', 'clusterName', 'memoryUsage', 'healthState', 'creationTimestamp', 'lastModifiedTimestamp']

POST 
https://api.spectrocloud.com/v1/dashboard/spectroclusters/search

Retrieves a list of cluster summary with provided search filter spec Supported sort fields - ["environment", "clusterName", "memoryUsage", "healthState", "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

Body

    filter

    conjunctionstringnullable

    Possible values: [and, or]

    filterGroups

    undefined[]

  • Array [

    • conjunctionstringnullable

    Possible values: [and, or]

    filters

    undefined[]

  • Array [

    • condition

    bool

    valueboolean

    date

    match

    conjunctionstringnullable

    Possible values: [and, or]

    valuesdate-time[]
    negationboolean
    operatorstring

    Possible values: [eq, gt, gte, lt, lte, range]

    float

    match

    conjunctionstringnullable

    Possible values: [and, or]

    valuesfloat64[]
    negationboolean
    operatorstring

    Possible values: [eq, gt, gte, lt, lte]

    int

    match

    conjunctionstringnullable

    Possible values: [and, or]

    valuesinteger[]
    negationboolean
    operatorstring

    Possible values: [eq, gt, gte, lt, lte]

    keyValue

    ignoreCaseboolean
    keystring

    match

    conjunctionstringnullable

    Possible values: [and, or]

    valuesstring[]
    negationboolean
    operatorstring

    Possible values: [eq, contains, beginsWith]

    string

    ignoreCaseboolean

    match

    conjunctionstringnullable

    Possible values: [and, or]

    valuesstring[]
    negationboolean
    operatorstring

    Possible values: [eq, contains, beginsWith]

    propertystring
    typestring

    Possible values: [string, int, float, bool, date, keyValue]

  • ]

  • ]

    • sort

    undefined[]

  • Array [

    • fieldstringnullable

    Possible values: [environment, clusterName, clusterState, healthState, creationTimestamp, lastModifiedTimestamp]

    orderstring

    Possible values: [asc, desc]

    Default value: asc

  • ]

Responses​

An array of cluster 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 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.

    specSummary

    object

    Spectro cluster spec summary

    archTypesstring[]

    Possible values: [amd64, arm64]

    Architecture type of the cluster

    cloudAccountMeta

    object

    Cloud account meta information

    namestring
    uidstring

    cloudConfig

    object

    cloudTypestring

    machinePools

    object[]

    Machine pool meta information

  • Array [

    • cloudTypestring
    healthyint32

    number of healthy machines

    infraProfileTemplate

    object

    Cluster profile template meta information

    cloudTypestring
    namestring

    Cluster profile name

    packs

    object[]

    Cluster profile packs array

  • Array [

    • annotations

    object

    Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml

    property name*string
    digeststring

    digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade

    inValidReasonstring
    isInvalidboolean

    pack is invalid when the associated tag is deleted from the registry

    layerstringrequired

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

    logostring

    path to the pack logo

    manifests

    object[]

  • Array [

    • kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

  • ]

    • namestringrequired

    pack name

    packUidstring

    PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.

    params

    object

    params passed as env variables to be consumed at installation time

    property name*string

    presets

    object[]

  • Array [

    • addstring
    displayNamestring
    groupstring
    namestring
    removestring[]

  • ]

    • registryUidstring

    pack registry uid

    schema

    object[]

  • Array [

    • formatstring
    hintsstring[]
    listOptionsstring[]
    namestring
    readonlyboolean
    regexstring
    requiredboolean
    typestring

  • ]

    • serverstring

    pack registry server or helm repo

    tagstring

    pack tag

    typestring

    Possible values: [spectro, helm, manifest]

    type of the pack

    valuesstring

    values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

    versionstring

    pack version

  • ]

    • scopestring

    scope or context(system, tenant or project)

    typestring

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

    uidstring

    Cluster profile uid

    versionint32
    isControlPlaneboolean

    whether this pool is for control plane

    labelsstring[]

    labels for this pool, example: master/worker, gpu, windows

    maintenanceModeint32

    number of machines under maintenance

    sizeint32

    size of the pool, number of machines

  • ]

    • uidstring

    Cluster's cloud config uid

    clusterConfig

    object

    hostClusterConfig

    clusterGroup

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

    clusterProfileTemplate

    object

    Cluster profile template meta information

    cloudTypestring
    namestring

    Cluster profile name

    packs

    object[]

    Cluster profile packs array

  • Array [

    • annotations

    object

    Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml

    property name*string
    digeststring

    digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade

    inValidReasonstring
    isInvalidboolean

    pack is invalid when the associated tag is deleted from the registry

    layerstringrequired

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

    logostring

    path to the pack logo

    manifests

    object[]

  • Array [

    • kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

  • ]

    • namestringrequired

    pack name

    packUidstring

    PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.

    params

    object

    params passed as env variables to be consumed at installation time

    property name*string

    presets

    object[]

  • Array [

    • addstring
    displayNamestring
    groupstring
    namestring
    removestring[]

  • ]

    • registryUidstring

    pack registry uid

    schema

    object[]

  • Array [

    • formatstring
    hintsstring[]
    listOptionsstring[]
    namestring
    readonlyboolean
    regexstring
    requiredboolean
    typestring

  • ]

    • serverstring

    pack registry server or helm repo

    tagstring

    pack tag

    typestring

    Possible values: [spectro, helm, manifest]

    type of the pack

    valuesstring

    values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

    versionstring

    pack version

  • ]

    • scopestring

    scope or context(system, tenant or project)

    typestring

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

    uidstring

    Cluster profile uid

    versionint32

    clusterProfileTemplates

    object[]

  • Array [

    • cloudTypestring
    namestring

    Cluster profile name

    packs

    object[]

    Cluster profile packs array

  • Array [

    • annotations

    object

    Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml

    property name*string
    digeststring

    digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade

    inValidReasonstring
    isInvalidboolean

    pack is invalid when the associated tag is deleted from the registry

    layerstringrequired

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

    logostring

    path to the pack logo

    manifests

    object[]

  • Array [

    • kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

  • ]

    • namestringrequired

    pack name

    packUidstring

    PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.

    params

    object

    params passed as env variables to be consumed at installation time

    property name*string

    presets

    object[]

  • Array [

    • addstring
    displayNamestring
    groupstring
    namestring
    removestring[]

  • ]

    • registryUidstring

    pack registry uid

    schema

    object[]

  • Array [

    • formatstring
    hintsstring[]
    listOptionsstring[]
    namestring
    readonlyboolean
    regexstring
    requiredboolean
    typestring

  • ]

    • serverstring

    pack registry server or helm repo

    tagstring

    pack tag

    typestring

    Possible values: [spectro, helm, manifest]

    type of the pack

    valuesstring

    values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values

    versionstring

    pack version

  • ]

    • scopestring

    scope or context(system, tenant or project)

    typestring

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

    uidstring

    Cluster profile uid

    versionint32

  • ]

    • projectMeta

    object

    namestring
    uidstring

    status

    Spectro cluster status summary

    clusterImport

    object

    importLinkstring

    import link to download and install ally-lite, palette-lite

    isBrownfieldboolean

    Deprecated. Use the 'spec.clusterType'

    statestring

    cluster import status

    cost

    object

    Resource Cost information

    cloud

    object

    Cloud cost information

    computefloat64
    storagefloat64
    totalfloat64
    totalfloat64

    fips

    modestring

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

    Default value: none

    health

    Spectro cluster health status

    agentVersionstring

    conditions

    undefined[]

  • Array [

    • messagestring

    relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring
    typestring

  • ]

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

    statestring

    hourlyRate

    object

    Resource Cost information

    cloud

    object

    Cloud cost information

    computefloat64
    storagefloat64
    totalfloat64
    totalfloat64

    location

    object

    Cluster location information

    coordinatesfloat64[]
    countryCodestring
    countryNamestring
    regionCodestring
    regionNamestring

    metrics

    Spectro cluster metrics

    cpu

    object

    Compute metrics

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

    limitnumber
    requestnumber
    totalnumber
    unitstring
    usagenumber

    memory

    object

    Compute metrics

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

    limitnumber
    requestnumber
    totalnumber
    unitstring
    usagenumber

    notifications

    Spectro cluster notifications

    isAvailableboolean

    repave

    Cluster repave status

    statestring

    Possible values: [Pending, Approved, Reverted]

    Default value: Pending

    statestring

    virtual

    appDeployments

    object[]

    list of apps deployed on the virtual cluster

  • Array [

    • kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring

  • ]

    • clusterGroup

    object

    Object resource reference

    kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring

    hostCluster

    object

    Object resource reference

    kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring

    lifecycleStatus

    msgstring

    error or success msg of lifecycle

    statusstring

    Possible values: [Pausing, Paused, Resuming, Running, Error]

    lifecycle status

    statestring

    cluster virtual host status

    virtualClusters

    object[]

    list of virtual clusters deployed on the cluster

  • Array [

    • kindstring
    namestring
    projectUidstring
    tenantUidstring
    uidstring

  • ]

  • ]

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

curl -L -X POST 'https://api.spectrocloud.com/v1/dashboard/spectroclusters/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "conjunction": "and",
    "filterGroups": [
      {
        "conjunction": "and",
        "filters": [
          {
            "condition": {
              "bool": {
                "value": true
              },
              "date": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    "2024-04-16T17:48:59.815Z"
                  ]
                },
                "negation": true,
                "operator": "eq"
              },
              "float": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    0
                  ]
                },
                "negation": true,
                "operator": "eq"
              },
              "int": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    0
                  ]
                },
                "negation": true,
                "operator": "eq"
              },
              "keyValue": {
                "ignoreCase": true,
                "key": "string",
                "match": {
                  "conjunction": "and",
                  "values": [
                    "string"
                  ]
                },
                "negation": true,
                "operator": "eq"
              },
              "string": {
                "ignoreCase": true,
                "match": {
                  "conjunction": "and",
                  "values": [
                    "string"
                  ]
                },
                "negation": true,
                "operator": "eq"
              }
            },
            "property": "string",
            "type": "string"
          }
        ]
      }
    ]
  },
  "sort": [
    {
      "field": "environment",
      "order": "asc"
    }
  ]
}'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— query
— query
— query
— header
Body
{

  "filter": {

    "conjunction": "and",

    "filterGroups": [

      {

        "conjunction": "and",

        "filters": [

          {

            "condition": {

              "bool": {

                "value": true

              },

              "date": {

                "match": {

                  "conjunction": "and",

                  "values": [

                    "2024-04-16T17:48:59.815Z"

                  ]

                },

                "negation": true,

                "operator": "eq"

              },

              "float": {

                "match": {

                  "conjunction": "and",

                  "values": [

                    0

                  ]

                },

                "negation": true,

                "operator": "eq"

              },

              "int": {

                "match": {

                  "conjunction": "and",

                  "values": [

                    0

                  ]

                },

                "negation": true,

                "operator": "eq"

              },

              "keyValue": {

                "ignoreCase": true,

                "key": "string",

                "match": {

                  "conjunction": "and",

                  "values": [

                    "string"

                  ]

                },

                "negation": true,

                "operator": "eq"

              },

              "string": {

                "ignoreCase": true,

                "match": {

                  "conjunction": "and",

                  "values": [

                    "string"

                  ]

                },

                "negation": true,

                "operator": "eq"

              }

            },

            "property": "string",

            "type": "string"

          }

        ]

      }

    ]

  },

  "sort": [

    {

      "field": "environment",

      "order": "asc"

    }

  ]

}