Retrieves a list of packs based on filter

POST 
https://api.spectrocloud.com/v1/packs/search

Retrieves a list of packs based on filter

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

Packs filter spec

addOnSubTypestring[]

Pack add-on sub type such as monitoring, db etc

addOnTypestring[]

Pack add-on type such as logging, monitoring, security etc

displayName

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

environmentstring[]

Pack supported cloud types

isFipsboolean

isFips compliant

layerstring[]

Possible values: [kernel, os, k8s, cni, csi, addon]

Pack layer

name

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

registryUidstring[]

Pack registry uid

sourcestring[]

The source filter describes the creation origin/source of the pack. Ex. source can be "spectrocloud" or "community"

statestring[]

Pack state such as deprecated or disabled

typestring[]

Possible values: [spectro, helm, manifest, oci]

Pack type

sort

undefined[]

Array [

fieldstringnullable

Possible values: [name, type, layer, addOnType, displayName]

Packs sort by fields

orderstring

Possible values: [asc, desc]

Default value: asc

]

Responses

200

An array of pack summary items

application/json

Schema

Schema

items

object[]

required

Packs metadata array

Array [

kindstring

Pack kind

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, other than that any input on annotations will be ignored

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 or Tags (UI) 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

object

Pack metadata spec

addonSubTypestring

Pack add-on sub type such as monitoring, db etc

addonTypestring

Pack add-on type such as logging, monitoring, security etc

cloudTypesstring[]

Pack supported cloud types

displayNamestring

Pack display name

groupstring

Pack group

layerstring

Possible values: [kernel, os, k8s, cni, csi, addon]

namestring

Pack name

registries

undefined[]

Pack registries array

Array [

annotations

object

Pack annotations is used to allow pack to add more arbitrary configurations

property name*string

latestPackUidstring

Latest pack uid

latestVersionstring

Pack latest version

logoUrlstring

Pack logo url

namestring

Pack registry name

scopestring

Pack registry scope

uidstring

Pack registry uid

]

typestring

Possible values: [spectro, helm, manifest, oci]

Default value: spectro

]

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": [
    {
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-05T19:05:34.022Z",
        "deletionTimestamp": "2024-07-05T19:05:34.022Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-05T19:05:34.022Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "addonSubType": "string",
        "addonType": "string",
        "cloudTypes": [
          "string"
        ],
        "displayName": "string",
        "group": "string",
        "layer": "kernel",
        "name": "string",
        "registries": [
          {
            "annotations": {},
            "latestPackUid": "string",
            "latestVersion": "string",
            "logoUrl": "string",
            "name": "string",
            "scope": "string",
            "uid": "string"
          }
        ],
        "type": "spectro"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/packs/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "addOnSubType": [
      "string"
    ],
    "addOnType": [
      "string"
    ],
    "displayName": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "environment": [
      "string"
    ],
    "isFips": true,
    "layer": [
      "kernel"
    ],
    "name": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "registryUid": [
      "string"
    ],
    "source": [
      "string"
    ],
    "state": [
      "string"
    ],
    "type": [
      "spectro"
    ]
  },
  "sort": [
    {
      "field": "name",
      "order": "asc"
    }
  ]
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

limit — query

offset — query

continue — query

ProjectUid — header

Body

{
  "filter": {
    "addOnSubType": [
      "string"
    ],
    "addOnType": [
      "string"
    ],
    "displayName": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "environment": [
      "string"
    ],
    "isFips": true,
    "layer": [
      "kernel"
    ],
    "name": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": true,
      "ne": "string"
    },
    "registryUid": [
      "string"
    ],
    "source": [
      "string"
    ],
    "state": [
      "string"
    ],
    "type": [
      "spectro"
    ]
  },
  "sort": [
    {
      "field": "name",
      "order": "asc"
    }
  ]
}