Export the list of cluster summary with matching search filter and download as a file(csv) Supported sort fields - ['environment', 'clusterName', 'healthState', 'creationTimestamp', 'lastModifiedTimestamp']

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

Export the list of cluster summary with matching search filter and download as a file(csv) Supported sort fields - ["environment", "clusterName", "healthState", "creationTimestamp", "lastModifiedTimestamp"]

Request

Query Parameters

format string

Possible values: [csv]

Default value: csv

Header Parameters

ProjectUid string

Scope the request to the specified project uid

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

download file

Response Headers

• Content-Disposition

  string

application/octet-stream

Schema

Schema

string

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.spectrocloud.com/v1/dashboard/spectroclusters/search/export' \
-H 'Content-Type: application/json' \
-H 'Accept: application/octet-stream' \
-H 'ApiKey: <API_KEY_VALUE>' \
-d '{
  "filter": {
    "conjunction": "and",
    "filterGroups": [
      {
        "conjunction": "and",
        "filters": [
          {
            "condition": {
              "bool": {
                "value": true
              },
              "date": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    "2024-07-29T15:51:28.071Z"
                  ]
                },
                "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

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

format — query

---csv

ProjectUid — header

Body

{
  "filter": {
    "conjunction": "and",
    "filterGroups": [
      {
        "conjunction": "and",
        "filters": [
          {
            "condition": {
              "bool": {
                "value": true
              },
              "date": {
                "match": {
                  "conjunction": "and",
                  "values": [
                    "2024-07-29T15:51:28.071Z"
                  ]
                },
                "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"
    }
  ]
}