Retrieves a list of projects

GET 
https://api.spectrocloud.com/v1/projects

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Deprecated: Use POST /v1/dashboard/projects

Request

Query Parameters

fields string

Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

filters string

Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

Server will be restricted to certain fields based on the indexed data for each resource.

orderBy string

Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

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

Responses

200

An array of projects

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.
Populated by the system. Read-only.
spec
Project specifications
alerts object[]
Array [
channels object[]
Array [
alertAllUsersboolean
createdBystring
http object
bodystring
headers
property name*string
methodstring
urlstring
identifiersstring[]
isActiveboolean
status object
isSucceededboolean
messagestring
timedate-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.
typestring
Possible values: [email, app, http]
uidstring
]
componentstring
]
logoUrlstring
teams undefined[]
Array [
rolesstring[]
teamIdstring
]
users undefined[]
Array [
rolesstring[]
userIdstring
]
status
Project status
cleanUpStatus object
Project cleanup status
cleanedResourcesstring[]
msgstring
statestring
isDisabledboolean
]
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": "2023-12-01T21:31:48.696Z",
        "deletionTimestamp": "2023-12-01T21:31:48.696Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.696Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "alerts": [
          {
            "channels": [
              {
                "alertAllUsers": true,
                "createdBy": "string",
                "http": {
                  "body": "string",
                  "method": "string",
                  "url": "string"
                },
                "identifiers": [
                  "string"
                ],
                "isActive": true,
                "status": {
                  "isSucceeded": true,
                  "message": "string",
                  "time": "2023-12-01T21:31:48.696Z"
                },
                "type": "email",
                "uid": "string"
              }
            ],
            "component": "string"
          }
        ],
        "logoUrl": "string",
        "teams": [
          {
            "roles": [
              "string"
            ],
            "teamId": "string"
          }
        ],
        "users": [
          {
            "roles": [
              "string"
            ],
            "userId": "string"
          }
        ]
      },
      "status": {
        "cleanUpStatus": {
          "cleanedResources": [
            "string"
          ],
          "msg": "string",
          "state": "string"
        },
        "isDisabled": true
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X GET 'https://api.spectrocloud.com/v1/projects' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

fields — query

filters — query

orderBy — query

limit — query

offset — query

continue — query

ProjectUid — header