Powered by Algolia

    Cluster Profiles

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

    summary:
    Retrieves a list of cluster profiles
    Parameters:
    NameTypeDescriptionRequired
    fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
    filtersstringFilters 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
    orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
    limitintegerlimit 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
    continuestringcontinue token for the datasetno
    200
    An array of cluster profile items
    {
    "items": [
    {
    "apiVersion": "string",
    "kind": "string",
    "spec": {
    "draft": {
    "cloudType": "string",
    "name": "string",
    "packServerRefs": [
    null
    ],
    "packServerSecret": "string",
    "packs": [
    {
    "annotations": "object",
    "digest": "string",
    "inValidReason": "string",
    "isInvalid": "boolean",
    "layer": "string",
    "manifests": [
    null
    ],
    "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",
    "type": "string",
    "values": "string",
    "version": "string"
    }
    ],
    "type": "string",
    "uid": "string",
    "version": "integer"
    },
    "published": {
    "cloudType": "string",
    "name": "string",
    "packServerRefs": [
    null
    ],
    "packServerSecret": "string",
    "packs": [
    {
    "annotations": "object",
    "digest": "string",
    "inValidReason": "string",
    "isInvalid": "boolean",
    "layer": "string",
    "manifests": [
    null
    ],
    "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",
    "type": "string",
    "values": "string",
    "version": "string"
    }
    ],
    "type": "string",
    "uid": "string",
    "version": "integer"
    }
    },
    "status": {
    "isPublished": "boolean"
    }
    }
    ],
    "listmeta": {
    "continue": "string",
    "count": "integer"
    }
    }

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

    summary:
    Creates a cluster profile
    {
    "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",
    "manifests": [
    {
    "content": "string",
    "name": "string"
    }
    ],
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
    }
    ],
    "type": "string"
    }
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Validate cluster profile packs
    {
    "cloudType": "string",
    "packs": [
    {
    "layer": "string",
    "manifests": [
    {
    "content": "string",
    "name": "string"
    }
    ],
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
    }
    ],
    "type": "string"
    }
    200
    Cluster profile packs validation response
    {
    "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:
    NameTypeDescriptionRequired
    uidstringyes
    includePackMetastringincludes pack meta such as schema, presetsno
    200
    OK
    {
    "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",
    "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",
    "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",
    "regex": "string",
    "required": "boolean",
    "type": "string"
    }
    ],
    "server": "string",
    "tag": "string",
    "type": "string",
    "values": "string",
    "version": "string"
    }
    ],
    "type": "string",
    "uid": "string",
    "version": "integer"
    }
    },
    "status": {
    "isPublished": "boolean"
    }
    }

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

    summary:
    Updates the specified cluster profile
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    includePackMetastringincludes pack meta such as schema, presetsno
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "template": {
    "packs": [
    {
    "layer": "string",
    "manifests": [
    {
    "content": "string",
    "name": "string",
    "uid": "string"
    }
    ],
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
    }
    ],
    "type": "string"
    }
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified cluster profile
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    includePackMetastringincludes pack meta such as schema, presetsno
    204
    The resource was deleted successfully

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

    summary:
    Updates the specified cluster profile metadata
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    {
    "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Update cluster profile packs ref
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    notifystringno
    bodyno
    204
    The resource was updated successfully

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

    summary:
    Returns the specified cluster profile's packs information
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    includePackMetastringincludes pack meta such as schema, presetsno
    200
    OK
    {
    "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",
    "manifests": [
    null
    ],
    "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"
    }
    ],
    "type": "string",
    "values": "string",
    "version": "string"
    },
    "status": "object"
    }
    ]
    }

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

    summary:
    Adds a new packs to the profile and returns the created pack uid
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    includePackMetastringincludes pack meta such as schema, presetsno
    {
    "pack": {
    "layer": "string",
    "manifests": [
    {
    "content": "string",
    "name": "string"
    }
    ],
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
    }
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified cluster profile's packs resolved values
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    bodyno
    200
    OK
    {
    "resolved": "object"
    }

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

    summary:
    Returns the specified cluster profile's pack configuration
    Parameters:
    NameTypeDescriptionRequired
    uidstringcluster profile uidyes
    packNamestringpack nameyes
    packUidstringpack uidyes
    200
    An array of cluster profile pack configurations
    {
    "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/v1alpha1/clusterprofiles/{uid}/packs/{packUid}

    summary:
    Updates the specified pack information in the cluster profile
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    {
    "pack": {
    "layer": "string",
    "name": "string",
    "tag": "string",
    "type": "string",
    "uid": "string",
    "values": "string"
    }
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified pack information in the cluster profile
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    204
    The resource was deleted successfully

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

    summary:
    Returns the associated manifests for the specified profile's pack
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    200
    OK
    {
    "items": [
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "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/v1alpha1/clusterprofiles/{uid}/packs/{packUid}/manifests

    summary:
    Adds manifest to the profiles packs and returns the added manifests uid
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    {
    "content": "string",
    "name": "string"
    }
    201
    Created successfully
    {
    "uid": "string"
    }

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

    summary:
    Returns the specified manifest of the profile's pack
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    manifestUidstringyes
    200
    OK
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "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/v1alpha1/clusterprofiles/{uid}/packs/{packUid}/manifests/{manifestUid}

    summary:
    Updates the specified manifest of the profile's pack
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    manifestUidstringyes
    {
    "content": "string",
    "name": "string"
    }
    204
    The resource was updated successfully

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

    summary:
    Deletes the specified manifest of the profile's pack
    Path parameters:
    NameTypeDescriptionRequired
    uidstringyes
    packUidstringyes
    manifestUidstringyes
    204
    The resource was deleted successfully

    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:
    NameTypeDescriptionRequired
    uidstringyes
    204
    Cluster profile published successfully