Retrieves a list of cluster summary

POST 
/v1/dashboard/spectroclusters/metadata

Retrieves a list of cluster summary

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter

Spectro cluster filter spec

environmentstring

includeVirtualboolean

Default value: false

isAlloyboolean

Default value: false

isAlloy is renamed to isImported

isImportReadOnlyboolean

Default value: true

isImportedboolean

Default value: false

name

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

statestring
sortstringnullable

Possible values: [environment, state, name]

Responses

200

An array of cluster summary items

application/json

Schema

Schema

items

object[]

required

Array [

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.

]

Example (from schema)

{
  "items": [
    {
      "annotations": {},
      "creationTimestamp": "2024-04-16T17:49:00.844Z",
      "deletionTimestamp": "2024-04-16T17:49:00.844Z",
      "labels": {},
      "lastModifiedTimestamp": "2024-04-16T17:49:00.844Z",
      "name": "string",
      "uid": "string"
    }
  ]
}

Loading...