v1ProjectsFilterSummary

POST 
/v1/dashboard/projects

v1ProjectsFilterSummary

Request

Query Parameters

limit int64

Default value: 50

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

Project filter spec

name

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

sort

undefined[]

Array [

fieldstringnullable

Possible values: [name, creationTimestamp, lastModifiedTimestamp]

orderstring

Possible values: [asc, desc]

Default value: asc

]

Responses

200

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

specSummary

object

logoUrlstring

teams

object[]

Array [

namestring

uidstring

]

users

object[]

Array [

namestring

uidstring

]

status

object

Project status summary

clustersHealth

object

Spectro Clusters health data

erroredint32

healthyint32

runningint32

unhealthyint32

status

Project status

cleanUpStatus

object

Project cleanup status

cleanedResourcesstring[]

msgstring

statestring

isDisabledboolean

usage

object

Project usage summary

alloyCpuCoresnumber

clusters

object[]

Array [

cpuCoresnumber

isAlloyboolean

namestring

uidstring

]

pureCpuCoresnumber

]

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-05-03T05:09:17.107Z",
        "deletionTimestamp": "2024-05-03T05:09:17.107Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-05-03T05:09:17.107Z",
        "name": "string",
        "uid": "string"
      },
      "specSummary": {
        "logoUrl": "string",
        "teams": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "users": [
          {
            "name": "string",
            "uid": "string"
          }
        ]
      },
      "status": {
        "clustersHealth": {
          "errored": 0,
          "healthy": 0,
          "running": 0,
          "unhealthy": 0
        },
        "status": {
          "cleanUpStatus": {
            "cleanedResources": [
              "string"
            ],
            "msg": "string",
            "state": "string"
          },
          "isDisabled": true
        },
        "usage": {
          "alloyCpuCores": 0,
          "clusters": [
            {
              "cpuCores": 0,
              "isAlloy": true,
              "name": "string",
              "uid": "string"
            }
          ],
          "pureCpuCores": 0
        }
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...