Cluster Profiles

→

https://api.spectrocloud.com/v1/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. 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 cluster profile 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": {
        "draft": {
          "cloudType": "string",
          "name": "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",
              "manifests": [
                {
                  "apiVersion": "string",
                  "fieldPath": "string",
                  "kind": "string",
                  "name": "string",
                  "namespace": "string",
                  "resourceVersion": "string",
                  "uid": "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",
                  "readonly": "boolean",
                  "regex": "string",
                  "required": "boolean",
                  "type": "string"
                }
              ],
              "server": "string",
              "tag": "string",
              "type": "string",
              "values": "string",
              "version": "string"
            }
          ],
          "type": "string",
          "uid": "string",
          "version": "integer"
        },
        "published": {
          "cloudType": "string",
          "name": "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",
              "manifests": [
                {
                  "apiVersion": "string",
                  "fieldPath": "string",
                  "kind": "string",
                  "name": "string",
                  "namespace": "string",
                  "resourceVersion": "string",
                  "uid": "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",
                  "readonly": "boolean",
                  "regex": "string",
                  "required": "boolean",
                  "type": "string"
                }
              ],
              "server": "string",
              "tag": "string",
              "type": "string",
              "values": "string",
              "version": "string"
            }
          ],
          "type": "string",
          "uid": "string",
          "version": "integer"
        }
      },
      "status": {
        "inUseClusterUids": [
          "string"
        ],
        "isPublished": "boolean"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

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

summary:

Creates a cluster profile

Body

{
  "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": {
    "template": {
      "cloudType": "string",
      "packs": [
        {
          "layer": "string",
          "manifests": [
            {
              "content": "string",
              "name": "string"
            }
          ],
          "name": "string",
          "registryUid": "string",
          "tag": "string",
          "type": "string",
          "uid": "string",
          "values": "string"
        }
      ],
      "type": "string"
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/clusterprofiles/macros

summary:

List all macros

HTTP code: 200
Description: OK
Response body:

{
  "macros": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

→

https://api.spectrocloud.com/v1/clusterprofiles/validate/name

summary:

Validates the clusterprofiles name

Parameters:

Name	Type	Description	Required
name	string		no

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

Validate cluster profile packs

Body

{
  "cloudType": "string",
  "packs": [
    {
      "layer": "string",
      "manifests": [
        {
          "content": "string",
          "name": "string"
        }
      ],
      "name": "string",
      "registryUid": "string",
      "tag": "string",
      "type": "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/v1/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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "draft": {
      "cloudType": "string",
      "name": "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",
          "manifests": [
            {
              "apiVersion": "string",
              "fieldPath": "string",
              "kind": "string",
              "name": "string",
              "namespace": "string",
              "resourceVersion": "string",
              "uid": "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",
              "readonly": "boolean",
              "regex": "string",
              "required": "boolean",
              "type": "string"
            }
          ],
          "server": "string",
          "tag": "string",
          "type": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string",
      "uid": "string",
      "version": "integer"
    },
    "published": {
      "cloudType": "string",
      "name": "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",
          "manifests": [
            {
              "apiVersion": "string",
              "fieldPath": "string",
              "kind": "string",
              "name": "string",
              "namespace": "string",
              "resourceVersion": "string",
              "uid": "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",
              "readonly": "boolean",
              "regex": "string",
              "required": "boolean",
              "type": "string"
            }
          ],
          "server": "string",
          "tag": "string",
          "type": "string",
          "values": "string",
          "version": "string"
        }
      ],
      "type": "string",
      "uid": "string",
      "version": "integer"
    }
  },
  "status": {
    "inUseClusterUids": [
      "string"
    ],
    "isPublished": "boolean"
  }
}

→

https://api.spectrocloud.com/v1/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",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "template": {
      "packs": [
        {
          "layer": "string",
          "manifests": [
            {
              "content": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "name": "string",
          "registryUid": "string",
          "tag": "string",
          "type": "string",
          "uid": "string",
          "values": "string"
        }
      ],
      "type": "string"
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/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/v1/clusterprofiles/{uid}/clone

summary:

Clone the specified cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "name": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/clusterprofiles/{uid}/metadata

summary:

Updates the specified cluster profile metadata

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Update cluster profile packs ref

Path parameters:

Name	Type	Required
uid	string	yes
notify	string	no
body		no

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/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",
        "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"
    }
  ]
}

→

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

summary:

Adds a new packs to the profile and returns the created pack uid

Path parameters:

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

Body

{
  "pack": {
    "layer": "string",
    "manifests": [
      {
        "content": "string",
        "name": "string"
      }
    ],
    "name": "string",
    "registryUid": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Returns the specified cluster profile's packs manifests 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:

{
  "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": {
    "packs": [
      {
        "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": [
            {
              "content": "string",
              "name": "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"
      }
    ]
  }
}

→

https://api.spectrocloud.com/v1/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/v1/clusterprofiles/{uid}/packs/{packName}

summary:

Updates the specified pack information in the cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes
packName	string		yes

Body

{
  "pack": {
    "layer": "string",
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Deletes the specified pack information in the cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes
packName	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

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

summary:

Returns the specified cluster profile's pack configuration

Parameters:

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

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

{
  "items": [
    {
      "spec": {
        "associatedObject": "string",
        "isValuesOverridden": "boolean",
        "manifests": [
          {
            "digest": "string",
            "isOverridden": "boolean",
            "name": "string",
            "parentUid": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "packUid": "string",
        "scope": "string",
        "tag": "string",
        "values": "string",
        "version": "string"
      }
    }
  ]
}

→

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

summary:

Returns the associated manifests for the specified profile's pack

Path parameters:

Name	Type	Description	Required
uid	string		yes
packName	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "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": {
        "draft": {
          "content": "string",
          "digest": "string"
        },
        "published": {
          "content": "string",
          "digest": "string"
        }
      }
    }
  ]
}

→

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

summary:

Adds manifest to the profiles packs and returns the added manifests uid

Path parameters:

Name	Type	Description	Required
uid	string		yes
packName	string		yes

Body

{
  "content": "string",
  "name": "string"
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/clusterprofiles/{uid}/packs/{packName}/manifests/{manifestUid}

summary:

Returns the specified manifest of the profile's pack

Path parameters:

Name	Type	Required
uid	string	yes
packName	string	yes
manifestUid	string	yes

HTTP code: 200
Description: OK
Response body:

{
  "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": {
    "draft": {
      "content": "string",
      "digest": "string"
    },
    "published": {
      "content": "string",
      "digest": "string"
    }
  }
}

→

https://api.spectrocloud.com/v1/clusterprofiles/{uid}/packs/{packName}/manifests/{manifestUid}

summary:

Updates the specified manifest of the profile's pack

Path parameters:

Name	Type	Required
uid	string	yes
packName	string	yes
manifestUid	string	yes

Body

{
  "content": "string",
  "name": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/clusterprofiles/{uid}/packs/{packName}/manifests/{manifestUid}

summary:

Deletes the specified manifest of the profile's pack

Path parameters:

Name	Type	Required
uid	string	yes
packName	string	yes
manifestUid	string	yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/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

→

https://api.spectrocloud.com/v1/clusterprofiles/{uid}/spc/download

summary:

Download the specified cluster profile

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: download profile archive file

→

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

summary:

Validate packs for a specified cluster profile

Parameters:

Name	Type	Description	Required
uid	string	cluster profile uid	yes

Body

{
  "cloudType": "string",
  "packs": [
    {
      "layer": "string",
      "manifests": [
        {
          "content": "string",
          "name": "string"
        }
      ],
      "name": "string",
      "registryUid": "string",
      "tag": "string",
      "type": "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"
      }
    ]
  }
}

Edit on GitHub