Morpheus Reference

Configuration options and API endpoints for Ankra-managed Morpheus clusters.

Reference material for Morpheus clusters.

Morpheus cluster provisioning is in closed beta.

---

Cluster Configuration Options

All Morpheus IDs are the numeric IDs from your appliance - discover them in the portal’s create wizard or with the catalog API routes (groups, clouds, networks, layouts, plans).

Parameter	Default	Description
name	required	Unique cluster name
credential_id	required	Morpheus API credential ID
ssh_key_credential_id	required	SSH key credential ID
group_id	required	Numeric ID of the Morpheus group to provision into
cloud_id	required	Numeric ID of the Morpheus cloud to provision into
network_id	required	Numeric ID of the network the instances attach to (must provide DHCP)
layout_id	required	Numeric ID of the instance layout to provision from
virtual_image_id		Numeric ID of a virtual image to pin (optional)
bastion_plan_id	required	Numeric service plan ID for the bastion instance
control_plane_count	1	Number of control plane nodes (1, 3, or 5)
control_plane_plan_id	required	Numeric service plan ID for control planes
node_groups		Array of node group definitions sized by numeric plan_id
distribution	k3s	Kubernetes distribution (k3s or kubeadm)
kubernetes_version	latest stable	Kubernetes version (optional)
cni	flannel (k3s)	CNI plugin. kubeadm clusters always use cilium
etcd_topology	stacked	kubeadm only. stacked or external (dedicated etcd instances)
etcd_node_count	3	kubeadm external topology only (3 or 5)
etcd_plan_id		kubeadm external topology only. Numeric service plan ID for etcd nodes

Cost estimates are not available for Morpheus clusters.

---

Node Group API Reference

Endpoint	Method	Description
/api/v1/clusters/morpheus/{id}/node-groups	GET	List all node groups
/api/v1/clusters/morpheus/{id}/node-groups	POST	Add a node group
/api/v1/clusters/morpheus/{id}/node-groups/{name}/scale	PUT	Scale a node group (0-100)
/api/v1/clusters/morpheus/{id}/node-groups/{name}/instance-type	PUT	Change service plan
/api/v1/clusters/morpheus/{id}/node-groups/{name}/labels	PUT	Update labels
/api/v1/clusters/morpheus/{id}/node-groups/{name}/taints	PUT	Update taints
/api/v1/clusters/morpheus/{id}/node-groups/{name}	DELETE	Delete a node group

Node Actions API

Endpoint	Method	Description
/api/v1/clusters/morpheus/{id}/nodes	GET	List all nodes (control plane, workers, bastion)
/api/v1/clusters/morpheus/{id}/nodes/{node_id}	GET	Get a single node’s details
/api/v1/clusters/morpheus/{id}/bastion/instance-type	PUT	Resize the bastion instance type

See Resizing the Bastion for usage examples and response shapes. Node listing and inspection are also available from the CLI (ankra cluster morpheus nodes list|get); bastion resize is dashboard and API only. Restarting individual nodes is not yet supported for Morpheus.