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

application/json

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

200

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

namespacestring

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLinkstring

SelfLink is a URL representing this object. Populated by the system. Read-only.

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

Spectro cluster spec summary

cloudAccountMeta

object

Cloud account meta information

namestring

uidstring

cloudConfig

object

cloudTypestring

Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

Default value: all

machinePools

object[]

Machine pool meta information

Array [

cloudTypestring

Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

Default value: all

healthyint32

number of healthy machines

infraProfileTemplate

object

InfraClusterProfile contains OS/Kernel for this NodePool

cloudTypestring

Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

Default value: all

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]

manifests

object[]

Array [

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

]

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

labelsstring[]

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

sizeint32

size of the pool, number of machines

]

uidstring

Cluster's cloud config uid

clusterConfig

object

hostClusterConfig

HostClusterConfig defines the configuration entity of host clusters config entity

clusterGroup

object

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

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

clusterProfileTemplate

object

Cluster profile template meta information

cloudTypestring

Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

Default value: all

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]

manifests

object[]

Array [

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

]

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

Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]

Default value: all

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]

manifests

object[]

Array [

apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

]

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

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

nested

Deprecated. Use field '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

cluster life cycle status of virtual cluster

msgstring

error or success msg of lifecycle

statusstring

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

lifecycle status

nestedClusters

object[]

Deprecated. Use field 'virtualClusters'

Array [

kindstring

namestring

projectUidstring

tenantUidstring

uidstring

]

statestring

cluster virtual host status

virtualClusters

object[]

list of virtual clusters deployed on the cluster

Array [

kindstring

namestring

projectUidstring

tenantUidstring

uidstring

]

notifications

Spectro cluster notifications

isAvailableboolean

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

cluster life cycle status of virtual cluster

msgstring

error or success msg of lifecycle

statusstring

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

lifecycle status

nestedClusters

object[]

Deprecated. Use field 'virtualClusters'

