Cluster Profiles

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles

summary:

Retrieves a list of cluster profiles

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. 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
continue	string	continue token for the dataset	no

HTTP code: 200
Description: An array of cluster profile items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "draft": {
          "cloudType": "string",
          "packServerRefs": [
            {
              "apiVersion": "string",
              "fieldPath": "string",
              "kind": "string",
              "name": "string",
              "namespace": "string",
              "resourceVersion": "string",
              "uid": "string"
            }
          ],
          "packServerSecret": "string",
          "packs": [
            {
              "annotations": "object",
              "digest": "string",
              "inValidReason": "string",
              "isInvalid": "boolean",
              "layer": "string",
              "name": "string",
              "packUid": "string",
              "params": "object",
              "presets": [
                {
                  "add": "string",
                  "displayName": "string",
                  "group": "string",
                  "name": "string",
                  "remove": [
                    "string"
                  ]
                }
              ],
              "schema": [
                {
                  "format": "string",
                  "hints": [
                    "string"
                  ],
                  "listOptions": [
                    "string"
                  ],
                  "name": "string",
                  "regex": "string",
                  "required": "boolean",
                  "type": "string"
                }
              ],
              "server": "string",
              "tag": "string",
              "values": "string",
              "version": "string"
            }
          ],
          "type": "string",
          "version": "integer"
        },
        "published": {
          "cloudType": "string",
          "packServerRefs": [
            {
              "apiVersion": "string",
              "fieldPath": "string",
              "kind": "string",
              "name": "string",
              "namespace": "string",
              "resourceVersion": "string",
              "uid": "string"
            }
          ],
          "packServerSecret": "string",
          "packs": [
            {
              "annotations": "object",
              "digest": "string",
              "inValidReason": "string",
              "isInvalid": "boolean",
              "layer": "string",
              "name": "string",
              "packUid": "string",
              "params": "object",
              "presets": [
                {
                  "add": "string",
                  "displayName": "string",
                  "group": "string",
                  "name": "string",
                  "remove": [
                    "string"
                  ]
                }
              ],
              "schema": [
                {
                  "format": "string",
                  "hints": [
                    "string"
                  ],
                  "listOptions": [
                    "string"
                  ],
                  "name": "string",
                  "regex": "string",
                  "required": "boolean",
                  "type": "string"
                }
              ],
              "server": "string",
              "tag": "string",
              "values": "string",
              "version": "string"
            }
          ],
          "type": "string",
          "version": "integer"
        }
      },
      "status": {
        "isPublished": "boolean"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer"
  }
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles

summary:

