Packs

→

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

summary:

Retrieves a list of pack summaries

Parameters:

Name	Type	Description	Required
fields	string	Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name	no
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.	no
orderBy	string	Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1	no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: An array of pack summary items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "addonType": "string",
        "annotations": "object",
        "cloudTypes": [
          "string"
        ],
        "digest": "string",
        "displayName": "string",
        "eol": "string",
        "group": "string",
        "layer": "string",
        "logoUrl": "string",
        "manifests": [
          {
            "apiVersion": "string",
            "fieldPath": "string",
            "kind": "string",
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "presets": [
          {
            "add": "string",
            "displayName": "string",
            "group": "string",
            "name": "string",
            "remove": [
              "string"
            ]
          }
        ],
        "registryUid": "string",
        "schema": [
          {
            "format": "string",
            "hints": [
              "string"
            ],
            "listOptions": [
              "string"
            ],
            "name": "string",
            "readonly": "boolean",
            "regex": "string",
            "required": "boolean",
            "type": "string"
          }
        ],
        "type": "string",
        "values": "string",
        "version": "string"
      },
      "status": "object"
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

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

summary:

Delete all the pack summaries

Parameters:

Name	Type	Description	Required
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.	no

HTTP code: 200
Description: (empty)
Response body:

{
  "count": "integer",
  "items": "object"
}

→

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

summary:

Retrieves a list of packs based on filter

Parameters:

Name	Type	Description	Required
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

Body

{
  "filter": {
    "addOnType": [
      "string"
    ],
    "displayName": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": "boolean",
      "ne": "string"
    },
    "environment": [
      "string"
    ],
    "layer": [
      "string"
    ],
    "name": {
      "beginsWith": "string",
      "contains": "string",
      "eq": "string",
      "ignoreCase": "boolean",
      "ne": "string"
    },
    "registryUid": [
      "string"
    ],
    "type": [
      "string"
    ]
  },
  "sort": [
    {
      "field": "string",
      "order": "string"
    }
  ]
}

HTTP code: 200
Description: An array of pack summary items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "addonType": "string",
        "cloudTypes": [
          "string"
        ],
        "displayName": "string",
        "group": "string",
        "layer": "string",
        "name": "string",
        "registries": [
          {
            "annotations": "object",
            "logoUrl": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "type": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/packs/{packName}/registries/{registryUid}

summary:

Retrieves a list of packs by tags

Path parameters:

Name	Type	Description	Required
registryUid	string		yes
packName	string	pack name	yes
cloudType	string		no
layer	string		no

HTTP code: 200
Description: Pack items organized by tags
Response body:

{
  "addonType": "string",
  "cloudTypes": [
    "string"
  ],
  "displayName": "string",
  "layer": "string",
  "logoUrl": "string",
  "name": "string",
  "packValues": [
    {
      "packUid": "string",
      "presets": [
        {
          "add": "string",
          "displayName": "string",
          "group": "string",
          "name": "string",
          "remove": [
            "string"
          ]
        }
      ],
      "schema": [
        {
          "format": "string",
          "hints": [
            "string"
          ],
          "listOptions": [
            "string"
          ],
          "name": "string",
          "readonly": "boolean",
          "regex": "string",
          "required": "boolean",
          "type": "string"
        }
      ],
      "values": "string"
    }
  ],
  "registryUid": "string",
  "tags": [
    {
      "group": "string",
      "packUid": "string",
      "parentTags": [
        "string"
      ],
      "tag": "string",
      "version": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/packs/{uid}

summary:

Returns the specified pack for uid

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: A pack for the specified uid
Response body:

{
  "addonType": "string",
  "cloudTypes": [
    "string"
  ],
  "displayName": "string",
  "layer": "string",
  "logoUrl": "string",
  "name": "string",
  "packValues": [
    {
      "packUid": "string",
      "presets": [
        {
          "add": "string",
          "displayName": "string",
          "group": "string",
          "name": "string",
          "remove": [
            "string"
          ]
        }
      ],
      "schema": [
        {
          "format": "string",
          "hints": [
            "string"
          ],
          "listOptions": [
            "string"
          ],
          "name": "string",
          "readonly": "boolean",
          "regex": "string",
          "required": "boolean",
          "type": "string"
        }
      ],
      "values": "string"
    }
  ],
  "registryUid": "string",
  "tags": [
    {
      "group": "string",
      "packUid": "string",
      "parentTags": [
        "string"
      ],
      "tag": "string",
      "version": "string"
    }
  ]
}

Edit on GitHub