Array [

kindstring

namestring

projectUidstring

tenantUidstring

uidstring

]

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.

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-02T20:32:02.639Z",
        "deletionTimestamp": "2024-07-02T20:32:02.639Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-02T20:32:02.639Z",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "specSummary": {
        "cloudAccountMeta": {
          "name": "string",
          "uid": "string"
        },
        "cloudConfig": {
          "cloudType": "all",
          "machinePools": [
            {
              "cloudType": "all",
              "healthy": 0,
              "infraProfileTemplate": {
                "cloudType": "all",
                "name": "string",
                "packs": [
                  {
                    "annotations": {},
                    "digest": "string",
                    "inValidReason": "string",
                    "isInvalid": true,
                    "layer": "kernel",
                    "manifests": [
                      {
                        "apiVersion": "string",
                        "fieldPath": "string",
                        "kind": "string",
                        "name": "string",
                        "namespace": "string",
                        "resourceVersion": "string",
                        "uid": "string"
                      }
                    ],
                    "name": "string",
                    "packUid": "string",
                    "params": {},
                    "presets": [
                      {
                        "add": "string",
                        "displayName": "string",
                        "group": "string",
                        "name": "string",
                        "remove": [
                          "string"
                        ]
                      }
                    ],
                    "registryUid": "string",
                    "schema": [
                      {
                        "format": "string",
                        "hints": [
                          "string"
                        ],
                        "listOptions": [
                          "string"
                        ],
                        "name": "string",
                        "readonly": true,
                        "regex": "string",
                        "required": true,
                        "type": "string"
                      }
                    ],
                    "server": "string",
                    "tag": "string",
                    "type": "spectro",
                    "values": "string",
                    "version": "string"
                  }
                ],
                "scope": "string",
                "type": "string",
                "uid": "string",
                "version": 0
              },
              "labels": [
                "string"
              ],
              "size": 0
            }
          ],
          "uid": "string"
        },
        "clusterConfig": {
          "hostClusterConfig": {
            "clusterGroup": {
              "apiVersion": "string",
              "fieldPath": "string",
              "kind": "string",
              "name": "string",
              "namespace": "string",
              "resourceVersion": "string",
              "uid": "string"
            }
          }
        },
        "clusterProfileTemplate": {
          "cloudType": "all",
          "name": "string",
          "packs": [
            {
              "annotations": {},
              "digest": "string",
              "inValidReason": "string",
              "isInvalid": true,
              "layer": "kernel",
              "manifests": [
                {
                  "apiVersion": "string",
                  "fieldPath": "string",
                  "kind": "string",
                  "name": "string",
                  "namespace": "string",
                  "resourceVersion": "string",
                  "uid": "string"
                }
              ],
              "name": "string",
              "packUid": "string",
              "params": {},
              "presets": [
                {
                  "add": "string",
                  "displayName": "string",
                  "group": "string",
                  "name": "string",
                  "remove": [
                    "string"
                  ]
                }
              ],
              "registryUid": "string",
              "schema": [
                {
                  "format": "string",
                  "hints": [
                    "string"
                  ],
                  "listOptions": [
                    "string"
                  ],
                  "name": "string",
                  "readonly": true,
                  "regex": "string",
                  "required": true,
                  "type": "string"
                }
              ],
              "server": "string",
              "tag": "string",
              "type": "spectro",
              "values": "string",
              "version": "string"
            }
          ],
          "scope": "string",
          "type": "string",
          "uid": "string",
          "version": 0
        },
        "clusterProfileTemplates": [
          {
            "cloudType": "all",
            "name": "string",
            "packs": [
              {
                "annotations": {},
                "digest": "string",
                "inValidReason": "string",
                "isInvalid": true,
                "layer": "kernel",
                "manifests": [
                  {
                    "apiVersion": "string",
                    "fieldPath": "string",
                    "kind": "string",
                    "name": "string",
                    "namespace": "string",
                    "resourceVersion": "string",
                    "uid": "string"
                  }
                ],
                "name": "string",
                "packUid": "string",
                "params": {},
                "presets": [
                  {
                    "add": "string",
                    "displayName": "string",
                    "group": "string",
                    "name": "string",
                    "remove": [
                      "string"
                    ]
                  }
                ],
                "registryUid": "string",
                "schema": [
                  {
                    "format": "string",
                    "hints": [
                      "string"
                    ],
                    "listOptions": [
                      "string"
                    ],
                    "name": "string",
                    "readonly": true,
                    "regex": "string",
                    "required": true,
                    "type": "string"
                  }
                ],
                "server": "string",
                "tag": "string",
                "type": "spectro",
                "values": "string",
                "version": "string"
              }
            ],
            "scope": "string",
            "type": "string",
            "uid": "string",
            "version": 0
          }
        ],
        "projectMeta": {
          "name": "string",
          "uid": "string"
        }
      },
      "status": {
        "clusterImport": {
          "importLink": "string",
          "isBrownfield": true,
          "state": "string"
        },
        "cost": {
          "cloud": {
            "compute": 0,
            "storage": 0,
            "total": 0
          },
          "total": 0
        },
        "health": {
          "agentVersion": "string",
          "conditions": [
            {
              "message": "string",
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "type": "string"
            }
          ],
          "lastHeartBeatTimestamp": "2024-07-02T20:32:02.640Z",
          "state": "string"
        },
        "hourlyRate": {
          "cloud": {
            "compute": 0,
            "storage": 0,
            "total": 0
          },
          "total": 0
        },
        "location": {
          "coordinates": [
            0
          ],
          "countryCode": "string",
          "countryName": "string",
          "regionCode": "string",
          "regionName": "string"
        },
        "metrics": {
          "cpu": {
            "lastUpdatedTime": "2024-07-02T20:32:02.640Z",
            "limit": 0,
            "request": 0,
            "total": 0,
            "unit": "string",
            "usage": 0
          },
          "memory": {
            "lastUpdatedTime": "2024-07-02T20:32:02.640Z",
            "limit": 0,
            "request": 0,
            "total": 0,
            "unit": "string",
            "usage": 0
          }
        },
        "nested": {
          "appDeployments": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ],
          "clusterGroup": {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          },
          "hostCluster": {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          },
          "lifecycleStatus": {
            "msg": "string",
            "status": "Pausing"
          },
          "nestedClusters": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ],
          "state": "string",
          "virtualClusters": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ]
        },
        "notifications": {
          "isAvailable": true
        },
        "state": "string",
        "virtual": {
          "appDeployments": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ],
          "clusterGroup": {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          },
          "hostCluster": {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          },
          "lifecycleStatus": {
            "msg": "string",
            "status": "Pausing"
          },
          "nestedClusters": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ],
          "state": "string",
          "virtualClusters": [
            {
              "kind": "string",
              "name": "string",
              "projectUid": "string",
              "tenantUid": "string",
              "uid": "string"
            }
          ]
        }
      }
    }
  ],
  "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/spectroclusters/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filter": {
    "conjunction": "and",
    "filterGroups": [
      {
        "conjunction": "and",
        "filters": [
          {
            "condition": {
              "bool": {
                "value": true
              },
              "date": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    "2024-07-02T20:32:01.628Z"
                  ]
                },
                "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

Parameters

limit — query

offset — query

continue — query

Body

{
  "filter": {
    "conjunction": "and",
    "filterGroups": [
      {
        "conjunction": "and",
        "filters": [
          {
            "condition": {
              "bool": {
                "value": true
              },
              "date": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    "2024-07-02T20:32:01.628Z"
                  ]
                },
                "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"
    }
  ]
}