→
https://api.spectrocloud.com/v1alpha1/clusterprofiles
summary:
Retrieves a list of cluster profilesParameters:
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 |
200
An array of cluster profile items
An array of cluster profile items
{"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","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","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","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","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","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","name": "string","tag": "string","uid": "string","values": "string"}],"type": "string"}}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/validate/packs
summary:
Validate cluster profile packs{"cloudType": "string","packs": [{"layer": "string","name": "string","tag": "string","uid": "string","values": "string"}],"type": "string"}
200
Cluster profile packs validation response
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 profilePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
includePackMeta | string | includes pack meta such as schema, presets | no |
200
OK
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","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","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","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","uid": "string","version": "integer"}},"status": {"isPublished": "boolean"}}
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}
summary:
Updates the specified cluster profilePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
includePackMeta | string | includes pack meta such as schema, presets | no |
{"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"}}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}
summary:
Deletes the specified cluster profilePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
includePackMeta | string | includes pack meta such as schema, presets | no |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/metadata
summary:
Updates the specified cluster profile metadataPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","labels": "object","name": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packRefs
summary:
Update cluster profile packs refPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
notify | string | no |
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs
summary:
Returns the specified cluster profile's packs informationPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
includePackMeta | string | includes pack meta such as schema, presets | no |
200
OK
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","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 valuesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
body | no |
200
OK
OK
{"resolved": "object"}
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/{packName}/versions/{packVersion}/values
summary:
Returns the specified cluster profile's pack valuesParameters:
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 |
200
An array of cluster profile pack values
An array of cluster profile pack values
{"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 valuesParameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | cluster profile uid | yes |
packName | string | pack name | yes |
packVersion | string | pack version | yes |
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/packs/{packName}/versions/{packVersion}/values
summary:
Creates a cluster profile pack valuesParameters:
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 |
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/clusterprofiles/{uid}/publish
summary:
Publish the cluster profiledescription:
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 |
204
Cluster profile published successfully
Cluster profile published successfully