Retrieves a list of project summary

GET 
/v1/dashboard/projects

Deprecated: Use POST /v1/dashboard/projects

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

metricPeriod int32

Default value: 60

Metric period in minutes defines latest metrics by period

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

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

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

Project spec summary

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-07-02T18:20:57.836Z",
        "deletionTimestamp": "2024-07-02T18:20:57.836Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-02T18:20:57.836Z",
        "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...