Creates a cluster profile

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "template": {
      "cloudType": "string",
      "packs": [
        {
          "layer": "string",
          "name": "string",
          "tag": "string",
          "uid": "string",
          "values": "string"
        }
      ],
      "type": "string"
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/validate/packs

summary:

Validate cluster profile packs

Body

{
  "cloudType": "string",
  "packs": [
    {
      "layer": "string",
      "name": "string",
      "tag": "string",
      "uid": "string",
      "values": "string"
    }
  ],
  "type": "string"
}

HTTP code: 200
Description: Cluster profile packs validation response
Response body:

{
  "packs": {
    "results": [
      {
        "displayName": "string",
        "errors": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "name": "string"
      }
    ]
  }
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}

summary:

Returns the specified cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes
includePackMeta	string	includes pack meta such as schema, presets	no

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "draft": {
      "cloudType": "string",
      "packServerRefs": [
        {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        }
      ],
      "packServerSecret": "string",
      "packs": [
        {
          "annotations": "object",
          "digest": "string",
          "inValidReason": "string",
          "isInvalid": "boolean",
          "layer": "string",
          "name": "string",
          "packUid": "string",
          "params": "object",
          "presets": [
            {
              "add": "string",
              "displayName": "string",
              "group": "string",
              "name": "string",
              "remove": [
                "string"
              ]
            }
          ],
          "schema": [
            {
              "format": "string",
              "hints": [
                "string"
              ],
              "listOptions": [
                "string"
              ],
              "name": "string",
              "regex": "string",
              "required": "boolean",
              "type": "string"
            }
          ],
          "server": "string",
          "tag": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string",
      "version": "integer"
    },
    "published": {
      "cloudType": "string",
      "packServerRefs": [
        {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        }
      ],
      "packServerSecret": "string",
      "packs": [
        {
          "annotations": "object",
          "digest": "string",
          "inValidReason": "string",
          "isInvalid": "boolean",
          "layer": "string",
          "name": "string",
          "packUid": "string",
          "params": "object",
          "presets": [
            {
              "add": "string",
              "displayName": "string",
              "group": "string",
              "name": "string",
              "remove": [
                "string"
              ]
            }
          ],
          "schema": [
            {
              "format": "string",
              "hints": [
                "string"
              ],
              "listOptions": [
                "string"
              ],
              "name": "string",
              "regex": "string",
              "required": "boolean",
              "type": "string"
            }
          ],
          "server": "string",
          "tag": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string",
      "version": "integer"
    }
  },
  "status": {
    "isPublished": "boolean"
  }
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}

summary:

Updates the specified cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes
includePackMeta	string	includes pack meta such as schema, presets	no

Body

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "template": {
      "cloudType": "string",
      "packs": [
        {
          "layer": "string",
          "name": "string",
          "tag": "string",
          "uid": "string",
          "values": "string"
        }
      ],
      "type": "string"
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}

summary:

Deletes the specified cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes
includePackMeta	string	includes pack meta such as schema, presets	no

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packRefs

summary:

Update cluster profile packs ref

Path parameters:

Name	Type	Description	Required
uid	string		yes
notify	string		no

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs

summary:

Returns the specified cluster profile's packs information

Path parameters:

Name	Type	Description	Required
uid	string		yes
includePackMeta	string	includes pack meta such as schema, presets	no

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "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",
        "name": "string",
        "presets": [
          {
            "add": "string",
            "displayName": "string",
            "group": "string",
            "name": "string",
            "remove": [
              "string"
            ]
          }
        ],
        "registryUid": "string",
        "schema": [
          {
            "format": "string",
            "hints": [
              "string"
            ],
            "listOptions": [
              "string"
            ],
            "name": "string",
            "regex": "string",
            "required": "boolean",
            "type": "string"
          }
        ],
        "values": "string",
        "version": "string"
      },
      "status": "object"
    }
  ]
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/resolvedValues

summary:

Returns the specified cluster profile's packs resolved values

Path parameters:

Name	Type	Description	Required
uid	string		yes
body			no

HTTP code: 200
Description: OK
Response body:

{
  "resolved": "object"
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/{packName}/versions/{packVersion}/values

summary:

Returns the specified cluster profile's pack values

Parameters:

Name	Type	Description	Required
uid	string	cluster profile uid	yes
packName	string	pack name	yes
packVersion	string	pack version	yes
packUid	string	pack uid	yes

HTTP code: 200
Description: An array of cluster profile pack values
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "associatedObject": "string",
        "name": "string",
        "packUid": "string",
        "scope": "string",
        "tag": "string",
        "values": "string",
        "version": "string"
      },
      "status": {
        "isResolved": "boolean"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer"
  }
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/{packName}/versions/{packVersion}/values

summary:

Updates the specified cluster profile pack values

Parameters:

Name	Type	Description	Required
uid	string	cluster profile uid	yes
packName	string	pack name	yes
packVersion	string	pack version	yes

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/{packName}/versions/{packVersion}/values

summary:

Creates a cluster profile pack values

Parameters:

Name	Type	Description	Required
uid	string	cluster profile uid	yes
packName	string	pack name	yes
packVersion	string	pack version	yes
packUid	string	pack uid	yes

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/publish

summary:

Publish the cluster profile

description:

Publish the draft cluster profile with next revision, the current draft cluster profile will be marked to published and the draft cluster profile will be set to null in the cluster profile template.

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: Cluster profile published successfully

Edit on GitHub