MetaKube API.

This describes possible operations which can be made against the MetaKube API.

Informations

Version

2.18

Terms Of Service

https://www.syseleven.de/agb-sla-metakube

Content negotiation

URI Schemes

• https

Consumes

• application/json

Produces

• application/octet-stream
• application/json
• application/yaml

Access control

Security Schemes

api_key (header: Authorization)

Type: apikey

Security Requirements

• api_key

All endpoints

addon

Method	URI	Name	Summary
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons	create addon
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/addons	create addon v2
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}	delete addon	Deletes the given addon that belongs to the cluster.
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}	delete addon v2	Deletes the given addon that belongs to the cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}	get addon	Gets an addon that is assigned to the given cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}	get addon v2	Gets an addon that is assigned to the given cluster.
POST	/api/v1/addons	list accessible addons
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons	list addons
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/addons	list addons v2
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/installableaddons	list installable addons
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/installableaddons	list installable addons v2
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}	patch addon	Patches an addon that is assigned to the given cluster.
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}	patch addon v2	Patches an addon that is assigned to the given cluster.

admin

Method	URI	Name	Summary
PUT	/api/v1/admin/metering/configurations	create or update metering configurations
PUT	/api/v1/admin/metering/credentials	create or update metering credentials
DELETE	/api/v1/admin/admission/plugins/{name}	delete admission plugin	Deletes the admission plugin.
DELETE	/api/v1/admin/seeds/{seed_name}	delete seed	Deletes the seed CRD object from the Kubermatic.
GET	/api/v1/admin	get admins	Returns list of admin users.
GET	/api/v1/admin/admission/plugins/{name}	get admission plugin	Gets the admission plugin.
GET	/api/v1/admin/settings/customlinks	get kubermatic custom links	Gets the custom links.
GET	/api/v1/admin/settings	get kubermatic settings	Gets the global settings.
GET	/api/v1/admin/seeds/{seed_name}	get seed	Returns the seed object.
GET	/api/v1/admin/admission/plugins	list admission plugins	Returns all admission plugins from the CRDs.
GET	/api/v1/admin/seeds	list seeds	Returns all seeds from the CRDs.
PATCH	/api/v1/admin/settings	patch kubermatic settings	Patches the global settings.
PUT	/api/v1/admin	set admin	Allows setting and clearing admin role for users.
PATCH	/api/v1/admin/admission/plugins/{name}	update admission plugin	Updates the admission plugin.
PATCH	/api/v1/admin/seeds/{seed_name}	update seed	Updates the seed.

alibaba

Method	URI	Name	Summary
GET	/api/v1/providers/alibaba/instancetypes	list alibaba instance types	Lists available Alibaba instance types.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/alibaba/instancetypes	list alibaba instance types no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/instancetypes	list alibaba instance types no credentials v2
GET	/api/v1/providers/alibaba/vswitches	list alibaba v switches	Lists available Alibaba vSwitches.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/vswitches	list alibaba v switches no credentials v2
GET	/api/v1/providers/alibaba/zones	list alibaba zones	Lists available Alibaba zones.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/alibaba/zones	list alibaba zones no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/zones	list alibaba zones no credentials v2

allowedregistries

Method	URI	Name	Summary
DELETE	/api/v2/allowedregistries/{allowed_registry}	delete allowed registry	Deletes the given allowed registry.
GET	/api/v2/allowedregistries/{allowed_registry}	get allowed registry
PATCH	/api/v2/allowedregistries/{allowed_registry}	patch allowed registry

allowedregistry

Method	URI	Name	Summary
POST	/api/v2/allowedregistries	create allowed registry
GET	/api/v2/allowedregistries	list allowed registries	List allowed registries.

anexia

Method	URI	Name	Summary
GET	/api/v1/providers/anexia/templates	list anexia templates
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/anexia/templates	list anexia templates no credentials v2
GET	/api/v1/providers/anexia/vlans	list anexia vlans
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/anexia/vlans	list anexia vlans no credentials v2

aws

Method	URI	Name	Summary
GET	/api/v1/providers/aws/{dc}/securitygroups	list a w s security groups
GET	/api/v1/providers/aws/sizes	list a w s sizes	Lists available AWS sizes.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/aws/sizes	list a w s sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/aws/sizes	list a w s sizes no credentials v2
GET	/api/v1/providers/aws/{dc}/subnets	list a w s subnets
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/aws/subnets	list a w s subnets no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/aws/subnets	list a w s subnets no credentials v2
GET	/api/v1/providers/aws/{dc}/vpcs	list a w s v p c s

azure

Method	URI	Name	Summary
GET	/api/v1/providers/azure/availabilityzones	list azure availability zones
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/azure/availabilityzones	list azure availability zones no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/azure/availabilityzones	list azure availability zones no credentials v2
GET	/api/v2/providers/azure/resourcegroups	list azure resource groups
GET	/api/v2/providers/azure/routetables	list azure route tables
GET	/api/v2/providers/azure/securitygroups	list azure security groups
GET	/api/v1/providers/azure/sizes	list azure sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/azure/sizes	list azure sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/azure/sizes	list azure sizes no credentials v2
GET	/api/v2/providers/azure/subnets	list azure subnets
GET	/api/v2/providers/azure/vnets	list azure vnets

backupcredentials

Method	URI	Name	Summary
PUT	/api/v2/seeds/{seed_name}/backupcredentials	create or update backup credentials

constraint

Method	URI	Name	Summary
POST	/api/v2/constraints	create default constraint
GET	/api/v2/constraints/{constraint_name}	get default constraint
GET	/api/v2/constraints	list default constraint	List default constraint.
PATCH	/api/v2/constraints/{constraint_name}	patch default constraint

constraints

Method	URI	Name	Summary
DELETE	/api/v2/constraints/{constraint_name}	delete default constraint	Deletes a specified default constraint.

constrainttemplates

Method	URI	Name	Summary
POST	/api/v2/constrainttemplates	create constraint template
DELETE	/api/v2/constrainttemplates/{ct_name}	delete constraint template
GET	/api/v2/constrainttemplates/{ct_name}	get constraint template
GET	/api/v2/constrainttemplates	list constraint templates	List constraint templates.
PATCH	/api/v2/constrainttemplates/{ct_name}	patch constraint template

credentials

Method	URI	Name	Summary
GET	/api/v1/providers/{provider_name}/presets/credentials	list credentials

datacenter

Method	URI	Name	Summary
POST	/api/v1/seed/{seed_name}/dc	create d c	Create the datacenter for a specified seed.
DELETE	/api/v1/seed/{seed_name}/dc/{dc}	delete d c	Delete the datacenter.
GET	/api/v1/providers/{provider_name}/dc/{dc}	get d c for provider	Get the datacenter for the specified provider.
GET	/api/v1/seed/{seed_name}/dc/{dc}	get d c for seed	Returns the specified datacenter for the specified seed.
GET	/api/v1/dc/{dc}	get datacenter
GET	/api/v1/providers/{provider_name}/dc	list d c for provider	Returns all datacenters for the specified provider.
GET	/api/v1/seed/{seed_name}/dc	list d c for seed	Returns all datacenters for the specified seed.
GET	/api/v1/dc	list datacenters
PATCH	/api/v1/seed/{seed_name}/dc/{dc}	patch d c	Patch the datacenter.
PUT	/api/v1/seed/{seed_name}/dc/{dc}	update d c	Update the datacenter. The datacenter spec will be overwritten with the one provided in the request.

digitalocean

Method	URI	Name	Summary
GET	/api/v1/providers/digitalocean/sizes	list digitalocean sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/digitalocean/sizes	list digitalocean sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/digitalocean/sizes	list digitalocean sizes no credentials v2

etcdbackupconfig

Method	URI	Name	Summary
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs	create etcd backup config
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}	delete etcd backup config
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}	get etcd backup config
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs	list etcd backup config
GET	/api/v2/projects/{project_id}/etcdbackupconfigs	list project etcd backup config
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}	patch etcd backup config

etcdrestore

Method	URI	Name	Summary
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores	create etcd restore
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores/{er_name}	delete etcd restore
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores/{er_name}	get etcd restore
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores	list etcd restore
GET	/api/v2/projects/{project_id}/etcdrestores	list project etcd restore

gcp

Method	URI	Name	Summary
GET	/api/v1/providers/gcp/disktypes	list g c p disk types
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/disktypes	list g c p disk types no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/disktypes	list g c p disk types no credentials v2
GET	/api/v1/providers/gcp/networks	list g c p networks
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/networks	list g c p networks no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/networks	list g c p networks no credentials v2
GET	/api/v1/providers/gcp/sizes	list g c p sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/sizes	list g c p sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/sizes	list g c p sizes no credentials v2
GET	/api/v1/providers/gcp/{dc}/subnetworks	list g c p subnetworks
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/subnetworks	list g c p subnetworks no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/subnetworks	list g c p subnetworks no credentials v2
GET	/api/v1/providers/gcp/{dc}/zones	list g c p zones
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/zones	list g c p zones no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/zones	list g c p zones no credentials v2

hetzner

Method	URI	Name	Summary
GET	/api/v1/providers/hetzner/sizes	list hetzner sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/hetzner/sizes	list hetzner sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/hetzner/sizes	list hetzner sizes no credentials v2

metering

Method	URI	Name	Summary
GET	/api/v1/admin/metering/reports/{report_name}	get metering report
GET	/api/v1/admin/metering/reports	list metering reports

metric

Method	URI	Name	Summary
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes/metrics	list machine deployment metrics	Lists metrics that belong to the given machine deployment.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes/metrics	list node deployment metrics	Lists metrics that belong to the given node deployment.

mlaadminsetting

Method	URI	Name	Summary
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting	create m l a admin setting
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting	delete m l a admin setting	Deletes the MLA admin setting that belongs to the cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting	get m l a admin setting	Gets MLA Admin settings for the given cluster.
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting	update m l a admin setting	Updates the MLA admin setting for the given cluster.

openstack

Method	URI	Name	Summary
GET	/api/v1/providers/openstack/availabilityzones	list openstack availability zones
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/availabilityzones	list openstack availability zones no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/availabilityzones	list openstack availability zones no credentials v2
GET	/api/v1/providers/openstack/images	list openstack images
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/images	list openstack images no credentials
GET	/api/v1/providers/openstack/networks	list openstack networks
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/networks	list openstack networks no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/networks	list openstack networks no credentials v2
GET	/api/v1/providers/openstack/quotalimits	list openstack quota limits
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/quotalimits	list openstack quota limits no credentials
GET	/api/v1/providers/openstack/securitygroups	list openstack security groups
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/securitygroups	list openstack security groups no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/securitygroups	list openstack security groups no credentials v2
GET	/api/v1/providers/openstack/sizes	list openstack sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/sizes	list openstack sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/sizes	list openstack sizes no credentials v2
GET	/api/v1/providers/openstack/subnets	list openstack subnets
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/subnets	list openstack subnets no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/subnets	list openstack subnets no credentials v2
GET	/api/v1/providers/openstack/tenants	list openstack tenants
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/tenants	list openstack tenants no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/tenants	list openstack tenants no credentials v2

operations

Method	URI	Name	Summary
GET	/api/v1/kubeconfig	create o ID c kubeconfig
GET	/api/v1/addonconfigs/{addon_id}	get addon config	Returns specified addon config.
GET	/api/v1/admission/plugins/{version}	get admission plugins	Returns specified addon config.
GET	/api/v1/addonconfigs	list addon configs	Returns all available addon configs.
GET	/api/v1/labels/system	list system labels
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/externalccmmigration	migrate cluster to external c c m

packet

Method	URI	Name	Summary
GET	/api/v1/providers/packet/sizes	list packet sizes
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/packet/sizes	list packet sizes no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/packet/sizes	list packet sizes no credentials v2

preset

Method	URI	Name	Summary
POST	/api/v2/providers/{provider_name}/presets	create preset
GET	/api/v2/presets	list presets
GET	/api/v2/providers/{provider_name}/presets	list provider presets
PUT	/api/v2/providers/{provider_name}/presets	update preset
PUT	/api/v2/presets/{preset_name}/status	update preset status	Updates the status of a preset. It can enable or disable it, so that it won't be listed by the list endpoints.

project

Method	URI	Name	Summary
PUT	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys/{key_id}	assign SSH key to cluster
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/sshkeys/{key_id}	assign SSH key to cluster v2
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings	bind user to cluster role
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings	bind user to cluster role v2
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings	bind user to role
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings	bind user to role v2
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters	create cluster	Creates a cluster for the given project.
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles	create cluster role
POST	/api/v2/projects/{project_id}/clustertemplates	create cluster template	Creates a cluster templates for the given project.
POST	/api/v2/projects/{project_id}/clustertemplates/{template_id}/instances	create cluster template instance	Create cluster template instance.
POST	/api/v2/projects/{project_id}/clusters	create cluster v2	Creates a cluster for the given project.
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/constraints	create constraint	Creates a given constraint for the specified cluster.
POST	/api/v2/projects/{project_id}/kubernetes/clusters	create external cluster	Creates an external cluster for the given project.
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config	create gatekeeper config
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments	create machine deployment
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments	create node deployment
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests	create node deployment request
POST	/api/v1/projects	create project	Creates a brand new project.
POST	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles	create role
POST	/api/v1/projects/{project_id}/sshkeys	create SSH key	Adds the given SSH key to the specified project.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}	delete cluster
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}	delete cluster role
DELETE	/api/v2/projects/{project_id}/clustertemplates/{template_id}	delete cluster template	Delete cluster template.
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}	delete cluster v2
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}	delete constraint	Deletes a specified constraint for the given cluster.
DELETE	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}	delete external cluster
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config	delete gatekeeper config	Deletes the gatekeeper sync config for the specified cluster.
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}	delete machine deployment	Deletes the given machine deployment that belongs to the cluster.
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/nodes/{node_id}	delete machine deployment node	Deletes the given node that belongs to the machine deployment.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}	delete node deployment	Deletes the given node deployment that belongs to the cluster.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}	delete node deployment request	Deletes the given NodeDeploymentRequest that belongs to the cluster.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodes/{node_id}	delete node for cluster legacy	Deprecated:
Deletes the given node that belongs to the cluster.
DELETE	/api/v1/projects/{project_id}	delete project	Deletes the project with the given ID.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}	delete role
DELETE	/api/v1/projects/{project_id}/sshkeys/{key_id}	delete SSH key	Removes the given SSH Key from the system.
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys/{key_id}	detach SSH key from cluster
DELETE	/api/projects/{project_id}/clusters/{cluster_id}/sshkeys/{key_id}	detach SSH key from cluster v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config	get alertmanager	Gets the alertmanager configuration for the specified cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}	get cluster
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/events	get cluster events	Gets the events related to the specified cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/events	get cluster events v2	Gets the events related to the specified cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/health	get cluster health
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/health	get cluster health v2
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/kubeconfig	get cluster kubeconfig	Gets the kubeconfig for the specified cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/kubeconfig	get cluster kubeconfig v2	Gets the kubeconfig for the specified cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/metrics	get cluster metrics
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/metrics	get cluster metrics v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/oidc	get cluster oidc	Gets the OIDC params for the specified cluster with OIDC authentication.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{role_id}	get cluster role
GET	/api/v2/projects/{project_id}/clustertemplates/{template_id}	get cluster template	Get cluster template.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/upgrades	get cluster upgrades
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/upgrades	get cluster upgrades v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}	get cluster v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}	get constraint	Gets an specified constraint for the given cluster.
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}	get external cluster	Gets an external cluster for the given project.
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/metrics	get external cluster metrics
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodes/{node_id}	get external cluster node	Gets an external cluster node.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config	get gatekeeper config	Gets the gatekeeper sync config for the specified cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/kubeloginkubeconfig	get kube login cluster kubeconfig	Gets the kubeconfig for the specified cluster with oidc authentication that works nicely with kube-login.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}	get machine deployment	Gets a machine deployment that is assigned to the given cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}	get node deployment	Gets a node deployment that is assigned to the given cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}	get node deployment request	Gets a NodeDeploymentRequest that is assigned to the given cluster.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/oidckubeconfig	get oidc cluster kubeconfig	Gets the kubeconfig for the specified cluster with oidc authentication.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/oidckubeconfig	get oidc cluster kubeconfig v2	Gets the kubeconfig for the specified cluster with oidc authentication.
GET	/api/v1/projects/{project_id}	get project
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}	get role
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles	list cluster role
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterbindings	list cluster role binding
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/clusterbindings	list cluster role binding v2
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterrolenames	list cluster role names
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/clusterrolenames	list cluster role names v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles	list cluster role v2
GET	/api/v2/projects/{project_id}/clustertemplates	list cluster templates	List cluster templates for the given project.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters	list clusters	Lists clusters for the specified project and data center.
GET	/api/v1/projects/{project_id}/clusters	list clusters for project	Lists clusters for the specified project.
GET	/api/v2/projects/{project_id}/clusters	list clusters v2	Lists clusters for the specified project.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/constraints	list constraints	Lists constraints for the specified cluster.
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/events	list external cluster events	Gets an external cluster events.
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodes	list external cluster nodes	Gets an external cluster nodes.
GET	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodesmetrics	list external cluster nodes metrics	Gets an external cluster nodes metrics.
GET	/api/v2/projects/{project_id}/kubernetes/clusters	list external clusters	Lists external clusters for the specified project.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes	list machine deployment nodes	Lists nodes that belong to the given machine deployment.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes/events	list machine deployment nodes events	Lists machine deployment events. If query parameter type is set to warning then only warning events are retrieved.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments	list machine deployments
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/namespaces	list namespace
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/namespaces	list namespace v2
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes	list node deployment nodes	Lists nodes that belong to the given node deployment.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes/events	list node deployment nodes events	Lists node deployment events. If query parameter type is set to warning then only warning events are retrieved.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests	list node deployment requests
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments	list node deployments
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/nodes	list nodes for cluster	This endpoint is used for kubeadm cluster.
GET	/api/v1/projects	list projects	Lists projects that an authenticated user is a member of.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles	list role
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/bindings	list role binding
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/bindings	list role binding v2
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/rolenames	list role names
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/rolenames	list role names v2
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/roles	list role v2
GET	/api/v1/projects/{project_id}/sshkeys	list SSH keys	Lists SSH Keys that belong to the given project.
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys	list SSH keys assigned to cluster
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/sshkeys	list SSH keys assigned to cluster v2
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}	patch cluster	Patches the given cluster using JSON Merge Patch method (https://tools.ietf.org/html/rfc7396).
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}	patch cluster role
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}	patch cluster v2	Patches the given cluster using JSON Merge Patch method (https://tools.ietf.org/html/rfc7396).
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}	patch constraint	Patches a given constraint for the specified cluster.
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config	patch gatekeeper config	Patches the gatekeeper config for the specified cluster.
PATCH	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}	patch machine deployment
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}	patch node deployment
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}	patch node deployment request	Patches a NodeDeploymentRequest that is assigned to the given cluster.
PATCH	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}	patch role
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config	reset alertmanager	Resets the alertmanager configuration to default for the specified cluster.
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}	restart machine deployment	Schedules rolling restart of a machine deployment that is assigned to the given cluster.
PUT	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/token	revoke cluster admin token
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/token	revoke cluster admin token v2
PUT	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/viewertoken	revoke cluster viewer token
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/viewertoken	revoke cluster viewer token v2
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings	unbind user from cluster role binding
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings	unbind user from cluster role binding v2
DELETE	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings	unbind user from role binding
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings	unbind user from role binding v2
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config	update alertmanager
PUT	/api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}	update external cluster	Updates an external cluster for the given project.
PUT	/api/v1/projects/{project_id}	update project
PUT	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodes/upgrades	upgrade cluster node deployments
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/nodes/upgrades	upgrade cluster node deployments v2

rulegroup

Method	URI	Name	Summary
POST	/api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups	create rule group
DELETE	/api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}	delete rule group	Deletes the given rule group that belongs to the cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}	get rule group	Gets a specified rule group for the given cluster.
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups	list rule groups
PUT	/api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}	update rule group	Updates the specified rule group for the given cluster.

seed

Method	URI	Name	Summary
GET	/api/v2/seeds/{seed_name}/settings	get seed settings	Gets the seed settings.
GET	/api/v1/seed	list seed names

serviceaccounts

Method	URI	Name	Summary
POST	/api/v1/projects/{project_id}/serviceaccounts	add service account to project
DELETE	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}	delete service account
GET	/api/v1/projects/{project_id}/serviceaccounts	list service accounts
PUT	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}	update service account

settings

Method	URI	Name	Summary
GET	/api/v1/me/settings	get current user settings	Returns settings of the current user.
PATCH	/api/v1/me/settings	patch current user settings	Updates settings of the current user.

tokens

Method	URI	Name	Summary
POST	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens	add token to service account
DELETE	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}	delete service account token
GET	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens	list service account tokens
PATCH	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}	patch service account token
PUT	/api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}	update service account token

users

Method	URI	Name	Summary
POST	/api/v1/projects/{project_id}/users	add user to project
DELETE	/api/v1/projects/{project_id}/users/{user_id}	delete user from project
PUT	/api/v1/projects/{project_id}/users/{user_id}	edit user in project
GET	/api/v1/me	get current user	Returns information about the current user.
GET	/api/v1/projects/{project_id}/users	get users for project
POST	/api/v1/me/logout	logout current user	Adds current authorization bearer token to the blacklist.

version

Method	URI	Name	Summary
GET	/api/v2/providers/{provider_name}/versions	list versions by provider

versions

Method	URI	Name	Summary
GET	/api/v1/upgrades/cluster	get master versions
GET	/api/v1/version	get meta kube versions	Get versions of running MetaKube components.
GET	/api/v1/upgrades/node	get node upgrades

vsphere

Method	URI	Name	Summary
GET	/api/v2/providers/vsphere/datastores	list v sphere datastores
GET	/api/v1/providers/vsphere/folders	list v sphere folders
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/vsphere/folders	list v sphere folders no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/vsphere/folders	list v sphere folders no credentials v2
GET	/api/v1/providers/vsphere/networks	list v sphere networks
GET	/api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/vsphere/networks	list v sphere networks no credentials
GET	/api/v2/projects/{project_id}/clusters/{cluster_id}/providers/vsphere/networks	list v sphere networks no credentials v2

Paths

add service account to project (addServiceAccountToProject)

POST /api/v1/projects/{project_id}/serviceaccounts

Adds the given service account to the given project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	ServiceAccount	models.ServiceAccount

All responses

Code	Status	Description	Has headers	Schema
201	Created	ServiceAccount		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - ServiceAccount

Status: Created

Schema

ServiceAccount

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

add token to service account (addTokenToServiceAccount)

POST /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens

Generates a token for the given service account

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓
Body	body	ServiceAccountToken	models.ServiceAccountToken

All responses

Code	Status	Description	Has headers	Schema
201	Created	ServiceAccountToken		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - ServiceAccountToken

Status: Created

Schema

ServiceAccountToken

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

add user to project (addUserToProject)

POST /api/v1/projects/{project_id}/users

Adds the given user to the given project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	User	models.User

All responses

Code	Status	Description	Has headers	Schema
201	Created	User		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - User

Status: Created

Schema

User

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

assign SSH key to cluster (assignSSHKeyToCluster)

PUT /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys/{key_id}

Assigns an existing ssh key to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
key_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
201	Created	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - SSHKey

Status: Created

Schema

SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

assign SSH key to cluster v2 (assignSSHKeyToClusterV2)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/sshkeys/{key_id}

Assigns an existing ssh key to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
key_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
201	Created	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - SSHKey

Status: Created

Schema

SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

bind user to cluster role (bindUserToClusterRole)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings

Binds user to cluster role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	ClusterRoleUser	models.ClusterRoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

bind user to cluster role v2 (bindUserToClusterRoleV2)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings

Binds user to cluster role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	ClusterRoleUser	models.ClusterRoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

bind user to role (bindUserToRole)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings

Binds user to the role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	RoleUser	models.RoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

bind user to role v2 (bindUserToRoleV2)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings

Binds user to the role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	RoleUser	models.RoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create addon (createAddon)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons

Creates an addon that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	Addon	models.Addon

All responses

Code	Status	Description	Has headers	Schema
201	Created	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Addon

Status: Created

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create addon v2 (createAddonV2)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/addons

Creates an addon that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	Addon	models.Addon

All responses

Code	Status	Description	Has headers	Schema
201	Created	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Addon

Status: Created

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create allowed registry (createAllowedRegistry)

POST /api/v2/allowedregistries

Creates a allowed registry

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Body	body	WrBody	models.WrBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	AllowedRegistry		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - AllowedRegistry

Status: Created

Schema

AllowedRegistry

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Creates a cluster for the given project. (createCluster)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	CreateClusterSpec	models.CreateClusterSpec

All responses

Code	Status	Description	Has headers	Schema
201	Created	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Cluster

Status: Created

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create cluster role (createClusterRole)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles

Creates cluster role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	ClusterRole	models.ClusterRole

All responses

Code	Status	Description	Has headers	Schema
201	Created	ClusterRole		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - ClusterRole

Status: Created

Schema

ClusterRole

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Creates a cluster templates for the given project. (createClusterTemplate)

POST /api/v2/projects/{project_id}/clustertemplates

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	CreateClusterTemplateBody	CreateClusterTemplateBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	ClusterTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - ClusterTemplate

Status: Created

Schema

ClusterTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

CreateClusterTemplateBody

Properties

Name	Type	Go type	Required	Default	Description	Example
DNSDomain	string	string
Name	string	string
PodsCIDR	string	string
Scope	string	string
ServicesCIDR	string	string
UserSSHKeys	[]ClusterTemplateSSHKey	[]*models.ClusterTemplateSSHKey
cluster	Cluster	models.Cluster
nodeDeployment	NodeDeployment	models.NodeDeployment

Create cluster template instance. (createClusterTemplateInstance)

POST /api/v2/projects/{project_id}/clustertemplates/{template_id}/instances

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
template_id	path	string	string		✓
Body	body	CreateClusterTemplateInstanceBody	CreateClusterTemplateInstanceBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	ClusterTemplateInstance		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - ClusterTemplateInstance

Status: Created

Schema

ClusterTemplateInstance

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

CreateClusterTemplateInstanceBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Replicas	int64 (formatted integer)	int64

Creates a cluster for the given project. (createClusterV2)

POST /api/v2/projects/{project_id}/clusters

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	CreateClusterSpec	models.CreateClusterSpec

All responses

Code	Status	Description	Has headers	Schema
201	Created	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Cluster

Status: Created

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Creates a given constraint for the specified cluster. (createConstraint)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/constraints

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	ConstraintBody	models.ConstraintBody		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create constraint template (createConstraintTemplate)

POST /api/v2/constrainttemplates

Create constraint template

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Body	body	CtBody	models.CtBody

All responses

Code	Status	Description	Has headers	Schema
200	OK	ConstraintTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ConstraintTemplate

Status: OK

Schema

ConstraintTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Create the datacenter for a specified seed. (createDC)

POST /api/v1/seed/{seed_name}/dc

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓
Body	body	CreateDCBody	CreateDCBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Datacenter

Status: Created

Schema

Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

CreateDCBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	DatacenterSpec	models.DatacenterSpec

create default constraint (createDefaultConstraint)

POST /api/v2/constraints

Creates default constraint

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Body	body	ConstraintBody	models.ConstraintBody		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create etcd backup config (createEtcdBackupConfig)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs

Creates a etcd backup config that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	EbcBody	models.EbcBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - EtcdBackupConfig

Status: Created

Schema

EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create etcd restore (createEtcdRestore)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores

Creates a etcd backup restore for a given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	ErBody	models.ErBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - EtcdBackupConfig

Status: Created

Schema

EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Creates an external cluster for the given project. (createExternalCluster)

POST /api/v2/projects/{project_id}/kubernetes/clusters

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	Body	models.Body

All responses

Code	Status	Description	Has headers	Schema
201	Created	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Cluster

Status: Created

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create gatekeeper config (createGatekeeperConfig)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config

Creates a gatekeeper config for the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	GatekeeperConfig	models.GatekeeperConfig		✓

All responses

Code	Status	Description	Has headers	Schema
201	Created	GatekeeperConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - GatekeeperConfig

Status: Created

Schema

GatekeeperConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create m l a admin setting (createMLAAdminSetting)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting

Creates MLA admin setting that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	MLAAdminSetting	models.MLAAdminSetting		✓

All responses

Code	Status	Description	Has headers	Schema
201	Created	MLAAdminSetting		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - MLAAdminSetting

Status: Created

Schema

MLAAdminSetting

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create machine deployment (createMachineDeployment)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments

Creates a machine deployment that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	NodeDeployment	models.NodeDeployment

All responses

Code	Status	Description	Has headers	Schema
201	Created	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - NodeDeployment

Status: Created

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create node deployment (createNodeDeployment)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments

Creates a node deployment that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	NodeDeployment	models.NodeDeployment

All responses

Code	Status	Description	Has headers	Schema
201	Created	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - NodeDeployment

Status: Created

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create node deployment request (createNodeDeploymentRequest)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests

Creates a NodeDeploymentRequest that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	NodeDeploymentRequest	models.NodeDeploymentRequest

All responses

Code	Status	Description	Has headers	Schema
201	Created	NodeDeploymentRequest		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - NodeDeploymentRequest

Status: Created

Schema

NodeDeploymentRequest

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create o ID c kubeconfig (createOIDCKubeconfig)

GET /api/v1/kubeconfig

Starts OIDC flow and generates kubeconfig, the generated config contains OIDC provider authentication info

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	query	string	string
project_id	query	string	string
user_id	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

Default Response

errorResponse

Schema

ErrorResponse

create or update backup credentials (createOrUpdateBackupCredentials)

PUT /api/v2/seeds/{seed_name}/backupcredentials

Creates or updates backup credentials for a given seed

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓
Body	body	BcBody	models.BcBody

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create or update metering configurations (createOrUpdateMeteringConfigurations)

PUT /api/v1/admin/metering/configurations

Configures KKP metering tool. Only available in Kubermatic Enterprise Edition

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create or update metering credentials (createOrUpdateMeteringCredentials)

PUT /api/v1/admin/metering/credentials

Creates or updates the metering tool credentials. Only available in Kubermatic Enterprise Edition

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create preset (createPreset)

POST /api/v2/providers/{provider_name}/presets

Creates the preset

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓
Body	body	Preset	models.Preset		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Preset		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Preset

Status: OK

Schema

Preset

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Creates a brand new project. (createProject)

POST /api/v1/projects

Note that this endpoint can be consumed by every authenticated user.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Body	body	CreateProjectBody	CreateProjectBody

All responses

Code	Status	Description	Has headers	Schema
201	Created	Project		schema
401	Unauthorized	EmptyResponse is a empty response		schema
409	Conflict	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Project

Status: Created

Schema

Project

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

409 - EmptyResponse is a empty response

Status: Conflict

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

CreateProjectBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Labels	map of string	map[string]string
Name	string	string
Users	[]string	[]string			human user email list for the service account in projectmanagers group

create role (createRole)

POST /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles

Creates cluster role

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	Role	models.Role

All responses

Code	Status	Description	Has headers	Schema
201	Created	Role		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - Role

Status: Created

Schema

Role

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

create rule group (createRuleGroup)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups

Creates a rule group that will belong to the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	RuleGroup	models.RuleGroup		✓

All responses

Code	Status	Description	Has headers	Schema
201	Created	RuleGroup		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - RuleGroup

Status: Created

Schema

RuleGroup

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Adds the given SSH key to the specified project. (createSSHKey)

POST /api/v1/projects/{project_id}/sshkeys

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Key	body	SSHKey	models.SSHKey

All responses

Code	Status	Description	Has headers	Schema
201	Created	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

201 - SSHKey

Status: Created

Schema

SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given addon that belongs to the cluster. (deleteAddon)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given addon that belongs to the cluster. (deleteAddonV2)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the admission plugin. (deleteAdmissionPlugin)

DELETE /api/v1/admin/admission/plugins/{name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given allowed registry. (deleteAllowedRegistry)

DELETE /api/v2/allowedregistries/{allowed_registry}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
allowed_registry	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete cluster (deleteCluster)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}

Deletes the specified cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
DeleteLoadBalancers	header	boolean	bool
DeleteVolumes	header	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete cluster role (deleteClusterRole)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}

Delete the cluster role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Delete cluster template. (deleteClusterTemplate)

DELETE /api/v2/projects/{project_id}/clustertemplates/{template_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
template_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete cluster v2 (deleteClusterV2)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}

Deletes the specified cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
DeleteLoadBalancers	header	boolean	bool
DeleteVolumes	header	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes a specified constraint for the given cluster. (deleteConstraint)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
constraint_name	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete constraint template (deleteConstraintTemplate)

DELETE /api/v2/constrainttemplates/{ct_name}

Deletes the specified cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ct_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Delete the datacenter. (deleteDC)

DELETE /api/v1/seed/{seed_name}/dc/{dc}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes a specified default constraint. (deleteDefaultConstraint)

DELETE /api/v2/constraints/{constraint_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
constraint_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete etcd backup config (deleteEtcdBackupConfig)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}

Deletes a etcd backup config for a given cluster based on its id

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
ebc_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete etcd restore (deleteEtcdRestore)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores/{er_name}

Deletes a etcd restore config for a given cluster based on its name

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
er_name	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
409	Conflict	errorResponse		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

409 - errorResponse

Status: Conflict

Schema

ErrorResponse

Default Response

errorResponse

Schema

ErrorResponse

delete external cluster (deleteExternalCluster)

DELETE /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}

Deletes the specified external cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the gatekeeper sync config for the specified cluster. (deleteGatekeeperConfig)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the MLA admin setting that belongs to the cluster. (deleteMLAAdminSetting)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given machine deployment that belongs to the cluster. (deleteMachineDeployment)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given node that belongs to the machine deployment. (deleteMachineDeploymentNode)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/nodes/{node_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
node_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given node deployment that belongs to the cluster. (deleteNodeDeployment)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given NodeDeploymentRequest that belongs to the cluster. (deleteNodeDeploymentRequest)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
ndrequest_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deprecated:

Deletes the given node that belongs to the cluster. (deleteNodeForClusterLegacy)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodes/{node_id}

This endpoint is deprecated, please create a Node Deployment instead.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
node_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the project with the given ID. (deleteProject)

DELETE /api/v1/projects/{project_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete role (deleteRole)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}

Delete the cluster role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the given rule group that belongs to the cluster. (deleteRuleGroup)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
rulegroup_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Removes the given SSH Key from the system. (deleteSSHKey)

DELETE /api/v1/projects/{project_id}/sshkeys/{key_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
key_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Deletes the seed CRD object from the Kubermatic. (deleteSeed)

DELETE /api/v1/admin/seeds/{seed_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete service account (deleteServiceAccount)

DELETE /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}

Deletes service account for the given project

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete service account token (deleteServiceAccountToken)

DELETE /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}

Deletes the token

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓
token_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

delete user from project (deleteUserFromProject)

DELETE /api/v1/projects/{project_id}/users/{user_id}

Removes the given member from the project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
user_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	User		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - User

Status: OK

Schema

User

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

detach SSH key from cluster (detachSSHKeyFromCluster)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys/{key_id}

Unassignes an ssh key from the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
key_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

detach SSH key from cluster v2 (detachSSHKeyFromClusterV2)

DELETE /api/projects/{project_id}/clusters/{cluster_id}/sshkeys/{key_id}

Unassignes an ssh key from the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
key_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

edit user in project (editUserInProject)

PUT /api/v1/projects/{project_id}/users/{user_id}

Changes membership of the given user for the given project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
user_id	path	string	string		✓
Body	body	User	models.User

All responses

Code	Status	Description	Has headers	Schema
200	OK	User		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - User

Status: OK

Schema

User

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an addon that is assigned to the given cluster. (getAddon)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns specified addon config. (getAddonConfig)

GET /api/v1/addonconfigs/{addon_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AddonConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AddonConfig

Status: OK

Schema

AddonConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an addon that is assigned to the given cluster. (getAddonV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns list of admin users. (getAdmins)

GET /api/v1/admin

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Admin		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Admin

Status: OK

Schema

[]Admin

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the admission plugin. (getAdmissionPlugin)

GET /api/v1/admin/admission/plugins/{name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AdmissionPlugin		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AdmissionPlugin

Status: OK

Schema

AdmissionPlugin

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns specified addon config. (getAdmissionPlugins)

GET /api/v1/admission/plugins/{version}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
version	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AdmissionPluginList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AdmissionPluginList

Status: OK

Schema

AdmissionPluginList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the alertmanager configuration for the specified cluster. (getAlertmanager)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Alertmanager		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Alertmanager

Status: OK

Schema

Alertmanager

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get allowed registry (getAllowedRegistry)

GET /api/v2/allowedregistries/{allowed_registry}

Get allowed registries specified by name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
allowed_registry	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AllowedRegistry		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AllowedRegistry

Status: OK

Schema

AllowedRegistry

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster (getCluster)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}

Gets the cluster with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the events related to the specified cluster. (getClusterEvents)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/events

Produces

• application/yaml

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Event		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Event

Status: OK

Schema

[]Event

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the events related to the specified cluster. (getClusterEventsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/events

Produces

• application/yaml

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Event		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Event

Status: OK

Schema

[]Event

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster health (getClusterHealth)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/health

Returns the cluster's component health status

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterHealth		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterHealth

Status: OK

Schema

ClusterHealth

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster health v2 (getClusterHealthV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/health

Returns the cluster's component health status

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterHealth		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterHealth

Status: OK

Schema

ClusterHealth

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the kubeconfig for the specified cluster. (getClusterKubeconfig)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/kubeconfig

Produces

• application/octet-stream

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the kubeconfig for the specified cluster. (getClusterKubeconfigV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/kubeconfig

Produces

• application/octet-stream

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster metrics (getClusterMetrics)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/metrics

Gets cluster metrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterMetrics		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterMetrics

Status: OK

Schema

ClusterMetrics

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster metrics v2 (getClusterMetricsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/metrics

Gets cluster metrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterMetrics		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterMetrics

Status: OK

Schema

ClusterMetrics

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the OIDC params for the specified cluster with OIDC authentication. (getClusterOidc)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/oidc

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OIDCSpec		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - OIDCSpec

Status: OK

Schema

OIDCSpec

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster role (getClusterRole)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{role_id}

Gets the cluster role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRole		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRole

Status: OK

Schema

ClusterRole

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Get cluster template. (getClusterTemplate)

GET /api/v2/projects/{project_id}/clustertemplates/{template_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
template_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterTemplate

Status: OK

Schema

ClusterTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster upgrades (getClusterUpgrades)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/upgrades

Gets possible cluster upgrades

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	MasterVersion		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MasterVersion

Status: OK

Schema

[]MasterVersion

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster upgrades v2 (getClusterUpgradesV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/upgrades

Gets possible cluster upgrades

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	MasterVersion		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MasterVersion

Status: OK

Schema

[]MasterVersion

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get cluster v2 (getClusterV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}

Gets the cluster with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an specified constraint for the given cluster. (getConstraint)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
constraint_name	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get constraint template (getConstraintTemplate)

GET /api/v2/constrainttemplates/{ct_name}

Get constraint templates specified by name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ct_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ConstraintTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ConstraintTemplate

Status: OK

Schema

ConstraintTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns information about the current user. (getCurrentUser)

GET /api/v1/me

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	User		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - User

Status: OK

Schema

User

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns settings of the current user. (getCurrentUserSettings)

GET /api/v1/me/settings

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	UserSettings		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - UserSettings

Status: OK

Schema

UserSettings

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

Get the datacenter for the specified provider. (getDCForProvider)

GET /api/v1/providers/{provider_name}/dc/{dc}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
provider_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns the specified datacenter for the specified seed. (getDCForSeed)

GET /api/v1/seed/{seed_name}/dc/{dc}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get datacenter (getDatacenter)

GET /api/v1/dc/{dc}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

Datacenter

Default Response

errorResponse

Schema

ErrorResponse

get default constraint (getDefaultConstraint)

GET /api/v2/constraints/{constraint_name}

Gets an specified default constraint

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
constraint_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get etcd backup config (getEtcdBackupConfig)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}

Gets a etcd backup config for a given cluster based on its id

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
ebc_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdBackupConfig

Status: OK

Schema

EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get etcd restore (getEtcdRestore)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores/{er_name}

Gets a etcd backup restore for a given cluster based on its name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
er_name	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdRestore		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdRestore

Status: OK

Schema

EtcdRestore

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an external cluster for the given project. (getExternalCluster)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get external cluster metrics (getExternalClusterMetrics)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/metrics

Gets cluster metrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterMetrics		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterMetrics

Status: OK

Schema

ClusterMetrics

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an external cluster node. (getExternalClusterNode)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodes/{node_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
node_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Node		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Node

Status: OK

Schema

Node

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the gatekeeper sync config for the specified cluster. (getGatekeeperConfig)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	GatekeeperConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - GatekeeperConfig

Status: OK

Schema

GatekeeperConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the kubeconfig for the specified cluster with oidc authentication that works nicely with kube-login. (getKubeLoginClusterKubeconfig)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/kubeloginkubeconfig

Produces

• application/yaml

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the custom links. (getKubermaticCustomLinks)

GET /api/v1/admin/settings/customlinks

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	GlobalCustomLinks		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - GlobalCustomLinks

Status: OK

Schema

GlobalCustomLinks

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the global settings. (getKubermaticSettings)

GET /api/v1/admin/settings

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	GlobalSettings		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - GlobalSettings

Status: OK

Schema

GlobalSettings

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets MLA Admin settings for the given cluster. (getMLAAdminSetting)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	MLAAdminSetting		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MLAAdminSetting

Status: OK

Schema

MLAAdminSetting

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets a machine deployment that is assigned to the given cluster. (getMachineDeployment)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get master versions (getMasterVersions)

GET /api/v1/upgrades/cluster

Lists all versions which don't result in automatic updates

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	MasterVersion		schema
default		errorResponse		schema

Responses

200 - MasterVersion

Status: OK

Schema

[]MasterVersion

Default Response

errorResponse

Schema

ErrorResponse

Get versions of running MetaKube components. (getMetaKubeVersions)

GET /api/v1/version

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	MetaKubeVersions		schema
default		errorResponse		schema

Responses

200 - MetaKubeVersions

Status: OK

Schema

KubermaticVersions

Default Response

errorResponse

Schema

ErrorResponse

get metering report (getMeteringReport)

GET /api/v1/admin/metering/reports/{report_name}

Download a specific metering report. Provides an S3 pre signed URL valid for 1 hour. Only available in Kubermatic Enterprise Edition

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
report_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	MeteringReportURL		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MeteringReportURL

Status: OK

Schema

Name	Type	Go type	Default	Description	Example
getMeteringReportOKBody	string

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets a node deployment that is assigned to the given cluster. (getNodeDeployment)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets a NodeDeploymentRequest that is assigned to the given cluster. (getNodeDeploymentRequest)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
ndrequest_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeploymentRequest		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeploymentRequest

Status: OK

Schema

NodeDeploymentRequest

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get node upgrades (getNodeUpgrades)

GET /api/v1/upgrades/node

Gets possible node upgrades for a specific control plane version

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
control_plane_version	query	string	string
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	MasterVersion		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MasterVersion

Status: OK

Schema

[]MasterVersion

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the kubeconfig for the specified cluster with oidc authentication. (getOidcClusterKubeconfig)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/oidckubeconfig

Produces

• application/yaml

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the kubeconfig for the specified cluster with oidc authentication. (getOidcClusterKubeconfigV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/oidckubeconfig

Produces

• application/octet-stream

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Kubeconfig is a clusters kubeconfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Kubeconfig is a clusters kubeconfig

Status: OK

Schema

[]uint8 (formatted integer)

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get project (getProject)

GET /api/v1/projects/{project_id}

Gets the project with the given ID

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Project		schema
401	Unauthorized	EmptyResponse is a empty response		schema
409	Conflict	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Project

Status: OK

Schema

Project

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

409 - EmptyResponse is a empty response

Status: Conflict

Schema

Default Response

errorResponse

Schema

ErrorResponse

get role (getRole)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}

Gets the role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Role		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Role

Status: OK

Schema

Role

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets a specified rule group for the given cluster. (getRuleGroup)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
rulegroup_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RuleGroup		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RuleGroup

Status: OK

Schema

RuleGroup

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns the seed object. (getSeed)

GET /api/v1/admin/seeds/{seed_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Seed		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Seed

Status: OK

Schema

Seed

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets the seed settings. (getSeedSettings)

GET /api/v2/seeds/{seed_name}/settings

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	SeedSettings		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - SeedSettings

Status: OK

Schema

SeedSettings

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

get users for project (getUsersForProject)

GET /api/v1/projects/{project_id}/users

Get list of users for the given project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	User		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - User

Status: OK

Schema

[]User

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list a w s security groups (listAWSSecurityGroups)

GET /api/v1/providers/aws/{dc}/securitygroups

Lists available AWS Security Groups

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
AccessKeyID	header	string	string
Credential	header	string	string
SecretAccessKey	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSecurityGroupList		schema
default		errorResponse		schema

Responses

200 - AWSSecurityGroupList

Status: OK

Schema

AWSSecurityGroupList

Default Response

errorResponse

Schema

ErrorResponse

Lists available AWS sizes. (listAWSSizes)

GET /api/v1/providers/aws/sizes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Region	header	string	string
architecture	query	string	string				architecture query parameter. Supports: arm64 and x64 types.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSizeList		schema
default		errorResponse		schema

Responses

200 - AWSSizeList

Status: OK

Schema

AWSSizeList

Default Response

errorResponse

Schema

ErrorResponse

list a w s sizes no credentials (listAWSSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/aws/sizes

Lists available AWS sizes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSizeList		schema
default		errorResponse		schema

Responses

200 - AWSSizeList

Status: OK

Schema

AWSSizeList

Default Response

errorResponse

Schema

ErrorResponse

list a w s sizes no credentials v2 (listAWSSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/aws/sizes

Lists available AWS sizes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
architecture	query	string	string				architecture query parameter. Supports: arm64 and x64 types.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSizeList		schema
default		errorResponse		schema

Responses

200 - AWSSizeList

Status: OK

Schema

AWSSizeList

Default Response

errorResponse

Schema

ErrorResponse

list a w s subnets (listAWSSubnets)

GET /api/v1/providers/aws/{dc}/subnets

Lists available AWS subnets

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
AccessKeyID	header	string	string
Credential	header	string	string
SecretAccessKey	header	string	string
vpc	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSubnetList		schema
default		errorResponse		schema

Responses

200 - AWSSubnetList

Status: OK

Schema

AWSSubnetList

Default Response

errorResponse

Schema

ErrorResponse

list a w s subnets no credentials (listAWSSubnetsNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/aws/subnets

Lists available AWS subnets

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSubnetList		schema
default		errorResponse		schema

Responses

200 - AWSSubnetList

Status: OK

Schema

AWSSubnetList

Default Response

errorResponse

Schema

ErrorResponse

list a w s subnets no credentials v2 (listAWSSubnetsNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/aws/subnets

Lists available AWS subnets

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSSubnetList		schema
default		errorResponse		schema

Responses

200 - AWSSubnetList

Status: OK

Schema

AWSSubnetList

Default Response

errorResponse

Schema

ErrorResponse

list a w s v p c s (listAWSVPCS)

GET /api/v1/providers/aws/{dc}/vpcs

Lists available AWS vpc's

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
AccessKeyID	header	string	string
Credential	header	string	string
SecretAccessKey	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AWSVPCList		schema
default		errorResponse		schema

Responses

200 - AWSVPCList

Status: OK

Schema

AWSVPCList

Default Response

errorResponse

Schema

ErrorResponse

list accessible addons (listAccessibleAddons)

POST /api/v1/addons

Lists names of addons that can be configured inside the user clusters

Consumes

• application/json

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AccessibleAddons		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AccessibleAddons

Status: OK

Schema

AccessibleAddons

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns all available addon configs. (listAddonConfigs)

GET /api/v1/addonconfigs

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AddonConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AddonConfig

Status: OK

Schema

[]AddonConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

list addons (listAddons)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons

Lists addons that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

[]Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list addons v2 (listAddonsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/addons

Lists addons that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

[]Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns all admission plugins from the CRDs. (listAdmissionPlugins)

GET /api/v1/admin/admission/plugins

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AdmissionPlugin		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AdmissionPlugin

Status: OK

Schema

[]AdmissionPlugin

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists available Alibaba instance types. (listAlibabaInstanceTypes)

GET /api/v1/providers/alibaba/instancetypes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
AccessKeyID	header	string	string
AccessKeySecret	header	string	string
Credential	header	string	string
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaInstanceTypeList		schema
default		errorResponse		schema

Responses

200 - AlibabaInstanceTypeList

Status: OK

Schema

AlibabaInstanceTypeList

Default Response

errorResponse

Schema

ErrorResponse

list alibaba instance types no credentials (listAlibabaInstanceTypesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/alibaba/instancetypes

Lists available Alibaba Instance Types

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaInstanceTypeList		schema
default		errorResponse		schema

Responses

200 - AlibabaInstanceTypeList

Status: OK

Schema

AlibabaInstanceTypeList

Default Response

errorResponse

Schema

ErrorResponse

list alibaba instance types no credentials v2 (listAlibabaInstanceTypesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/instancetypes

Lists available Alibaba Instance Types

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaInstanceTypeList		schema
default		errorResponse		schema

Responses

200 - AlibabaInstanceTypeList

Status: OK

Schema

AlibabaInstanceTypeList

Default Response

errorResponse

Schema

ErrorResponse

Lists available Alibaba vSwitches. (listAlibabaVSwitches)

GET /api/v1/providers/alibaba/vswitches

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaVSwitchList		schema
default		errorResponse		schema

Responses

200 - AlibabaVSwitchList

Status: OK

Schema

AlibabaVSwitchList

Default Response

errorResponse

Schema

ErrorResponse

list alibaba v switches no credentials v2 (listAlibabaVSwitchesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/vswitches

Lists available Alibaba vSwitches

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaVSwitchList		schema
default		errorResponse		schema

Responses

200 - AlibabaVSwitchList

Status: OK

Schema

AlibabaVSwitchList

Default Response

errorResponse

Schema

ErrorResponse

Lists available Alibaba zones. (listAlibabaZones)

GET /api/v1/providers/alibaba/zones

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
AccessKeyID	header	string	string
AccessKeySecret	header	string	string
Credential	header	string	string
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaZoneList		schema
default		errorResponse		schema

Responses

200 - AlibabaZoneList

Status: OK

Schema

AlibabaZoneList

Default Response

errorResponse

Schema

ErrorResponse

list alibaba zones no credentials (listAlibabaZonesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/alibaba/zones

Lists available Alibaba Instance Types

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaZoneList		schema
default		errorResponse		schema

Responses

200 - AlibabaZoneList

Status: OK

Schema

AlibabaZoneList

Default Response

errorResponse

Schema

ErrorResponse

list alibaba zones no credentials v2 (listAlibabaZonesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/alibaba/zones

Lists available Alibaba Instance Types

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Region	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlibabaZoneList		schema
default		errorResponse		schema

Responses

200 - AlibabaZoneList

Status: OK

Schema

AlibabaZoneList

Default Response

errorResponse

Schema

ErrorResponse

List allowed registries. (listAllowedRegistries)

GET /api/v2/allowedregistries

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AllowedRegistry		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AllowedRegistry

Status: OK

Schema

[]AllowedRegistry

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list anexia templates (listAnexiaTemplates)

GET /api/v1/providers/anexia/templates

Lists templates from anexia

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
Location	header	string	string
Token	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AnexiaTemplateList		schema
default		errorResponse		schema

Responses

200 - AnexiaTemplateList

Status: OK

Schema

AnexiaTemplateList

Default Response

errorResponse

Schema

ErrorResponse

list anexia templates no credentials v2 (listAnexiaTemplatesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/anexia/templates

Lists templates from Anexia

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AnexiaTemplateList		schema
default		errorResponse		schema

Responses

200 - AnexiaTemplateList

Status: OK

Schema

AnexiaTemplateList

Default Response

errorResponse

Schema

ErrorResponse

list anexia vlans (listAnexiaVlans)

GET /api/v1/providers/anexia/vlans

Lists vlans from anexia

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
Token	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AnexiaVlanList		schema
default		errorResponse		schema

Responses

200 - AnexiaVlanList

Status: OK

Schema

AnexiaVlanList

Default Response

errorResponse

Schema

ErrorResponse

list anexia vlans no credentials v2 (listAnexiaVlansNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/anexia/vlans

Lists vlans from Anexia

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AnexiaVlanList		schema
default		errorResponse		schema

Responses

200 - AnexiaVlanList

Status: OK

Schema

AnexiaVlanList

Default Response

errorResponse

Schema

ErrorResponse

list azure availability zones (listAzureAvailabilityZones)

GET /api/v1/providers/azure/availabilityzones

Lists VM availability zones in an Azure region

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureAvailabilityZonesList		schema
default		errorResponse		schema

Responses

200 - AzureAvailabilityZonesList

Status: OK

Schema

AzureAvailabilityZonesList

Default Response

errorResponse

Schema

ErrorResponse

list azure availability zones no credentials (listAzureAvailabilityZonesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/azure/availabilityzones

Lists available VM availability zones in an Azure region

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
SKUName	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureAvailabilityZonesList		schema
default		errorResponse		schema

Responses

200 - AzureAvailabilityZonesList

Status: OK

Schema

AzureAvailabilityZonesList

Default Response

errorResponse

Schema

ErrorResponse

list azure availability zones no credentials v2 (listAzureAvailabilityZonesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/azure/availabilityzones

Lists available VM availability zones in an Azure region

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
SKUName	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureAvailabilityZonesList		schema
default		errorResponse		schema

Responses

200 - AzureAvailabilityZonesList

Status: OK

Schema

AzureAvailabilityZonesList

Default Response

errorResponse

Schema

ErrorResponse

list azure resource groups (listAzureResourceGroups)

GET /api/v2/providers/azure/resourcegroups

Lists available VM resource groups

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
Location	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureResourceGroupsList		schema
default		errorResponse		schema

Responses

200 - AzureResourceGroupsList

Status: OK

Schema

AzureResourceGroupsList

Default Response

errorResponse

Schema

ErrorResponse

list azure route tables (listAzureRouteTables)

GET /api/v2/providers/azure/routetables

Lists available VM route tables

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
Location	header	string	string
ResourceGroup	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureRouteTablesList		schema
default		errorResponse		schema

Responses

200 - AzureRouteTablesList

Status: OK

Schema

AzureRouteTablesList

Default Response

errorResponse

Schema

ErrorResponse

list azure security groups (listAzureSecurityGroups)

GET /api/v2/providers/azure/securitygroups

Lists available VM security groups

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
Location	header	string	string
ResourceGroup	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureSecurityGroupsList		schema
default		errorResponse		schema

Responses

200 - AzureSecurityGroupsList

Status: OK

Schema

AzureSecurityGroupsList

Default Response

errorResponse

Schema

ErrorResponse

list azure sizes (listAzureSizes)

GET /api/v1/providers/azure/sizes

Lists available VM sizes in an Azure region

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
Location	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureSizeList		schema
default		errorResponse		schema

Responses

200 - AzureSizeList

Status: OK

Schema

AzureSizeList

Default Response

errorResponse

Schema

ErrorResponse

list azure sizes no credentials (listAzureSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/azure/sizes

Lists available VM sizes in an Azure region

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureSizeList		schema
default		errorResponse		schema

Responses

200 - AzureSizeList

Status: OK

Schema

AzureSizeList

Default Response

errorResponse

Schema

ErrorResponse

list azure sizes no credentials v2 (listAzureSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/azure/sizes

Lists available VM sizes in an Azure region

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureSizeList		schema
default		errorResponse		schema

Responses

200 - AzureSizeList

Status: OK

Schema

AzureSizeList

Default Response

errorResponse

Schema

ErrorResponse

list azure subnets (listAzureSubnets)

GET /api/v2/providers/azure/subnets

Lists available VM subnets

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
ResourceGroup	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string
VirtualNetwork	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureSubnetsList		schema
default		errorResponse		schema

Responses

200 - AzureSubnetsList

Status: OK

Schema

AzureSubnetsList

Default Response

errorResponse

Schema

ErrorResponse

list azure vnets (listAzureVnets)

GET /api/v2/providers/azure/vnets

Lists available VM virtual networks

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ClientID	header	string	string
ClientSecret	header	string	string
Credential	header	string	string
Location	header	string	string
ResourceGroup	header	string	string
SubscriptionID	header	string	string
TenantID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	AzureVirtualNetworksList		schema
default		errorResponse		schema

Responses

200 - AzureVirtualNetworksList

Status: OK

Schema

AzureVirtualNetworksList

Default Response

errorResponse

Schema

ErrorResponse

list cluster role (listClusterRole)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles

Lists all ClusterRoles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRole		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRole

Status: OK

Schema

[]ClusterRole

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list cluster role binding (listClusterRoleBinding)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterbindings

List cluster role binding

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

[]ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list cluster role binding v2 (listClusterRoleBindingV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/clusterbindings

List cluster role binding

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

[]ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list cluster role names (listClusterRoleNames)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterrolenames

Lists all ClusterRoles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleName		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleName

Status: OK

Schema

[]ClusterRoleName

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list cluster role names v2 (listClusterRoleNamesV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/clusterrolenames

Lists all ClusterRoles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleName		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleName

Status: OK

Schema

[]ClusterRoleName

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list cluster role v2 (listClusterRoleV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles

Lists all ClusterRoles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRole		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRole

Status: OK

Schema

[]ClusterRole

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

List cluster templates for the given project. (listClusterTemplates)

GET /api/v2/projects/{project_id}/clustertemplates

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterTemplateList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterTemplateList

Status: OK

Schema

ClusterTemplateList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists clusters for the specified project and data center. (listClusters)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterList

Status: OK

Schema

ClusterList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists clusters for the specified project. (listClustersForProject)

GET /api/v1/projects/{project_id}/clusters

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterList

Status: OK

Schema

ClusterList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists clusters for the specified project. (listClustersV2)

GET /api/v2/projects/{project_id}/clusters

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterList

Status: OK

Schema

ClusterList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

List constraint templates. (listConstraintTemplates)

GET /api/v2/constrainttemplates

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	ConstraintTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ConstraintTemplate

Status: OK

Schema

[]ConstraintTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists constraints for the specified cluster. (listConstraints)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/constraints

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

[]Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list credentials (listCredentials)

GET /api/v1/providers/{provider_name}/presets/credentials

Lists credential names for the provider

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓
datacenter	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	CredentialList		schema
default		errorResponse		schema

Responses

200 - CredentialList

Status: OK

Schema

CredentialList

Default Response

errorResponse

Schema

ErrorResponse

Returns all datacenters for the specified provider. (listDCForProvider)

GET /api/v1/providers/{provider_name}/dc

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

[]Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Returns all datacenters for the specified seed. (listDCForSeed)

GET /api/v1/seed/{seed_name}/dc

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

[]Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list datacenters (listDatacenters)

GET /api/v1/dc

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	DatacenterList		schema
default		errorResponse		schema

Responses

200 - DatacenterList

Status: OK

Schema

DatacenterList

Default Response

errorResponse

Schema

ErrorResponse

List default constraint. (listDefaultConstraint)

GET /api/v2/constraints

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

[]Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list digitalocean sizes (listDigitaloceanSizes)

GET /api/v1/providers/digitalocean/sizes

Lists sizes from digitalocean

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
DoToken	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	DigitaloceanSizeList		schema
default		errorResponse		schema

Responses

200 - DigitaloceanSizeList

Status: OK

Schema

DigitaloceanSizeList

Default Response

errorResponse

Schema

ErrorResponse

list digitalocean sizes no credentials (listDigitaloceanSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/digitalocean/sizes

Lists sizes from digitalocean

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	DigitaloceanSizeList		schema
default		errorResponse		schema

Responses

200 - DigitaloceanSizeList

Status: OK

Schema

DigitaloceanSizeList

Default Response

errorResponse

Schema

ErrorResponse

list digitalocean sizes no credentials v2 (listDigitaloceanSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/digitalocean/sizes

Lists sizes from digitalocean

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	DigitaloceanSizeList		schema
default		errorResponse		schema

Responses

200 - DigitaloceanSizeList

Status: OK

Schema

DigitaloceanSizeList

Default Response

errorResponse

Schema

ErrorResponse

list etcd backup config (listEtcdBackupConfig)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs

List etcd backup configs for a given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdBackupConfig

Status: OK

Schema

[]EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list etcd restore (listEtcdRestore)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdrestores

List etcd backup restores for a given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdRestore		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdRestore

Status: OK

Schema

[]EtcdRestore

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an external cluster events. (listExternalClusterEvents)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/events

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Event		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Event

Status: OK

Schema

[]Event

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an external cluster nodes. (listExternalClusterNodes)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Node		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Node

Status: OK

Schema

[]Node

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Gets an external cluster nodes metrics. (listExternalClusterNodesMetrics)

GET /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}/nodesmetrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeMetric		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeMetric

Status: OK

Schema

[]NodeMetric

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists external clusters for the specified project. (listExternalClusters)

GET /api/v2/projects/{project_id}/kubernetes/clusters

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterList

Status: OK

Schema

ClusterList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list g c p disk types (listGCPDiskTypes)

GET /api/v1/providers/gcp/disktypes

Lists disk types from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
ServiceAccount	header	string	string
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPDiskTypeList		schema
default		errorResponse		schema

Responses

200 - GCPDiskTypeList

Status: OK

Schema

GCPDiskTypeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p disk types no credentials (listGCPDiskTypesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/disktypes

Lists disk types from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPDiskTypeList		schema
default		errorResponse		schema

Responses

200 - GCPDiskTypeList

Status: OK

Schema

GCPDiskTypeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p disk types no credentials v2 (listGCPDiskTypesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/disktypes

Lists disk types from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPDiskTypeList		schema
default		errorResponse		schema

Responses

200 - GCPDiskTypeList

Status: OK

Schema

GCPDiskTypeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p networks (listGCPNetworks)

GET /api/v1/providers/gcp/networks

Lists networks from GCP

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPNetworkList		schema
default		errorResponse		schema

Responses

200 - GCPNetworkList

Status: OK

Schema

GCPNetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p networks no credentials (listGCPNetworksNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/networks

Lists available GCP networks

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPNetworkList		schema
default		errorResponse		schema

Responses

200 - GCPNetworkList

Status: OK

Schema

GCPNetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p networks no credentials v2 (listGCPNetworksNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/networks

Lists available GCP networks

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPNetworkList		schema
default		errorResponse		schema

Responses

200 - GCPNetworkList

Status: OK

Schema

GCPNetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p sizes (listGCPSizes)

GET /api/v1/providers/gcp/sizes

Lists machine sizes from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
ServiceAccount	header	string	string
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPMachineSizeList		schema
default		errorResponse		schema

Responses

200 - GCPMachineSizeList

Status: OK

Schema

GCPMachineSizeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p sizes no credentials (listGCPSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/sizes

Lists machine sizes from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPMachineSizeList		schema
default		errorResponse		schema

Responses

200 - GCPMachineSizeList

Status: OK

Schema

GCPMachineSizeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p sizes no credentials v2 (listGCPSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/sizes

Lists machine sizes from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Zone	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPMachineSizeList		schema
default		errorResponse		schema

Responses

200 - GCPMachineSizeList

Status: OK

Schema

GCPMachineSizeList

Default Response

errorResponse

Schema

ErrorResponse

list g c p subnetworks (listGCPSubnetworks)

GET /api/v1/providers/gcp/{dc}/subnetworks

Lists subnetworks from GCP

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
Credential	header	string	string
Network	header	string	string
ServiceAccount	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPSubnetworkList		schema
default		errorResponse		schema

Responses

200 - GCPSubnetworkList

Status: OK

Schema

GCPSubnetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p subnetworks no credentials (listGCPSubnetworksNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/subnetworks

Lists available GCP subnetworks

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Network	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPSubnetworkList		schema
default		errorResponse		schema

Responses

200 - GCPSubnetworkList

Status: OK

Schema

GCPSubnetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p subnetworks no credentials v2 (listGCPSubnetworksNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/subnetworks

Lists available GCP subnetworks

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Network	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPSubnetworkList		schema
default		errorResponse		schema

Responses

200 - GCPSubnetworkList

Status: OK

Schema

GCPSubnetworkList

Default Response

errorResponse

Schema

ErrorResponse

list g c p zones (listGCPZones)

GET /api/v1/providers/gcp/{dc}/zones

Lists available GCP zones

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
Credential	header	string	string
ServiceAccount	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPZoneList		schema
default		errorResponse		schema

Responses

200 - GCPZoneList

Status: OK

Schema

GCPZoneList

Default Response

errorResponse

Schema

ErrorResponse

list g c p zones no credentials (listGCPZonesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/gcp/zones

Lists available GCP zones

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPZoneList		schema
default		errorResponse		schema

Responses

200 - GCPZoneList

Status: OK

Schema

GCPZoneList

Default Response

errorResponse

Schema

ErrorResponse

list g c p zones no credentials v2 (listGCPZonesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/gcp/zones

Lists available GCP zones

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	GCPZoneList		schema
default		errorResponse		schema

Responses

200 - GCPZoneList

Status: OK

Schema

GCPZoneList

Default Response

errorResponse

Schema

ErrorResponse

list hetzner sizes (listHetznerSizes)

GET /api/v1/providers/hetzner/sizes

Lists sizes from hetzner

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
HetznerToken	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	HetznerSizeList		schema
default		errorResponse		schema

Responses

200 - HetznerSizeList

Status: OK

Schema

HetznerSizeList

Default Response

errorResponse

Schema

ErrorResponse

list hetzner sizes no credentials (listHetznerSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/hetzner/sizes

Lists sizes from hetzner

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	HetznerSizeList		schema
default		errorResponse		schema

Responses

200 - HetznerSizeList

Status: OK

Schema

HetznerSizeList

Default Response

errorResponse

Schema

ErrorResponse

list hetzner sizes no credentials v2 (listHetznerSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/hetzner/sizes

Lists sizes from hetzner

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	HetznerSizeList		schema
default		errorResponse		schema

Responses

200 - HetznerSizeList

Status: OK

Schema

HetznerSizeList

Default Response

errorResponse

Schema

ErrorResponse

list installable addons (listInstallableAddons)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/installableaddons

Lists names of addons that can be installed inside the user cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AccessibleAddons		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AccessibleAddons

Status: OK

Schema

AccessibleAddons

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list installable addons v2 (listInstallableAddonsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/installableaddons

Lists names of addons that can be installed inside the user cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AccessibleAddons		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AccessibleAddons

Status: OK

Schema

AccessibleAddons

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists metrics that belong to the given machine deployment. (listMachineDeploymentMetrics)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes/metrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeMetric		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeMetric

Status: OK

Schema

[]NodeMetric

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists nodes that belong to the given machine deployment. (listMachineDeploymentNodes)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓
hideInitialConditions	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	Node		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Node

Status: OK

Schema

[]Node

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists machine deployment events. If query parameter type is set to warning then only warning events are retrieved. (listMachineDeploymentNodesEvents)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}/nodes/events

If the value is 'normal' then normal events are returned. If the query parameter is missing method returns all events.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Event		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Event

Status: OK

Schema

[]Event

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list machine deployments (listMachineDeployments)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments

Lists machine deployments that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

[]NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list metering reports (listMeteringReports)

GET /api/v1/admin/metering/reports

List metering reports. Only available in Kubermatic Enterprise Edition

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
max_keys	query	int64 (formatted integer)	int64
start_after	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	MeteringReport		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MeteringReport

Status: OK

Schema

[]MeteringReport

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list namespace (listNamespace)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/namespaces

Lists all namespaces in the cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Namespace		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Namespace

Status: OK

Schema

[]Namespace

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list namespace v2 (listNamespaceV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/namespaces

Lists all namespaces in the cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Namespace		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Namespace

Status: OK

Schema

[]Namespace

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists metrics that belong to the given node deployment. (listNodeDeploymentMetrics)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes/metrics

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeMetric		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeMetric

Status: OK

Schema

[]NodeMetric

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists nodes that belong to the given node deployment. (listNodeDeploymentNodes)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓
hideInitialConditions	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	Node		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Node

Status: OK

Schema

[]Node

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists node deployment events. If query parameter type is set to warning then only warning events are retrieved. (listNodeDeploymentNodesEvents)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}/nodes/events

If the value is 'normal' then normal events are returned. If the query parameter is missing method returns all events.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	Event		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Event

Status: OK

Schema

[]Event

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list node deployment requests (listNodeDeploymentRequests)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests

Lists NodeDeploymentRequests that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeploymentRequest		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeploymentRequest

Status: OK

Schema

[]NodeDeploymentRequest

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list node deployments (listNodeDeployments)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments

Lists node deployments that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

[]NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

This endpoint is used for kubeadm cluster. (listNodesForCluster)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/nodes

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
hideInitialConditions	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	Node		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Node

Status: OK

Schema

[]Node

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list openstack availability zones (listOpenstackAvailabilityZones)

GET /api/v1/providers/openstack/availabilityzones

Lists availability zones from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Tenant	header	string	string
TenantID	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackAvailabilityZone		schema
default		errorResponse		schema

Responses

200 - OpenstackAvailabilityZone

Status: OK

Schema

[]OpenstackAvailabilityZone

Default Response

errorResponse

Schema

ErrorResponse

list openstack availability zones no credentials (listOpenstackAvailabilityZonesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/availabilityzones

Lists availability zones from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackAvailabilityZone		schema
default		errorResponse		schema

Responses

200 - OpenstackAvailabilityZone

Status: OK

Schema

[]OpenstackAvailabilityZone

Default Response

errorResponse

Schema

ErrorResponse

list openstack availability zones no credentials v2 (listOpenstackAvailabilityZonesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/availabilityzones

Lists availability zones from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackAvailabilityZone		schema
default		errorResponse		schema

Responses

200 - OpenstackAvailabilityZone

Status: OK

Schema

[]OpenstackAvailabilityZone

Default Response

errorResponse

Schema

ErrorResponse

list openstack images (listOpenstackImages)

GET /api/v1/providers/openstack/images

Lists images from openstack

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Image		schema
default		errorResponse		schema

Responses

200 - Image

Status: OK

Schema

[]Image

Default Response

errorResponse

Schema

ErrorResponse

list openstack images no credentials (listOpenstackImagesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/images

Lists images from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Image		schema
default		errorResponse		schema

Responses

200 - Image

Status: OK

Schema

[]Image

Default Response

errorResponse

Schema

ErrorResponse

list openstack networks (listOpenstackNetworks)

GET /api/v1/providers/openstack/networks

Lists networks from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Tenant	header	string	string
TenantID	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackNetwork		schema
default		errorResponse		schema

Responses

200 - OpenstackNetwork

Status: OK

Schema

[]OpenstackNetwork

Default Response

errorResponse

Schema

ErrorResponse

list openstack networks no credentials (listOpenstackNetworksNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/networks

Lists networks from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackNetwork		schema
default		errorResponse		schema

Responses

200 - OpenstackNetwork

Status: OK

Schema

[]OpenstackNetwork

Default Response

errorResponse

Schema

ErrorResponse

list openstack networks no credentials v2 (listOpenstackNetworksNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/networks

Lists networks from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackNetwork		schema
default		errorResponse		schema

Responses

200 - OpenstackNetwork

Status: OK

Schema

[]OpenstackNetwork

Default Response

errorResponse

Schema

ErrorResponse

list openstack quota limits (listOpenstackQuotaLimits)

GET /api/v1/providers/openstack/quotalimits

Lists quotalimits for tenant from openstack

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Quotas		schema
default		errorResponse		schema

Responses

200 - Quotas

Status: OK

Schema

Quotas

Default Response

errorResponse

Schema

ErrorResponse

list openstack quota limits no credentials (listOpenstackQuotaLimitsNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/quotalimits

Lists quotalimits for tenant from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Quotas		schema
default		errorResponse		schema

Responses

200 - Quotas

Status: OK

Schema

Quotas

Default Response

errorResponse

Schema

ErrorResponse

list openstack security groups (listOpenstackSecurityGroups)

GET /api/v1/providers/openstack/securitygroups

Lists security groups from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Tenant	header	string	string
TenantID	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSecurityGroup		schema
default		errorResponse		schema

Responses

200 - OpenstackSecurityGroup

Status: OK

Schema

[]OpenstackSecurityGroup

Default Response

errorResponse

Schema

ErrorResponse

list openstack security groups no credentials (listOpenstackSecurityGroupsNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/securitygroups

Lists security groups from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSecurityGroup		schema
default		errorResponse		schema

Responses

200 - OpenstackSecurityGroup

Status: OK

Schema

[]OpenstackSecurityGroup

Default Response

errorResponse

Schema

ErrorResponse

list openstack security groups no credentials v2 (listOpenstackSecurityGroupsNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/securitygroups

Lists security groups from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSecurityGroup		schema
default		errorResponse		schema

Responses

200 - OpenstackSecurityGroup

Status: OK

Schema

[]OpenstackSecurityGroup

Default Response

errorResponse

Schema

ErrorResponse

list openstack sizes (listOpenstackSizes)

GET /api/v1/providers/openstack/sizes

Lists sizes from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Tenant	header	string	string
TenantID	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSize		schema
default		errorResponse		schema

Responses

200 - OpenstackSize

Status: OK

Schema

[]OpenstackSize

Default Response

errorResponse

Schema

ErrorResponse

list openstack sizes no credentials (listOpenstackSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/sizes

Lists sizes from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSize		schema
default		errorResponse		schema

Responses

200 - OpenstackSize

Status: OK

Schema

[]OpenstackSize

Default Response

errorResponse

Schema

ErrorResponse

list openstack sizes no credentials v2 (listOpenstackSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/sizes

Lists sizes from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSize		schema
default		errorResponse		schema

Responses

200 - OpenstackSize

Status: OK

Schema

[]OpenstackSize

Default Response

errorResponse

Schema

ErrorResponse

list openstack subnets (listOpenstackSubnets)

GET /api/v1/providers/openstack/subnets

Lists subnets from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Tenant	header	string	string
TenantID	header	string	string
Username	header	string	string
network_id	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSubnet		schema
default		errorResponse		schema

Responses

200 - OpenstackSubnet

Status: OK

Schema

[]OpenstackSubnet

Default Response

errorResponse

Schema

ErrorResponse

list openstack subnets no credentials (listOpenstackSubnetsNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/subnets

Lists subnets from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
network_id	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSubnet		schema
default		errorResponse		schema

Responses

200 - OpenstackSubnet

Status: OK

Schema

[]OpenstackSubnet

Default Response

errorResponse

Schema

ErrorResponse

list openstack subnets no credentials v2 (listOpenstackSubnetsNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/subnets

Lists subnets from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
network_id	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackSubnet		schema
default		errorResponse		schema

Responses

200 - OpenstackSubnet

Status: OK

Schema

[]OpenstackSubnet

Default Response

errorResponse

Schema

ErrorResponse

list openstack tenants (listOpenstackTenants)

GET /api/v1/providers/openstack/tenants

Lists tenants from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ApplicationCredentialID	header	string	string
ApplicationCredentialSecret	header	string	string
Credential	header	string	string
DatacenterName	header	string	string
Domain	header	string	string
OIDCAuthentication	header	boolean	bool
Password	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackTenant		schema
default		errorResponse		schema

Responses

200 - OpenstackTenant

Status: OK

Schema

[]OpenstackTenant

Default Response

errorResponse

Schema

ErrorResponse

list openstack tenants no credentials (listOpenstackTenantsNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/openstack/tenants

Lists tenants from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackTenant		schema
default		errorResponse		schema

Responses

200 - OpenstackTenant

Status: OK

Schema

[]OpenstackTenant

Default Response

errorResponse

Schema

ErrorResponse

list openstack tenants no credentials v2 (listOpenstackTenantsNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/openstack/tenants

Lists tenants from openstack

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	OpenstackTenant		schema
default		errorResponse		schema

Responses

200 - OpenstackTenant

Status: OK

Schema

[]OpenstackTenant

Default Response

errorResponse

Schema

ErrorResponse

list packet sizes (listPacketSizes)

GET /api/v1/providers/packet/sizes

Lists sizes from packet

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
apiKey	header	string	string
credential	header	string	string
projectID	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	PacketSizeList		schema
default		errorResponse		schema

Responses

200 - PacketSizeList

Status: OK

Schema

[]PacketSizeList

Default Response

errorResponse

Schema

ErrorResponse

list packet sizes no credentials (listPacketSizesNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/packet/sizes

Lists sizes from packet

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	PacketSizeList		schema
default		errorResponse		schema

Responses

200 - PacketSizeList

Status: OK

Schema

[]PacketSizeList

Default Response

errorResponse

Schema

ErrorResponse

list packet sizes no credentials v2 (listPacketSizesNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/packet/sizes

Lists sizes from packet

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	PacketSizeList		schema
default		errorResponse		schema

Responses

200 - PacketSizeList

Status: OK

Schema

[]PacketSizeList

Default Response

errorResponse

Schema

ErrorResponse

list presets (listPresets)

GET /api/v2/presets

Lists presets

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
disabled	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	PresetList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - PresetList

Status: OK

Schema

PresetList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list project etcd backup config (listProjectEtcdBackupConfig)

GET /api/v2/projects/{project_id}/etcdbackupconfigs

List etcd backup configs for a given project

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdBackupConfig

Status: OK

Schema

[]EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list project etcd restore (listProjectEtcdRestore)

GET /api/v2/projects/{project_id}/etcdrestores

List etcd backup restores for a given project

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdRestore		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdRestore

Status: OK

Schema

[]EtcdRestore

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists projects that an authenticated user is a member of. (listProjects)

GET /api/v1/projects

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
displayAll	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	Project		schema
401	Unauthorized	EmptyResponse is a empty response		schema
409	Conflict	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Project

Status: OK

Schema

[]Project

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

409 - EmptyResponse is a empty response

Status: Conflict

Schema

Default Response

errorResponse

Schema

ErrorResponse

list provider presets (listProviderPresets)

GET /api/v2/providers/{provider_name}/presets

Lists presets for the provider

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓
datacenter	query	string	string
disabled	query	boolean	bool

All responses

Code	Status	Description	Has headers	Schema
200	OK	PresetList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - PresetList

Status: OK

Schema

PresetList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role (listRole)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles

Lists all Roles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Role		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Role

Status: OK

Schema

[]Role

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role binding (listRoleBinding)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/bindings

List role binding

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

[]RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role binding v2 (listRoleBindingV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/bindings

List role binding

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

[]RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role names (listRoleNames)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/rolenames

Lists all Role names with namespaces

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleName		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleName

Status: OK

Schema

[]RoleName

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role names v2 (listRoleNamesV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/rolenames

Lists all Role names with namespaces

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleName		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleName

Status: OK

Schema

[]RoleName

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list role v2 (listRoleV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/roles

Lists all Roles

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Role		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Role

Status: OK

Schema

[]Role

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list rule groups (listRuleGroups)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups

Lists rule groups that belong to the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	RuleGroup		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RuleGroup

Status: OK

Schema

[]RuleGroup

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Lists SSH Keys that belong to the given project. (listSSHKeys)

GET /api/v1/projects/{project_id}/sshkeys

The returned collection is sorted by creation timestamp.

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - SSHKey

Status: OK

Schema

[]SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list SSH keys assigned to cluster (listSSHKeysAssignedToCluster)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/sshkeys

Lists ssh keys that are assigned to the cluster The returned collection is sorted by creation timestamp.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - SSHKey

Status: OK

Schema

[]SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list SSH keys assigned to cluster v2 (listSSHKeysAssignedToClusterV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/sshkeys

Lists ssh keys that are assigned to the cluster The returned collection is sorted by creation timestamp.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	SSHKey		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - SSHKey

Status: OK

Schema

[]SSHKey

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list seed names (listSeedNames)

GET /api/v1/seed

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	SeedNamesList		schema
default		errorResponse		schema

Responses

200 - SeedNamesList

Status: OK

Schema

SeedNamesList

Default Response

errorResponse

Schema

ErrorResponse

Returns all seeds from the CRDs. (listSeeds)

GET /api/v1/admin/seeds

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	Seed		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Seed

Status: OK

Schema

[]Seed

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list service account tokens (listServiceAccountTokens)

GET /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens

List tokens for the given service account

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	PublicServiceAccountToken		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - PublicServiceAccountToken

Status: OK

Schema

[]PublicServiceAccountToken

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list service accounts (listServiceAccounts)

GET /api/v1/projects/{project_id}/serviceaccounts

List Service Accounts for the given project

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	ServiceAccount		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ServiceAccount

Status: OK

Schema

[]ServiceAccount

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list system labels (listSystemLabels)

GET /api/v1/labels/system

List restricted system labels

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	ResourceLabelMap		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ResourceLabelMap

Status: OK

Schema

ResourceLabelMap

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

list v sphere datastores (listVSphereDatastores)

GET /api/v2/providers/vsphere/datastores

Lists datastores from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
DatacenterName	header	string	string
Password	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereDatastoreList		schema
default		errorResponse		schema

Responses

200 - VSphereDatastoreList

Status: OK

Schema

[]VSphereDatastoreList

Default Response

errorResponse

Schema

ErrorResponse

list v sphere folders (listVSphereFolders)

GET /api/v1/providers/vsphere/folders

Lists folders from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
DatacenterName	header	string	string
Password	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereFolder		schema
default		errorResponse		schema

Responses

200 - VSphereFolder

Status: OK

Schema

[]VSphereFolder

Default Response

errorResponse

Schema

ErrorResponse

list v sphere folders no credentials (listVSphereFoldersNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/vsphere/folders

Lists folders from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereFolder		schema
default		errorResponse		schema

Responses

200 - VSphereFolder

Status: OK

Schema

[]VSphereFolder

Default Response

errorResponse

Schema

ErrorResponse

list v sphere folders no credentials v2 (listVSphereFoldersNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/vsphere/folders

Lists folders from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereFolder		schema
default		errorResponse		schema

Responses

200 - VSphereFolder

Status: OK

Schema

[]VSphereFolder

Default Response

errorResponse

Schema

ErrorResponse

list v sphere networks (listVSphereNetworks)

GET /api/v1/providers/vsphere/networks

Lists networks from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Credential	header	string	string
DatacenterName	header	string	string
Password	header	string	string
Username	header	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereNetwork		schema
default		errorResponse		schema

Responses

200 - VSphereNetwork

Status: OK

Schema

[]VSphereNetwork

Default Response

errorResponse

Schema

ErrorResponse

list v sphere networks no credentials (listVSphereNetworksNoCredentials)

GET /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/providers/vsphere/networks

Lists networks from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereNetwork		schema
default		errorResponse		schema

Responses

200 - VSphereNetwork

Status: OK

Schema

[]VSphereNetwork

Default Response

errorResponse

Schema

ErrorResponse

list v sphere networks no credentials v2 (listVSphereNetworksNoCredentialsV2)

GET /api/v2/projects/{project_id}/clusters/{cluster_id}/providers/vsphere/networks

Lists networks from vsphere datacenter

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	VSphereNetwork		schema
default		errorResponse		schema

Responses

200 - VSphereNetwork

Status: OK

Schema

[]VSphereNetwork

Default Response

errorResponse

Schema

ErrorResponse

list versions by provider (listVersionsByProvider)

GET /api/v2/providers/{provider_name}/versions

Lists all versions which don't result in automatic updates for a given provider

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓
type	query	string	string

All responses

Code	Status	Description	Has headers	Schema
200	OK	VersionList		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - VersionList

Status: OK

Schema

VersionList

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Adds current authorization bearer token to the blacklist. (logoutCurrentUser)

POST /api/v1/me/logout

Enforces user to login again with the new token.

Produces

• application/json

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

migrate cluster to external c c m (migrateClusterToExternalCCM)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/externalccmmigration

Enable the migration to the external CCM for the given cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches an addon that is assigned to the given cluster. (patchAddon)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/addons/{addon_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	Addon	models.Addon

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches an addon that is assigned to the given cluster. (patchAddonV2)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}/addons/{addon_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
addon_id	path	string	string		✓
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	Addon	models.Addon

All responses

Code	Status	Description	Has headers	Schema
200	OK	Addon		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Addon

Status: OK

Schema

Addon

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch allowed registry (patchAllowedRegistry)

PATCH /api/v2/allowedregistries/{allowed_registry}

Patch a specified allowed registry

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
allowed_registry	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	ConstraintTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ConstraintTemplate

Status: OK

Schema

ConstraintTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches the given cluster using JSON Merge Patch method (https://tools.ietf.org/html/rfc7396). (patchCluster)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch cluster role (patchClusterRole)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}

Patch the cluster role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRole		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRole

Status: OK

Schema

ClusterRole

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches the given cluster using JSON Merge Patch method (https://tools.ietf.org/html/rfc7396). (patchClusterV2)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches a given constraint for the specified cluster. (patchConstraint)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}/constraints/{constraint_name}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
constraint_name	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch constraint template (patchConstraintTemplate)

PATCH /api/v2/constrainttemplates/{ct_name}

Patch a specified constraint template

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
ct_name	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	ConstraintTemplate		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ConstraintTemplate

Status: OK

Schema

ConstraintTemplate

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates settings of the current user. (patchCurrentUserSettings)

PATCH /api/v1/me/settings

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	UserSettings		schema
401	Unauthorized	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - UserSettings

Status: OK

Schema

UserSettings

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patch the datacenter. (patchDC)

PATCH /api/v1/seed/{seed_name}/dc/{dc}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
seed_name	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch default constraint (patchDefaultConstraint)

PATCH /api/v2/constraints/{constraint_name}

Patch a specified default constraint

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
constraint_name	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Constraint		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Constraint

Status: OK

Schema

Constraint

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch etcd backup config (patchEtcdBackupConfig)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}/etcdbackupconfigs/{ebc_id}

Patches a etcd backup config for a given cluster based on its id

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
ebc_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	EtcdBackupConfigSpec	models.EtcdBackupConfigSpec		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EtcdBackupConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EtcdBackupConfig

Status: OK

Schema

EtcdBackupConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches the gatekeeper config for the specified cluster. (patchGatekeeperConfig)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}/gatekeeper/config

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	GatekeeperConfig		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - GatekeeperConfig

Status: OK

Schema

GatekeeperConfig

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches the global settings. (patchKubermaticSettings)

PATCH /api/v1/admin/settings

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	GlobalSettings		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - GlobalSettings

Status: OK

Schema

GlobalSettings

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch machine deployment (patchMachineDeployment)

PATCH /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}

Patches a machine deployment that is assigned to the given cluster. Please note that at the moment only node deployment's spec can be updated by a patch, no other fields can be changed using this endpoint.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch node deployment (patchNodeDeployment)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodedeployments/{nodedeployment_id}

Patches a node deployment that is assigned to the given cluster. Please note that at the moment only node deployment's spec can be updated by a patch, no other fields can be changed using this endpoint.

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
nodedeployment_id	path	string	string		✓
project_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Patches a NodeDeploymentRequest that is assigned to the given cluster. (patchNodeDeploymentRequest)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/ndrequests/{ndrequest_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
ndrequest_id	path	string	string		✓
project_id	path	string	string		✓
Patch	body	[]uint8 (formatted integer)	[]uint8

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeploymentRequest		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeploymentRequest

Status: OK

Schema

NodeDeploymentRequest

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch role (patchRole)

PATCH /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}

Patch the role with the given name

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Patch	body	interface{}	interface{}

All responses

Code	Status	Description	Has headers	Schema
200	OK	Role		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Role

Status: OK

Schema

Role

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

patch service account token (patchServiceAccountToken)

PATCH /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}

Patches the token name

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓
token_id	path	string	string		✓
Body	body	[]uint8 (formatted integer)	[]uint8

All responses

Code	Status	Description	Has headers	Schema
200	OK	PublicServiceAccountToken		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - PublicServiceAccountToken

Status: OK

Schema

PublicServiceAccountToken

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Resets the alertmanager configuration to default for the specified cluster. (resetAlertmanager)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Schedules rolling restart of a machine deployment that is assigned to the given cluster. (restartMachineDeployment)

POST /api/v2/projects/{project_id}/clusters/{cluster_id}/machinedeployments/{machinedeployment_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
machinedeployment_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	NodeDeployment		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - NodeDeployment

Status: OK

Schema

NodeDeployment

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

revoke cluster admin token (revokeClusterAdminToken)

PUT /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/token

Revokes the current admin token

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

revoke cluster admin token v2 (revokeClusterAdminTokenV2)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/token

Revokes the current admin token

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

revoke cluster viewer token (revokeClusterViewerToken)

PUT /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/viewertoken

Revokes the current viewer token

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

revoke cluster viewer token v2 (revokeClusterViewerTokenV2)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/viewertoken

Revokes the current viewer token

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Allows setting and clearing admin role for users. (setAdmin)

PUT /api/v1/admin

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
Body	body	Admin	models.Admin

All responses

Code	Status	Description	Has headers	Schema
200	OK	Admin		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Admin

Status: OK

Schema

Admin

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

unbind user from cluster role binding (unbindUserFromClusterRoleBinding)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings

Unbinds user from cluster role binding

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	ClusterRoleUser	models.ClusterRoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

unbind user from cluster role binding v2 (unbindUserFromClusterRoleBindingV2)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/clusterroles/{role_id}/clusterbindings

Unbinds user from cluster role binding

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	ClusterRoleUser	models.ClusterRoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	ClusterRoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ClusterRoleBinding

Status: OK

Schema

ClusterRoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

unbind user from role binding (unbindUserFromRoleBinding)

DELETE /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings

Unbinds user from the role binding

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	RoleUser	models.RoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

unbind user from role binding v2 (unbindUserFromRoleBindingV2)

DELETE /api/v2/projects/{project_id}/clusters/{cluster_id}/roles/{namespace}/{role_id}/bindings

Unbinds user from the role binding

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
namespace	path	string	string		✓
project_id	path	string	string		✓
role_id	path	string	string		✓
Body	body	RoleUser	models.RoleUser

All responses

Code	Status	Description	Has headers	Schema
200	OK	RoleBinding		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RoleBinding

Status: OK

Schema

RoleBinding

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates the admission plugin. (updateAdmissionPlugin)

PATCH /api/v1/admin/admission/plugins/{name}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
name	path	string	string		✓
Body	body	AdmissionPlugin	models.AdmissionPlugin

All responses

Code	Status	Description	Has headers	Schema
200	OK	AdmissionPlugin		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - AdmissionPlugin

Status: OK

Schema

AdmissionPlugin

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

update alertmanager (updateAlertmanager)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/alertmanager/config

Updates an alertmanager configuration for the given cluster

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	Alertmanager	models.Alertmanager		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Alertmanager		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Alertmanager

Status: OK

Schema

Alertmanager

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Update the datacenter. The datacenter spec will be overwritten with the one provided in the request. (updateDC)

PUT /api/v1/seed/{seed_name}/dc/{dc}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
dc	path	string	string		✓
seed_name	path	string	string		✓
Body	body	UpdateDCBody	UpdateDCBody

All responses

Code	Status	Description	Has headers	Schema
200	OK	Datacenter		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Datacenter

Status: OK

Schema

Datacenter

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

UpdateDCBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	DatacenterSpec	models.DatacenterSpec

Updates an external cluster for the given project. (updateExternalCluster)

PUT /api/v2/projects/{project_id}/kubernetes/clusters/{cluster_id}

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	Body	models.Body

All responses

Code	Status	Description	Has headers	Schema
200	OK	Cluster		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Cluster

Status: OK

Schema

Cluster

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates the MLA admin setting for the given cluster. (updateMLAAdminSetting)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/mlaadminsetting

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	MLAAdminSetting	models.MLAAdminSetting		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	MLAAdminSetting		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - MLAAdminSetting

Status: OK

Schema

MLAAdminSetting

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

update preset (updatePreset)

PUT /api/v2/providers/{provider_name}/presets

Updates provider preset

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
provider_name	path	string	string		✓
Body	body	Preset	models.Preset		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	Preset		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Preset

Status: OK

Schema

Preset

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates the status of a preset. It can enable or disable it, so that it won't be listed by the list endpoints. (updatePresetStatus)

PUT /api/v2/presets/{preset_name}/status

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
preset_name	path	string	string		✓
provider	query	string	string
Body	body	UpdatePresetStatusBody	UpdatePresetStatusBody		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

UpdatePresetStatusBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool

update project (updateProject)

PUT /api/v1/projects/{project_id}

Updates the given project

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
Body	body	Project	models.Project

All responses

Code	Status	Description	Has headers	Schema
200	OK	Project		schema
400	Bad Request	EmptyResponse is a empty response		schema
404	Not Found	EmptyResponse is a empty response		schema
500	Internal Server Error	EmptyResponse is a empty response		schema
501	Not Implemented	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Project

Status: OK

Schema

Project

400 - EmptyResponse is a empty response

Status: Bad Request

Schema

404 - EmptyResponse is a empty response

Status: Not Found

Schema

500 - EmptyResponse is a empty response

Status: Internal Server Error

Schema

501 - EmptyResponse is a empty response

Status: Not Implemented

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates the specified rule group for the given cluster. (updateRuleGroup)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/rulegroups/{rulegroup_id}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
rulegroup_id	path	string	string		✓
Body	body	RuleGroup	models.RuleGroup		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	RuleGroup		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - RuleGroup

Status: OK

Schema

RuleGroup

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Updates the seed. (updateSeed)

PATCH /api/v1/admin/seeds/{seed_name}

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
seed_name	path	string	string		✓
Body	body	UpdateSeedBody	UpdateSeedBody

All responses

Code	Status	Description	Has headers	Schema
200	OK	Seed		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - Seed

Status: OK

Schema

Seed

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Inlined models

UpdateSeedBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	SeedSpec	models.SeedSpec

update service account (updateServiceAccount)

PUT /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}

Updates service account for the given project

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓
Body	body	ServiceAccount	models.ServiceAccount

All responses

Code	Status	Description	Has headers	Schema
200	OK	ServiceAccount		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ServiceAccount

Status: OK

Schema

ServiceAccount

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

update service account token (updateServiceAccountToken)

PUT /api/v1/projects/{project_id}/serviceaccounts/{serviceaccount_id}/tokens/{token_id}

Updates and regenerates the token

Consumes

• application/json

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
project_id	path	string	string		✓
serviceaccount_id	path	string	string		✓
token_id	path	string	string		✓
Body	body	PublicServiceAccountToken	models.PublicServiceAccountToken

All responses

Code	Status	Description	Has headers	Schema
200	OK	ServiceAccountToken		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - ServiceAccountToken

Status: OK

Schema

ServiceAccountToken

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

upgrade cluster node deployments (upgradeClusterNodeDeployments)

PUT /api/v1/projects/{project_id}/dc/{dc}/clusters/{cluster_id}/nodes/upgrades

Upgrades node deployments in a cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
dc	path	string	string		✓
project_id	path	string	string		✓
Body	body	MasterVersion	models.MasterVersion

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

upgrade cluster node deployments v2 (upgradeClusterNodeDeploymentsV2)

PUT /api/v2/projects/{project_id}/clusters/{cluster_id}/nodes/upgrades

Upgrades node deployments in a cluster

Produces

• application/json

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
cluster_id	path	string	string		✓
project_id	path	string	string		✓
Body	body	MasterVersion	models.MasterVersion

All responses

Code	Status	Description	Has headers	Schema
200	OK	EmptyResponse is a empty response		schema
401	Unauthorized	EmptyResponse is a empty response		schema
403	Forbidden	EmptyResponse is a empty response		schema
default		errorResponse		schema

Responses

200 - EmptyResponse is a empty response

Status: OK

Schema

401 - EmptyResponse is a empty response

Status: Unauthorized

Schema

403 - EmptyResponse is a empty response

Status: Forbidden

Schema

Default Response

errorResponse

Schema

ErrorResponse

Models

AWSCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
AccessKeyID	string	string
ControlPlaneRoleARN	string	string			The IAM role, the control plane will use. The control plane will perform an assume-role
InstanceProfileName	string	string
OpenstackBillingTenant	string	string
RoleName	string	string			DEPRECATED. Don't care for the role name. We only require the ControlPlaneRoleARN to be set so the control plane
can perform the assume-role.
We keep it for backwards compatibility (We use this name for cleanup purpose).
RouteTableID	string	string
SecretAccessKey	string	string
SecurityGroupID	string	string
VPCID	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

AWSNodeSpec

AWSNodeSpec aws specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
AMI	string	string			ami to use. Will be defaulted to a ami for your selected operating system and region. Only set this when you know what you do.
AssignPublicIP	boolean	bool			This flag controls a property of the AWS instance. When set the AWS instance will get a public IP address
assigned during launch overriding a possible setting in the used AWS subnet.
AvailabilityZone	string	string			Availability zone in which to place the node. It is coupled with the subnet to which the node will belong.
InstanceType	string	string	✓			t2.micro
IsSpotInstance	boolean	bool			IsSpotInstance indicates whether the created machine is an aws ec2 spot instance or on-demand ec2 instance.
SpotInstanceInterruptionBehavior	string	string			SpotInstanceInterruptionBehavior sets the interruption behavior for the spot instance when capacity is no longer
available at the price you specified, if there is no capacity, or if a constraint cannot be met. Charges for EBS
volume storage apply when an instance is stopped.
SpotInstanceMaxPrice	string	string			SpotInstanceMaxPrice is the maximum price you are willing to pay per instance hour. Your instance runs when
your maximum price is greater than the Spot Price.
SpotInstancePersistentRequest	boolean	bool			SpotInstancePersistentRequest ensures that your request will be submitted every time your Spot Instance is terminated.
SubnetID	string	string			The VPC subnet to which the node shall be connected.
Tags	map of string	map[string]string			additional instance tags
VolumeSize	int64 (formatted integer)	int64	✓		size of the volume in gb. Only one volume will be created
VolumeType	string	string	✓			gp2, io1, st1, sc1, standard

AWSSecurityGroupList

Properties

Name	Type	Go type	Required	Default	Description	Example
IDs	[]string	[]string

AWSSize

Properties

Name	Type	Go type	Required	Default	Description	Example
Architecture	string	string
GPUs	int64 (formatted integer)	int64
Memory	float (formatted number)	float32
Name	string	string
PrettyName	string	string
Price	double (formatted number)	float64
VCPUs	int64 (formatted integer)	int64

AWSSizeList

[]AWSSize

AWSSubnet

Properties

Name	Type	Go type	Required	Default	Description	Example
AvailabilityZone	string	string
AvailabilityZoneID	string	string
AvailableIPAddressCount	int64 (formatted integer)	int64
DefaultForAz	boolean	bool
ID	string	string
IPv4CIDR	string	string
IPv6CIDR	string	string
IsDefaultSubnet	boolean	bool
Name	string	string
State	string	string
Tags	[]AWSTag	[]*AWSTag

AWSSubnetList

[]AWSSubnet

AWSTag

Properties

Name	Type	Go type	Required	Default	Description	Example
Key	string	string
Value	string	string

AWSVPC

Properties

Name	Type	Go type	Required	Default	Description	Example
CidrBlock	string	string			The primary IPv4 CIDR block for the VPC.
CidrBlockAssociationSet	[]AWSVpcCidrBlockAssociation	[]*AWSVpcCidrBlockAssociation			Information about the IPv4 CIDR blocks associated with the VPC.
DhcpOptionsID	string	string			The ID of the set of DHCP options you've associated with the VPC (or default
if the default options are associated with the VPC).
InstanceTenancy	string	string			The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet	[]AWSVpcIPV6CidrBlockAssociation	[]*AWSVpcIPV6CidrBlockAssociation			Information about the IPv6 CIDR blocks associated with the VPC.
IsDefault	boolean	bool			Indicates whether the VPC is the default VPC.
Name	string	string
OwnerID	string	string			The ID of the AWS account that owns the VPC.
State	string	string			The current state of the VPC.
Tags	[]AWSTag	[]*AWSTag			Any tags assigned to the VPC.
VpcID	string	string			The ID of the VPC.

AWSVPCList

[]AWSVPC

AWSVpcCidrBlockAssociation

Properties

Name	Type	Go type	Required	Default	Description	Example
AssociationID	string	string			The association ID for the IPv4 CIDR block.
CidrBlock	string	string			The IPv4 CIDR block.
State	string	string			The state of the CIDR block.
StatusMessage	string	string			A message about the status of the CIDR block, if applicable.

AWSVpcIpv6CidrBlockAssociation

Properties

Name	Type	Go type	Required	Default	Description	Example
AssociationID	string	string			The association ID for the IPv4 CIDR block.
CidrBlock	string	string			The IPv4 CIDR block.
State	string	string			The state of the CIDR block.
StatusMessage	string	string			A message about the status of the CIDR block, if applicable.

Absolute

Usage is a struct that contains the current resource usage and limits of a tenant.

Properties

Name	Type	Go type	Required	Default	Description	Example
MaxImageMeta	int64 (formatted integer)	int64			MaxImageMeta is the amount of image metadata available to a tenant.
MaxPersonality	int64 (formatted integer)	int64			MaxPersonality is the amount of personality/files available to a tenant.
MaxPersonalitySize	int64 (formatted integer)	int64			MaxPersonalitySize is the personality file size available to a tenant.
MaxSecurityGroupRules	int64 (formatted integer)	int64			MaxSecurityGroupRules is the number of security group rules available to
a tenant.
MaxSecurityGroups	int64 (formatted integer)	int64			MaxSecurityGroups is the number of security groups available to a tenant.
MaxServerGroupMembers	int64 (formatted integer)	int64			MaxServerGroupMembers is the number of server group members available
to a tenant.
MaxServerGroups	int64 (formatted integer)	int64			MaxServerGroups is the number of server groups available to a tenant.
MaxServerMeta	int64 (formatted integer)	int64			MaxServerMeta is the amount of server metadata available to a tenant.
MaxTotalCores	int64 (formatted integer)	int64			MaxTotalCores is the number of cores available to a tenant.
MaxTotalFloatingIps	int64 (formatted integer)	int64			MaxTotalFloatingIps is the number of floating IPs available to a tenant.
MaxTotalInstances	int64 (formatted integer)	int64			MaxTotalInstances is the number of instances/servers available to a tenant.
MaxTotalKeypairs	int64 (formatted integer)	int64			MaxTotalKeypairs is the total keypairs available to a tenant.
MaxTotalRAMSize	int64 (formatted integer)	int64			MaxTotalRAMSize is the total amount of RAM available to a tenant measured
in megabytes (MB).
TotalCoresUsed	int64 (formatted integer)	int64			TotalCoresUsed is the number of cores currently in use.
TotalFloatingIpsUsed	int64 (formatted integer)	int64			TotalFloatingIpsUsed is the number of floating IPs in use.
TotalInstancesUsed	int64 (formatted integer)	int64			TotalInstancesUsed is the number of instances/servers in use.
TotalRAMUsed	int64 (formatted integer)	int64			TotalRAMUsed is the total RAM/memory in use measured in megabytes (MB).
TotalSecurityGroupsUsed	int64 (formatted integer)	int64			TotalSecurityGroupsUsed is the total number of security groups in use.
TotalServerGroupsUsed	int64 (formatted integer)	int64			TotalServerGroupsUsed is the total number of server groups in use.

AccessibleAddons

[]string

Addon

Addon represents a predefined addon that users may install into their cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	AddonSpec	AddonSpec

AddonConfig

AddonConfig represents a addon configuration

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	AddonConfigSpec	AddonConfigSpec

AddonConfigSpec

AddonConfigSpec specifies configuration of addon

Properties

Name	Type	Go type	Required	Default	Description	Example
Controls	[]AddonFormControl	[]*AddonFormControl			Controls that can be set for configured addon
Description	string	string			Description of the configured addon, it will be displayed in the addon overview in the UI
Logo	string	string			Logo of the configured addon, encoded in base64
LogoFormat	string	string			LogoFormat contains logo format of the configured addon, i.e. svg+xml
ShortDescription	string	string			ShortDescription of the configured addon that contains more detailed information about the addon,
it will be displayed in the addon details view in the UI

AddonFormControl

AddonFormControl specifies addon form control

Properties

Name	Type	Go type	Required	Default	Description	Example
DisplayName	string	string			DisplayName is visible in the UI
HelpText	string	string			HelpText is visible in the UI next to the control
InternalName	string	string			InternalName is used internally to save in the addon object
Required	boolean	bool			Required indicates if the control has to be set
Type	string	string			Type of displayed control

AddonSpec

AddonSpec addon specification

Properties

Name	Type	Go type	Required	Default	Description	Example
ContinuouslyReconcile	boolean	bool			ContinuouslyReconcile indicates that the addon cannot be deleted or modified outside of the UI after installation
IsDefault	boolean	bool			IsDefault indicates whether the addon is default
Variables	map of any	map[string]interface{}			Variables is free form data to use for parsing the manifest templates

Admin

Admin represents admin user

Properties

Name	Type	Go type	Required	Default	Description	Example
Email	string	string			Email address of the admin user
IsAdmin	boolean	bool			IsAdmin indicates admin role
Name	string	string			Name of the admin user

AdmissionPlugin

AdmissionPlugin represents an admission plugin

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
Plugin	string	string
fromVersion	Semver	Semver

AdmissionPluginList

AdmissionPluginList represents a list of admission plugins

[]string

Alertmanager

Alertmanager represents an Alertmanager Configuration

Properties

Name	Type	Go type	Required	Default	Description	Example
spec	AlertmanagerSpec	AlertmanagerSpec

AlertmanagerSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Config	[]uint8 (formatted integer)	[]uint8			Config contains the alertmanager configuration in YAML

AlibabaCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
AccessKeyID	string	string
AccessKeySecret	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

AlibabaInstanceType

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUCoreCount	int64 (formatted integer)	int64
GPUCoreCount	int64 (formatted integer)	int64
ID	string	string
MemorySize	double (formatted number)	float64

AlibabaInstanceTypeList

[]AlibabaInstanceType

AlibabaNodeSpec

AlibabaNodeSpec alibaba specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DiskSize	string	string
DiskType	string	string
InstanceType	string	string
InternetMaxBandwidthOut	string	string
Labels	map of string	map[string]string
VSwitchID	string	string
ZoneID	string	string

AlibabaVSwitch

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string

AlibabaVSwitchList

[]AlibabaVSwitch

AlibabaZone

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string

AlibabaZoneList

[]AlibabaZone

AllowedRegistry

AllowedRegistry represents a object containing a allowed image registry prefix

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	AllowedRegistrySpec	AllowedRegistrySpec

AllowedRegistrySpec

Properties

Name	Type	Go type	Required	Default	Description	Example
RegistryPrefix	string	string			RegistryPrefix contains the prefix of the registry which will be allowed. User clusters will be able to deploy
only images which are prefixed with one of the allowed image registry prefixes.

AnexiaCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Token	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

AnexiaNodeSpec

AnexiaNodeSpec anexia specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUs	int64 (formatted integer)	int64	✓		CPUs states how many cpus the node will have.
DiskSize	int64 (formatted integer)	int64	✓		DiskSize states the disk size that node will have.
Memory	int64 (formatted integer)	int64	✓		Memory states the memory that node will have.
TemplateID	string	string	✓		TemplateID instance template
VlanID	string	string	✓		VlanID Instance vlanID

AnexiaTemplate

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string

AnexiaTemplateList

[]AnexiaTemplate

AnexiaVlan

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string

AnexiaVlanList

[]AnexiaVlan

AuditLoggingSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool

AzureAvailabilityZonesList

AzureAvailabilityZonesList is the object representing the availability zones for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
Zones	[]string	[]string

AzureCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
AssignAvailabilitySet	boolean	bool
AvailabilitySet	string	string
ClientID	string	string
ClientSecret	string	string
OpenstackBillingTenant	string	string
ResourceGroup	string	string
RouteTableName	string	string
SecurityGroup	string	string
SubnetName	string	string
SubscriptionID	string	string
TenantID	string	string
VNetName	string	string
VNetResourceGroup	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector
loadBalancerSKU	LBSKU	LBSKU

AzureNodeSpec

AzureNodeSpec describes settings for an Azure node

Properties

Name	Type	Go type	Required	Default	Description	Example
AssignAvailabilitySet	boolean	bool			AssignAvailabilitySet is used to check if an availability set should be created and assigned to the cluster.
AssignPublicIP	boolean	bool			should the machine have a publicly accessible IP address
DataDiskSize	int32 (formatted integer)	int32			Data disk size in GB
ImageID	string	string			ImageID represents the ID of the image that should be used to run the node
OSDiskSize	int32 (formatted integer)	int32			OS disk size in GB
Size	string	string	✓		VM size
Tags	map of string	map[string]string			Additional metadata to set
Zones	[]string	[]string			Zones represents the availability zones for azure vms

AzureResourceGroupsList

AzureResourceGroupsList is the object representing the resource groups for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
ResourceGroups	[]string	[]string

AzureRouteTablesList

AzureRouteTablesList is the object representing the route tables for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
RouteTables	[]string	[]string

AzureSecurityGroupsList

AzureSecurityGroupsList is the object representing the security groups for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
SecurityGroups	[]string	[]string

AzureSize

Properties

Name	Type	Go type	Required	Default	Description	Example
MaxDataDiskCount	int32 (formatted integer)	int32
MemoryInMB	int32 (formatted integer)	int32
Name	string	string
NumberOfCores	int32 (formatted integer)	int32
NumberOfGPUs	int32 (formatted integer)	int32
OsDiskSizeInMB	int32 (formatted integer)	int32
ResourceDiskSizeInMB	int32 (formatted integer)	int32

AzureSizeList

[]AzureSize

AzureSubnetsList

AzureSubnetsList is the object representing the subnets for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
Subnets	[]string	[]string

AzureVirtualNetworksList

AzureVirtualNetworksList is the object representing the virtual network for vms in azure cloud provider

Properties

Name	Type	Go type	Required	Default	Description	Example
VirtualNetworks	[]string	[]string

BackupCredentials

BackupCredentials contains credentials for etcd backups

Properties

Name	Type	Go type	Required	Default	Description	Example
s3	S3BackupCredentials	S3BackupCredentials

BackupStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
BackupMessage	string	string
BackupName	string	string
DeleteJobName	string	string
DeleteMessage	string	string
JobName	string	string
backupFinishedTime	Time	Time
backupPhase	BackupStatusPhase	BackupStatusPhase
backupStartTime	Time	Time
deleteFinishedTime	Time	Time
deletePhase	BackupStatusPhase	BackupStatusPhase
deleteStartTime	Time	Time
scheduledTime	Time	Time

BackupStatusPhase

Name	Type	Go type	Default	Description	Example
BackupStatusPhase	string	string

BringYourOwnCloudSpec

interface{}

ByPodStatus

ByPodStatus defines the observed state of ConstraintTemplate as seen by an individual controller +kubebuilder:pruning:PreserveUnknownFields

Properties

Name	Type	Go type	Required	Default	Description	Example
Errors	[]CreateCRDError	[]*CreateCRDError
ID	string	string			a unique identifier for the pod that wrote the status
ObservedGeneration	int64 (formatted integer)	int64

CRD

Properties

Name	Type	Go type	Required	Default	Description	Example
spec	CRDSpec	CRDSpec

CRDSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
names	Names	Names
validation	Validation	Validation

CentOSSpec

CentOSSpec contains CentOS specific settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DistUpgradeOnBoot	boolean	bool			do a dist-upgrade on boot and reboot it required afterwards

CleanupOptions

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool
Enforced	boolean	bool

CloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
DatacenterName	string	string			DatacenterName where the users 'cloud' lives in.
alibaba	AlibabaCloudSpec	AlibabaCloudSpec
anexia	AnexiaCloudSpec	AnexiaCloudSpec
aws	AWSCloudSpec	AWSCloudSpec
azure	AzureCloudSpec	AzureCloudSpec
bringyourown	BringYourOwnCloudSpec	BringYourOwnCloudSpec
digitalocean	DigitaloceanCloudSpec	DigitaloceanCloudSpec
fake	FakeCloudSpec	FakeCloudSpec
gcp	GCPCloudSpec	GCPCloudSpec
hetzner	HetznerCloudSpec	HetznerCloudSpec
kubevirt	KubevirtCloudSpec	KubevirtCloudSpec
openstack	OpenstackCloudSpec	OpenstackCloudSpec
packet	PacketCloudSpec	PacketCloudSpec
vsphere	VSphereCloudSpec	VSphereCloudSpec

Cluster

Note: Cluster has a custom MarshalJSON method defined and thus the output may vary

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
Credential	string	string
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
InheritedLabels	map of string	map[string]string
Labels	map of string	map[string]string
Name	string	string			Name represents human readable name for the resource
Type	string	string
spec	ClusterSpec	ClusterSpec
status	ClusterStatus	ClusterStatus

ClusterHealth

Properties

Name	Type	Go type	Required	Default	Description	Example
apiserver	HealthStatus	HealthStatus
cloudProviderInfrastructure	HealthStatus	HealthStatus
controller	HealthStatus	HealthStatus
etcd	HealthStatus	HealthStatus
gatekeeperAudit	HealthStatus	HealthStatus
gatekeeperController	HealthStatus	HealthStatus
machineController	HealthStatus	HealthStatus
scheduler	HealthStatus	HealthStatus
userClusterControllerManager	HealthStatus	HealthStatus

ClusterList

ClusterList represents a list of clusters

[]Cluster

ClusterMetrics

ClusterMetrics defines a metric for the given cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
controlPlane	ControlPlaneMetrics	ControlPlaneMetrics
nodes	NodesMetric	NodesMetric

ClusterNetworkingConfig

ClusterNetworkingConfig specifies the different networking parameters for a cluster.

Properties

Name	Type	Go type	Required	Default	Description	Example
DNSDomain	string	string			Domain name for services.
KonnectivityEnabled	boolean	bool			KonnectivityEnabled enables konnectivity for controlplane to node network communication.
NodeLocalDNSCacheEnabled	boolean	bool			NodeLocalDNSCacheEnabled controls whether the NodeLocal DNS Cache feature is enabled.
Defaults to true.
ProxyMode	string	string			ProxyMode defines the kube-proxy mode (ipvs/iptables).
Defaults to ipvs.
ipvs	IPVSConfiguration	IPVSConfiguration
pods	NetworkRanges	NetworkRanges
services	NetworkRanges	NetworkRanges

ClusterRole

ClusterRole defines cluster RBAC role for the user cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
Rules	[]PolicyRule	[]*PolicyRule			Rules holds all the PolicyRules for this ClusterRole

ClusterRoleBinding

Properties

Name	Type	Go type	Required	Default	Description	Example
RoleRefName	string	string
Subjects	[]Subject	[]*Subject			Subjects holds references to the objects the role applies to.

ClusterRoleName

ClusterRoleName defines RBAC cluster role name object for the user cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the cluster role.

ClusterRoleUser

ClusterRoleUser defines associated user with cluster role

Properties

Name	Type	Go type	Required	Default	Description	Example
Group	string	string
UserEmail	string	string

ClusterSpec

ClusterSpec defines the cluster specification

Properties

Name	Type	Go type	Required	Default	Description	Example
AdmissionPlugins	[]string	[]string			Additional Admission Controller plugins
ContainerRuntime	string	string			ContainerRuntime to use, i.e. Docker or containerd. By default containerd will be used.
EnableUserSSHKeyAgent	boolean	bool			EnableUserSSHKeyAgent control whether the UserSSHKeyAgent will be deployed in the user cluster or not.
If it was enabled, the agent will be deployed and used to sync the user ssh keys, that the user attach
to the created cluster. If the agent was disabled, it won't be deployed in the user cluster, thus after
the cluster creation any attached ssh keys won't be synced to the worker nodes. Once the agent is enabled/disabled
it cannot be changed after the cluster is being created.
MachineNetworks	[]MachineNetworkingConfig	[]*MachineNetworkingConfig			MachineNetworks optionally specifies the parameters for IPAM.
PodNodeSelectorAdmissionPluginConfig	map of string	map[string]string			PodNodeSelectorAdmissionPluginConfig provides the configuration for the PodNodeSelector.
It's used by the backend to create a configuration file for this plugin.
The key:value from the map is converted to the namespace: in the file.
The format in a file:
podNodeSelectorPluginConfig:
clusterDefaultNodeSelector:
namespace1:
namespace2:
UsePodNodeSelectorAdmissionPlugin	boolean	bool			If active the PodNodeSelector admission plugin is configured at the apiserver
UsePodSecurityPolicyAdmissionPlugin	boolean	bool			If active the PodSecurityPolicy admission plugin is configured at the apiserver
auditLogging	AuditLoggingSettings	AuditLoggingSettings
cloud	CloudSpec	CloudSpec
clusterNetwork	ClusterNetworkingConfig	ClusterNetworkingConfig
mla	MLASettings	MLASettings
oidc	OIDCSettings	OIDCSettings
opaIntegration	OPAIntegrationSettings	OPAIntegrationSettings
serviceAccount	ServiceAccountSettings	ServiceAccountSettings
sys11auth	Sys11AuthSettings	Sys11AuthSettings
updateWindow	UpdateWindow	UpdateWindow
version	Semver	Semver

ClusterStatus

ClusterStatus defines the cluster status

Properties

Name	Type	Go type	Required	Default	Description	Example
URL	string	string			URL specifies the address at which the cluster is available
externalCCMMigration	ExternalCCMMigrationStatus	ExternalCCMMigrationStatus
version	Semver	Semver

ClusterTemplate

ClusterTemplate represents a ClusterTemplate object

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string
Name	string	string
ProjectID	string	string
Scope	string	string
User	string	string
UserSSHKeys	[]ClusterTemplateSSHKey	[]*ClusterTemplateSSHKey
cluster	Cluster	Cluster
nodeDeployment	NodeDeployment	NodeDeployment

ClusterTemplateInstance

ClusterTemplateInstance represents a ClusterTemplateInstance object

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	ClusterTemplateInstanceSpec	ClusterTemplateInstanceSpec

ClusterTemplateInstanceSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
ClusterTemplateID	string	string
ClusterTemplateName	string	string
ProjectID	string	string
Replicas	int64 (formatted integer)	int64

ClusterTemplateList

ClusterTemplateList represents a ClusterTemplate list

[]ClusterTemplate

ClusterTemplateSSHKey

ClusterTemplateSSHKey represents SSH Key object for Cluster Template

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string
Name	string	string

ClusterType

Name	Type	Go type	Default	Description	Example
ClusterType	int8 (formatted integer)	int8

ConditionStatus

Name	Type	Go type	Default	Description	Example
ConditionStatus	string	string

Constraint

Constraint represents a gatekeeper Constraint

Properties

Name	Type	Go type	Required	Default	Description	Example
Labels	map of string	map[string]string
Name	string	string
spec	ConstraintSpec	ConstraintSpec
status	ConstraintStatus	ConstraintStatus

ConstraintSelector

ConstraintSelector is the object holding the cluster selection filters

Properties

Name	Type	Go type	Required	Default	Description	Example
Providers	[]string	[]string			Providers is a list of cloud providers to which the Constraint applies to. Empty means all providers are selected.
labelSelector	LabelSelector	LabelSelector

ConstraintSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
ConstraintType	string	string			ConstraintType specifies the type of gatekeeper constraint that the constraint applies to
Disabled	boolean	bool			Disabled is the flag for disabling OPA constraints
match	Match	Match
parameters	Parameters	Parameters
selector	ConstraintSelector	ConstraintSelector

ConstraintStatus

ConstraintStatus represents a constraint status which holds audit info

Properties

Name	Type	Go type	Required	Default	Description	Example
AuditTimestamp	string	string
Enforcement	string	string
Synced	boolean	bool
Violations	[]Violation	[]*Violation

ConstraintTemplate

ConstraintTemplate represents a gatekeeper ConstraintTemplate

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	ConstraintTemplateSpec	ConstraintTemplateSpec
status	ConstraintTemplateStatus	ConstraintTemplateStatus

ConstraintTemplateSelector

ConstraintTemplateSelector is the object holding the cluster selection filters

Properties

Name	Type	Go type	Required	Default	Description	Example
Providers	[]string	[]string			Providers is a list of cloud providers to which the Constraint Template applies to. Empty means all providers are selected.
labelSelector	LabelSelector	LabelSelector

ConstraintTemplateSpec

ConstraintTemplateSpec is the object representing the gatekeeper constraint template spec and kubermatic related spec

Properties

Name	Type	Go type	Required	Default	Description	Example
Targets	[]Target	[]*Target
crd	CRD	CRD
selector	ConstraintTemplateSelector	ConstraintTemplateSelector

ConstraintTemplateStatus

ConstraintTemplateStatus defines the observed state of ConstraintTemplate

Properties

Name	Type	Go type	Required	Default	Description	Example
ByPod	[]ByPodStatus	[]*ByPodStatus
Created	boolean	bool

ControlPlaneMetrics

ControlPlaneMetrics defines a metric for the user cluster control plane resources

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUTotalMillicores	int64 (formatted integer)	int64			CPUTotalMillicores in m cores
MemoryTotalBytes	int64 (formatted integer)	int64			MemoryTotalBytes in bytes

CreateCRDError

Properties

Name	Type	Go type	Required	Default	Description	Example
Code	string	string
Location	string	string
Message	string	string

CreateClusterSpec

CreateClusterSpec is the structure that is used to create cluster with its initial node deployment

Properties

Name	Type	Go type	Required	Default	Description	Example
DNSDomain	string	string
PodsCIDR	string	string
ServicesCIDR	string	string
cluster	Cluster	Cluster
nodeDeployment	NodeDeployment	NodeDeployment

CredentialList

Properties

Name	Type	Go type	Required	Default	Description	Example
Names	[]string	[]string

CustomLink

Properties

Name	Type	Go type	Required	Default	Description	Example
Icon	string	string
Label	string	string
Location	string	string
URL	string	string

CustomLinks

[]CustomLink

Datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
metadata	DatacenterMeta	DatacenterMeta
spec	DatacenterSpec	DatacenterSpec

DatacenterList

DatacenterList represents a list of datacenters

[]Datacenter

DatacenterMeta

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string

DatacenterSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Country	string	string			Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK.
It is used for informational purposes.
EnforceAuditLogging	boolean	bool			EnforceAuditLogging enforces audit logging on every cluster within the DC,
ignoring cluster-specific settings.
EnforcePodSecurityPolicy	boolean	bool			EnforcePodSecurityPolicy enforces pod security policy plugin on every clusters within the DC,
ignoring cluster-specific settings
Location	string	string			Optional: Detailed location of the cluster, like "Hamburg" or "Datacenter 7".
It is used for informational purposes.
Provider	string	string			Name of the datacenter provider. Extracted based on which provider is defined in the spec.
It is used for informational purposes.
RequiredEmailDomain	string	string			Deprecated. Automatically migrated to the RequiredEmailDomains field.
RequiredEmailDomains	[]string	[]string
Seed	string	string			Name of the seed this datacenter belongs to.
alibaba	DatacenterSpecAlibaba	DatacenterSpecAlibaba
anexia	DatacenterSpecAnexia	DatacenterSpecAnexia
aws	DatacenterSpecAWS	DatacenterSpecAWS
azure	DatacenterSpecAzure	DatacenterSpecAzure
bringyourown	DatacenterSpecBringYourOwn	DatacenterSpecBringYourOwn
digitalocean	DatacenterSpecDigitalocean	DatacenterSpecDigitalocean
fake	DatacenterSpecFake	DatacenterSpecFake
gcp	DatacenterSpecGCP	DatacenterSpecGCP
hetzner	DatacenterSpecHetzner	DatacenterSpecHetzner
kubevirt	DatacenterSpecKubevirt	DatacenterSpecKubevirt
node	NodeSettings	NodeSettings
openstack	DatacenterSpecOpenstack	DatacenterSpecOpenstack
packet	DatacenterSpecPacket	DatacenterSpecPacket
vsphere	DatacenterSpecVSphere	DatacenterSpecVSphere

DatacenterSpecAWS

DatacenterSpecAWS describes an AWS datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Region	string	string			The AWS region to use, e.g. "us-east-1". For a list of available regions, see
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
images	ImageList	ImageList

DatacenterSpecAlibaba

Properties

Name	Type	Go type	Required	Default	Description	Example
Region	string	string			Region to use, for a full list of regions see
https://www.alibabacloud.com/help/doc-detail/40654.htm

DatacenterSpecAnexia

Properties

Name	Type	Go type	Required	Default	Description	Example
LocationID	string	string			LocationID the location of the region

DatacenterSpecAzure

DatacenterSpecAzure describes an Azure cloud datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Location	string	string			Region to use, for example "westeurope". A list of available regions can be
found at https://azure.microsoft.com/en-us/global-infrastructure/locations/

DatacenterSpecBringYourOwn

DatacenterSpecBringYourOwn describes a datacenter our of bring your own nodes

interface{}

DatacenterSpecDigitalocean

DatacenterSpecDigitalocean describes a DigitalOcean datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Region	string	string			Datacenter location, e.g. "ams3". A list of existing datacenters can be found
at https://www.digitalocean.com/docs/platform/availability-matrix/

DatacenterSpecFake

DatacenterSpecFake describes a fake datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
FakeProperty	string	string

DatacenterSpecGCP

DatacenterSpecGCP describes a GCP datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Region	string	string			Region to use, for example "europe-west3", for a full list of regions see
https://cloud.google.com/compute/docs/regions-zones/
Regional	boolean	bool			Optional: Regional clusters spread their resources across multiple availability zones.
Refer to the official documentation for more details on this:
https://cloud.google.com/kubernetes-engine/docs/concepts/regional-clusters
ZoneSuffixes	[]string	[]string			List of enabled zones, for example [a, c]. See the link above for the available
zones in your chosen region.

DatacenterSpecHetzner

DatacenterSpecHetzner describes a Hetzner cloud datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Datacenter	string	string			Datacenter location, e.g. "nbg1-dc3". A list of existing datacenters can be found
at https://wiki.hetzner.de/index.php/Rechenzentren_und_Anbindung/en
Location	string	string			Optional: Detailed location of the datacenter, like "Hamburg" or "Datacenter 7".
For informational purposes only.
Network	string	string			Network is the pre-existing Hetzner network in which the machines are running.
While machines can be in multiple networks, a single one must be chosen for the
HCloud CCM to work.

DatacenterSpecKubevirt

Properties

Name	Type	Go type	Required	Default	Description	Example
DNSPolicy	string	string			DNSPolicy represents the dns policy for the pod. Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst',
'Default' or 'None'. Defaults to "ClusterFirst". DNS parameters given in DNSConfig will be merged with the
policy selected with DNSPolicy.
dns_config	PodDNSConfig	PodDNSConfig

DatacenterSpecOpenstack

DatacenterSpecOpenstack describes an OpenStack datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
AuthURL	string	string
AvailabilityZone	string	string
DNSServers	[]string	[]string			Used for automatic network creation
EnabledFlavors	[]string	[]string			Optional: List of enabled flavors for the given datacenter
EnforceFloatingIP	boolean	bool			Optional
IgnoreVolumeAZ	boolean	bool			Optional
ManageSecurityGroups	boolean	bool			Optional: Gets mapped to the "manage-security-groups" setting in the cloud config.
See https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#load-balancer
This setting defaults to true.
NodeVolumeAttachLimit	uint64 (formatted integer)	uint64
Region	string	string
TrustDevicePath	boolean	bool			Optional: Gets mapped to the "trust-device-path" setting in the cloud config.
See https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#block-storage
This setting defaults to false.
UseOctavia	boolean	bool			Optional: Gets mapped to the "use-octavia" setting in the cloud config.
use-octavia is enabled by default in CCM since v1.17.0, and disabled by
default with the in-tree cloud provider.
images	ImageList	ImageList
node_size_requirements	OpenstackNodeSizeRequirements	OpenstackNodeSizeRequirements

DatacenterSpecPacket

DatacenterSpecPacket describes a Packet datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
Facilities	[]string	[]string			The list of enabled facilities, for example "ams1", for a full list of available
facilities see https://support.packet.com/kb/articles/data-centers

DatacenterSpecVSphere

DatacenterSpecVSphere describes a vSphere datacenter

Properties

Name	Type	Go type	Required	Default	Description	Example
AllowInsecure	boolean	bool			If set to true, disables the TLS certificate check against the endpoint.
Cluster	string	string			Optional: The name of the vSphere cluster to use.
Cluster is deprecated and may be removed in future releases as it is
currently ignored.
The cluster hosting the VMs will be the same VM used as a template is
located.
Datacenter	string	string			The name of the datacenter to use.
DefaultDatastore	string	string			The default Datastore to be used for provisioning volumes using storage
classes/dynamic provisioning and for storing virtual machine files in
case no Datastore or DatastoreCluster is provided at Cluster level.
DefaultStoragePolicy	string	string			The name of the storage policy to use for the storage class created in the user cluster.
Endpoint	string	string			Endpoint URL to use, including protocol, for example "https://vcenter.example.com".
RootPath	string	string			Optional: The root path for cluster specific VM folders. Each cluster gets its own
folder below the root folder. Must be the FQDN (for example
"/datacenter-1/vm/all-kubermatic-vms-in-here") and defaults to the root VM
folder: "/datacenter-1/vm"
infra_management_user	VSphereCredentials	VSphereCredentials
templates	ImageList	ImageList

DigitaloceanCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Token	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

DigitaloceanNodeSpec

DigitaloceanNodeSpec digitalocean node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
Backups	boolean	bool			enable backups for the droplet
IPv6	boolean	bool			enable ipv6 for the droplet
Monitoring	boolean	bool			enable monitoring for the droplet
Size	string	string	✓		droplet size slug
Tags	[]string	[]string			additional droplet tags

DigitaloceanSize

Properties

Name	Type	Go type	Required	Default	Description	Example
Available	boolean	bool
Disk	int64 (formatted integer)	int64
Memory	int64 (formatted integer)	int64
PriceHourly	double (formatted number)	float64
PriceMonthly	double (formatted number)	float64
Regions	[]string	[]string
Slug	string	string
Transfer	double (formatted number)	float64
VCPUs	int64 (formatted integer)	int64

DigitaloceanSizeList

Properties

Name	Type	Go type	Required	Default	Description	Example
Optimized	[]DigitaloceanSize	[]*DigitaloceanSize
Standard	[]DigitaloceanSize	[]*DigitaloceanSize

ErrorDetails

ErrorDetails contains details about the error

Properties

Name	Type	Go type	Required	Default	Description	Example
Additional	[]string	[]string			Additional error messages
Code	int64 (formatted integer)	int64	✓		The error code
Message	string	string	✓		The error message

ErrorResponse

ErrorResponse is the default representation of an error

Properties

Name	Type	Go type	Required	Default	Description	Example
error	ErrorDetails	ErrorDetails

EtcdBackupConfig

EtcdBackupConfig represents an object holding the configuration for etcd backups

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	EtcdBackupConfigSpec	EtcdBackupConfigSpec
status	EtcdBackupConfigStatus	EtcdBackupConfigStatus

EtcdBackupConfigCondition

Properties

Name	Type	Go type	Required	Default	Description	Example
Message	string	string			Human readable message indicating details about last transition.
+optional
Reason	string	string			(brief) reason for the condition's last transition.
+optional
lastHeartbeatTime	Time	Time
lastTransitionTime	Time	Time
status	ConditionStatus	ConditionStatus
type	EtcdBackupConfigConditionType	EtcdBackupConfigConditionType

EtcdBackupConfigConditionType

EtcdBackupConfigConditionType is used to indicate the type of a EtcdBackupConfig condition. For all condition types, the true value must indicate success. All condition types must be registered within the AllClusterConditionTypes variable.

Name	Type	Go type	Default	Description	Example
EtcdBackupConfigConditionType	string	string		EtcdBackupConfigConditionType is used to indicate the type of a EtcdBackupConfig condition. For all condition
types, the true value must indicate success. All condition types must be registered within
the AllClusterConditionTypes variable.

EtcdBackupConfigSpec

EtcdBackupConfigSpec represents an object holding the etcd backup configuration specification

Properties

Name	Type	Go type	Required	Default	Description	Example
ClusterID	string	string			ClusterID is the id of the cluster which will be backed up
Keep	int64 (formatted integer)	int64			Keep is the number of backups to keep around before deleting the oldest one
If not set, defaults to DefaultKeptBackupsCount. Only used if Schedule is set.
Schedule	string	string			Schedule is a cron expression defining when to perform
the backup. If not set, the backup is performed exactly
once, immediately.

EtcdBackupConfigStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
CleanupRunning	boolean	bool			If the controller was configured with a cleanupContainer, CleanupRunning keeps track of the corresponding job
Conditions	[]EtcdBackupConfigCondition	[]*EtcdBackupConfigCondition			Conditions contains conditions of the EtcdBackupConfig
CurrentBackups	[]BackupStatus	[]*BackupStatus			CurrentBackups tracks the creation and deletion progress if all backups managed by the EtcdBackupConfig

EtcdRestore

EtcdRestore represents an object holding the configuration for etcd backup restore

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string
spec	EtcdRestoreSpec	EtcdRestoreSpec
status	EtcdRestoreStatus	EtcdRestoreStatus

EtcdRestorePhase

Name	Type	Go type	Default	Description	Example
EtcdRestorePhase	string	string

EtcdRestoreSpec

EtcdRestoreSpec represents an object holding the etcd backup restore configuration specification

Properties

Name	Type	Go type	Required	Default	Description	Example
BackupDownloadCredentialsSecret	string	string			BackupDownloadCredentialsSecret is the name of a secret in the cluster-xxx namespace containing
credentials needed to download the backup
BackupName	string	string			BackupName is the name of the backup to restore from
ClusterID	string	string			ClusterID is the id of the cluster which will be restored from the backup

EtcdRestoreStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
phase	EtcdRestorePhase	EtcdRestorePhase
restoreTime	Time	Time

Event

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
Count	int32 (formatted integer)	int32			The number of times this event has occurred.
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
LastTimestamp	date-time (formatted string)	strfmt.DateTime			The time at which the most recent occurrence of this event was recorded.
Message	string	string			A human-readable description of the status of this operation.
Name	string	string			Name represents human readable name for the resource
Type	string	string			Type of this event (i.e. normal or warning). New types could be added in the future.
involvedObject	ObjectReferenceResource	ObjectReferenceResource

ExposeStrategy

Name	Type	Go type	Default	Description	Example
ExposeStrategy	string	string

ExternalCCMMigrationStatus

Name	Type	Go type	Default	Description	Example
ExternalCCMMigrationStatus	string	string

ExternalDocumentation

Properties

Name	Type	Go type	Required	Default	Description	Example
Description	string	string
URL	string	string

FakeCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Token	string	string

FlatcarSpec

FlatcarSpec contains Flatcar Linux specific settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DisableAutoUpdate	boolean	bool			disable flatcar linux auto-update feature

GCPCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Network	string	string
ServiceAccount	string	string
Subnetwork	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

GCPDiskType

Properties

Name	Type	Go type	Required	Default	Description	Example
Description	string	string
Name	string	string

GCPDiskTypeList

[]GCPDiskType

GCPMachineSize

Properties

Name	Type	Go type	Required	Default	Description	Example
Description	string	string
Memory	int64 (formatted integer)	int64
Name	string	string
VCPUs	int64 (formatted integer)	int64

GCPMachineSizeList

[]GCPMachineSize

GCPNetwork

Properties

Name	Type	Go type	Required	Default	Description	Example
AutoCreateSubnetworks	boolean	bool
ID	uint64 (formatted integer)	uint64
Kind	string	string
Name	string	string
Path	string	string
Subnetworks	[]string	[]string

GCPNetworkList

[]GCPNetwork

GCPNodeSpec

GCPNodeSpec gcp specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
CustomImage	string	string
DiskSize	int64 (formatted integer)	int64
DiskType	string	string
Labels	map of string	map[string]string
MachineType	string	string
Preemptible	boolean	bool
Tags	[]string	[]string
Zone	string	string

GCPSubnetwork

Properties

Name	Type	Go type	Required	Default	Description	Example
GatewayAddress	string	string
ID	uint64 (formatted integer)	uint64
IPCidrRange	string	string
Kind	string	string
Name	string	string
Network	string	string
Path	string	string
PrivateIPGoogleAccess	boolean	bool
Region	string	string
SelfLink	string	string

GCPSubnetworkList

[]GCPSubnetwork

GCPZone

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string

GCPZoneList

[]GCPZone

GVK

GVK group version kind of a resource

Properties

Name	Type	Go type	Required	Default	Description	Example
Group	string	string
Kind	string	string
Version	string	string

GatekeeperConfig

GatekeeperConfig represents a gatekeeper config

Properties

Name	Type	Go type	Required	Default	Description	Example
spec	GatekeeperConfigSpec	GatekeeperConfigSpec

GatekeeperConfigSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Match	[]MatchEntry	[]*MatchEntry			Configuration for namespace exclusion
readiness	ReadinessSpec	ReadinessSpec
sync	Sync	Sync
validation	Validation	Validation

GlobalCustomLinks

GlobalCustomLinks defines custom links for global settings

[]CustomLink

GlobalObjectKeySelector

GlobalObjectKeySelector is needed as we can not use v1.SecretKeySelector because it is not cross namespace

Properties

Name	Type	Go type	Required	Default	Description	Example
APIVersion	string	string			API version of the referent.
+optional
FieldPath	string	string			If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers{name}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object.
TODO: this design is not final and this field is subject to change in the future.
+optional
Key	string	string
Kind	string	string			Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+optional
Name	string	string			Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+optional
Namespace	string	string			Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+optional
ResourceVersion	string	string			Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional
uid	UID	UID

GlobalSecretKeySelector

• composed type GlobalObjectKeySelector

GlobalSettings

GlobalSettings defines global settings

• composed type SettingSpec

HealthStatus

Name	Type	Go type	Default	Description	Example
HealthStatus	int64 (formatted integer)	int64

HetznerCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Network	string	string			Network is the pre-existing Hetzner network in which the machines are running.
While machines can be in multiple networks, a single one must be chosen for the
HCloud CCM to work.
If this is empty, the network configured on the datacenter will be used.
Token	string	string			Token is used to authenticate with the Hetzner cloud API.
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

HetznerNodeSpec

HetznerNodeSpec Hetzner node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
Network	string	string			network name
Type	string	string	✓		server type

HetznerSize

Properties

Name	Type	Go type	Required	Default	Description	Example
Cores	int64 (formatted integer)	int64
Description	string	string
Disk	int64 (formatted integer)	int64
ID	int64 (formatted integer)	int64
Memory	float (formatted number)	float32
Name	string	string

HetznerSizeList

Properties

Name	Type	Go type	Required	Default	Description	Example
Dedicated	[]HetznerSize	[]*HetznerSize
Standard	[]HetznerSize	[]*HetznerSize

IPVSConfiguration

Properties

Name	Type	Go type	Required	Default	Description	Example
StrictArp	boolean	bool			StrictArp configure arp_ignore and arp_announce to avoid answering ARP queries from kube-ipvs0 interface.
defaults to true.

Image

Properties

Name	Type	Go type	Required	Default	Description	Example
Created	string	string			Created is the date when the image was created.
ID	string	string			ID is the unique ID of an image.
Metadata	map of any	map[string]interface{}			Metadata provides free-form key/value pairs that further describe the
image.
MinDisk	int64 (formatted integer)	int64			MinDisk is the minimum amount of disk a flavor must have to be able
to create a server based on the image, measured in GB.
MinRAM	int64 (formatted integer)	int64			MinRAM is the minimum amount of RAM a flavor must have to be able
to create a server based on the image, measured in MB.
Name	string	string			Name provides a human-readable moniker for the OS image.
Progress	int64 (formatted integer)	int64			The Progress and Status fields indicate image-creation status.
Status	string	string			Status is the current status of the image.
Updated	string	string			Update is the date when the image was updated.

ImageList

ImageList defines a map of operating system and the image to use

ImageList

JSON

These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Properties

Name	Type	Go type	Required	Default	Description	Example
Raw	[]uint8 (formatted integer)	[]uint8

JSONSchemaDefinitions

JSONSchemaDefinitions

JSONSchemaDependencies

JSONSchemaDependencies

JSONSchemaProps

Properties

Name	Type	Go type	Required	Default	Description	Example
$schema	JSONSchemaURL	JSONSchemaURL
AllOf	[]JSONSchemaProps	[]*JSONSchemaProps
AnyOf	[]JSONSchemaProps	[]*JSONSchemaProps
Description	string	string
Enum	[]JSON	[]*JSON
ExclusiveMaximum	boolean	bool
ExclusiveMinimum	boolean	bool
Format	string	string			format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:

bsonobjectid: a bson object ID, i.e. a 24 characters hex string uri: an URI as parsed by Golang net/url.ParseRequestURI email: an email address as parsed by Golang net/mail.ParseAddress hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. ipv4: an IPv4 IP as parsed by Golang net.ParseIP ipv6: an IPv6 IP as parsed by Golang net.ParseIP cidr: a CIDR as parsed by Golang net.ParseCIDR mac: a MAC address as parsed by Golang net.ParseMAC uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" isbn10: an ISBN10 number string like "0321751043" isbn13: an ISBN13 number string like "978-0321751041" creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" byte: base64 encoded binary data password: any kind of string date: a date string like "2006-01-02" as defined by full-date in RFC3339 duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. | | | ID | string| string | | | | | | MaxItems | int64 (formatted integer)| int64 | | | | | | MaxLength | int64 (formatted integer)| int64 | | | | | | MaxProperties | int64 (formatted integer)| int64 | | | | | | Maximum | double (formatted number)| float64 | | | | | | MinItems | int64 (formatted integer)| int64 | | | | | | MinLength | int64 (formatted integer)| int64 | | | | | | MinProperties | int64 (formatted integer)| int64 | | | | | | Minimum | double (formatted number)| float64 | | | | | | MultipleOf | double (formatted number)| float64 | | | | | | Nullable | boolean| bool | | | | | | OneOf | []JSONSchemaProps| []*JSONSchemaProps | | | | | | Pattern | string| string | | | | | | PatternProperties | map of JSONSchemaProps| map[string]JSONSchemaProps | | | | | | Properties | map of JSONSchemaProps| map[string]JSONSchemaProps | | | | | | Ref | string| string | | | | | | Required | []string| []string | | | | | | Title | string| string | | | | | | Type | string| string | | | | | | UniqueItems | boolean| bool | | | | | | XEmbeddedResource | boolean| bool | | | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). | | | XIntOrString | boolean| bool | | | x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:

1. anyOf: type: integer type: string
2. allOf: anyOf: type: integer type: string ... zero or more | | | XListMapKeys | []string| []string | | | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type map by specifying the keys used as the index of the map.

This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).

The properties specified must either be required or have a default value, to ensure those properties are present for all list items.

+optional | | | XListType | string| string | | | x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:

1. atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...).

2. set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type atomic or an array with x-kubernetes-list-type atomic.

3. map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays. +optional | | | XMapType | string| string | | | x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:

4. granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps.

5. atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated. +optional | | | XPreserveUnknownFields | boolean| bool | | | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. | | | additionalItems | JSONSchemaPropsOrBool| JSONSchemaPropsOrBool | | | | | | additionalProperties | JSONSchemaPropsOrBool| JSONSchemaPropsOrBool | | | | | | default | JSON| JSON | | | | | | definitions | JSONSchemaDefinitions| JSONSchemaDefinitions | | | | | | dependencies | JSONSchemaDependencies| JSONSchemaDependencies | | | | | | example | JSON| JSON | | | | | | externalDocs | ExternalDocumentation| ExternalDocumentation | | | | | | items | JSONSchemaPropsOrArray| JSONSchemaPropsOrArray | | | | | | not | JSONSchemaProps| JSONSchemaProps | | | | |

JSONSchemaPropsOrArray

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

Properties

Name	Type	Go type	Required	Default	Description	Example
JSONSchemas	[]JSONSchemaProps	[]*JSONSchemaProps
Schema	JSONSchemaProps	JSONSchemaProps

JSONSchemaPropsOrBool

Defaults to true for the boolean property.

Properties

Name	Type	Go type	Required	Default	Description	Example
Allows	boolean	bool
Schema	JSONSchemaProps	JSONSchemaProps

JSONSchemaPropsOrStringArray

Properties

Name	Type	Go type	Required	Default	Description	Example
Property	[]string	[]string
Schema	JSONSchemaProps	JSONSchemaProps

JSONSchemaURL

Name	Type	Go type	Default	Description	Example
JSONSchemaURL	string	string

Kind

Kind specifies the resource Kind and APIGroup

Properties

Name	Type	Go type	Required	Default	Description	Example
APIGroups	[]string	[]string			APIGroups specifies the APIGroups of the resources
Kinds	[]string	[]string			Kinds specifies the kinds of the resources

KubermaticVersions

Properties

Name	Type	Go type	Required	Default	Description	Example
API	string	string			Version of the Kubermatic API server.

KubevirtCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Kubeconfig	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

KubevirtNodeSpec

KubevirtNodeSpec kubevirt specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUs	string	string	✓		CPUs states how many cpus the kubevirt node will have.
Memory	string	string	✓		Memory states the memory that kubevirt node will have.
Namespace	string	string	✓		Namespace states in which namespace kubevirt node will be provisioned.
PVCSize	string	string	✓		PVCSize states the size of the provisioned pvc per node.
SourceURL	string	string	✓		SourceURL states the url from which the imported image will be downloaded.
StorageClassName	string	string	✓		StorageClassName states the storage class name for the provisioned PVCs.

LBSKU

Name	Type	Go type	Default	Description	Example
LBSKU	string	string

LabelKeyList

[]string

LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic

Properties

Name	Type	Go type	Required	Default	Description	Example
MatchExpressions	[]LabelSelectorRequirement	[]*LabelSelectorRequirement			matchExpressions is a list of label selector requirements. The requirements are ANDed.
+optional
MatchLabels	map of string	map[string]string			matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
+optional

LabelSelectorOperator

Name	Type	Go type	Default	Description	Example
LabelSelectorOperator	string	string

LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Properties

Name	Type	Go type	Required	Default	Description	Example
Key	string	string			key is the label key that the selector applies to.
+patchMergeKey=key
+patchStrategy=merge
Values	[]string	[]string			values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
+optional
operator	LabelSelectorOperator	LabelSelectorOperator

Limits

Properties

Name	Type	Go type	Required	Default	Description	Example
absolute	Absolute	Absolute

LoggingRateLimitSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
IngestionBurstSize	int32 (formatted integer)	int32			IngestionBurstSize represents ingestion burst size in number of requests (nginx burst).
IngestionRate	int32 (formatted integer)	int32			IngestionRate represents ingestion rate limit in requests per second (nginx rate in r/s).
QueryBurstSize	int32 (formatted integer)	int32			QueryBurstSize represents query burst size in number of requests (nginx burst).
QueryRate	int32 (formatted integer)	int32			QueryRate represents query request rate limit per second (nginx rate in r/s).

MLA

Properties

Name	Type	Go type	Required	Default	Description	Example
UserClusterMLAEnabled	boolean	bool			whether the user cluster MLA (Monitoring, Logging & Alerting) stack is enabled in the seed

MLAAdminSetting

Properties

Name	Type	Go type	Required	Default	Description	Example
loggingRateLimits	LoggingRateLimitSettings	LoggingRateLimitSettings
monitoringRateLimits	MonitoringRateLimitSettings	MonitoringRateLimitSettings

MLASettings

Properties

Name	Type	Go type	Required	Default	Description	Example
LoggingEnabled	boolean	bool			LoggingEnabled is the flag for enabling logging in user cluster.
MonitoringEnabled	boolean	bool			MonitoringEnabled is the flag for enabling monitoring in user cluster.
loggingResources	ResourceRequirements	ResourceRequirements
monitoringResources	ResourceRequirements	ResourceRequirements

MachineDeploymentStatus

[MachineDeploymentStatus] MachineDeploymentStatus defines the observed state of MachineDeployment

Properties

Name	Type	Go type	Required	Default	Description	Example
AvailableReplicas	int32 (formatted integer)	int32			Total number of available machines (ready for at least minReadySeconds)
targeted by this deployment.
+optional
ObservedGeneration	int64 (formatted integer)	int64			The generation observed by the deployment controller.
+optional
ReadyReplicas	int32 (formatted integer)	int32			Total number of ready machines targeted by this deployment.
+optional
Replicas	int32 (formatted integer)	int32			Total number of non-terminated machines targeted by this deployment
(their labels match the selector).
+optional
UnavailableReplicas	int32 (formatted integer)	int32			Total number of unavailable machines targeted by this deployment.
This is the total number of machines that are still required for
the deployment to have 100% available capacity. They may either
be machines that are running but not yet available or machines
that still have not been created.
+optional
UpdatedReplicas	int32 (formatted integer)	int32			Total number of non-terminated machines targeted by this deployment
that have the desired template spec.
+optional

MachineDeploymentVMResourceQuota

Properties

Name	Type	Go type	Required	Default	Description	Example
EnableGPU	boolean	bool
MaxCPU	int64 (formatted integer)	int64			Maximal number of vCPU
MaxRAM	int64 (formatted integer)	int64			Maximum RAM size in GB
MinCPU	int64 (formatted integer)	int64			Minimal number of vCPU
MinRAM	int64 (formatted integer)	int64			Minimal RAM size in GB

MachineNetworkingConfig

Properties

Name	Type	Go type	Required	Default	Description	Example
CIDR	string	string
DNSServers	[]string	[]string
Gateway	string	string

MasterVersion

MasterVersion describes a version of the master components

Properties

Name	Type	Go type	Required	Default	Description	Example
Default	boolean	bool
RestrictedByKubeletVersion	boolean	bool			If true, then given version control plane version is not compatible
with one of the kubelets inside cluster and shouldn't be used.
version	Version	Version

Match

Match contains the constraint to resource matching data

Properties

Name	Type	Go type	Required	Default	Description	Example
ExcludedNamespaces	[]string	[]string			ExcludedNamespaces is a list of namespace names. If defined, a constraint will only apply to resources not in a listed namespace.
Kinds	[]Kind	[]*Kind			Kinds accepts a list of objects with apiGroups and kinds fields that list the groups/kinds of objects to which
the constraint will apply. If multiple groups/kinds objects are specified, only one match is needed for the resource to be in scope
Namespaces	[]string	[]string			Namespaces is a list of namespace names. If defined, a constraint will only apply to resources in a listed namespace.
Scope	string	string			Scope accepts *, Cluster, or Namespaced which determines if cluster-scoped and/or namesapced-scoped resources are selected. (defaults to *)
labelSelector	LabelSelector	LabelSelector
namespaceSelector	LabelSelector	LabelSelector

MatchEntry

Properties

Name	Type	Go type	Required	Default	Description	Example
ExcludedNamespaces	[]string	[]string			Namespaces which will be excluded
Processes	[]string	[]string			Processes which will be excluded in the given namespaces (sync, webhook, audit, *)

MeteringConfigurations

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool
StorageClassName	string	string			StorageClassName is the name of the storage class that the metering tool uses to save processed files before
exporting it to s3 bucket. Default value is kubermatic-fast.
StorageSize	string	string			StorageSize is the size of the storage class. Default value is 100Gi.

MeteringReport

MeteringReport holds objects names and metadata for available reports

Properties

Name	Type	Go type	Required	Default	Description	Example
LastModified	date-time (formatted string)	strfmt.DateTime
Name	string	string
Size	int64 (formatted integer)	int64

MlaOptions

Properties

Name	Type	Go type	Required	Default	Description	Example
LoggingEnabled	boolean	bool
LoggingEnforced	boolean	bool
MonitoringEnabled	boolean	bool
MonitoringEnforced	boolean	bool

MonitoringRateLimitSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
IngestionBurstSize	int32 (formatted integer)	int32			IngestionBurstSize represents ingestion burst size in samples per second (Cortex ingestion_burst_size).
IngestionRate	int32 (formatted integer)	int32			IngestionRate represents the ingestion rate limit in samples per second (Cortex ingestion_rate).
MaxSamplesPerQuery	int32 (formatted integer)	int32			MaxSamplesPerQuery represents maximum number of samples during a query (Cortex max_samples_per_query).
MaxSeriesPerMetric	int32 (formatted integer)	int32			MaxSeriesPerMetric represents maximum number of series per metric (Cortex max_series_per_metric).
MaxSeriesPerQuery	int32 (formatted integer)	int32			MaxSeriesPerQuery represents maximum number of timeseries during a query (Cortex max_series_per_query).
MaxSeriesTotal	int32 (formatted integer)	int32			MaxSeriesTotal represents maximum number of series per this user cluster (Cortex max_series_per_user).
QueryBurstSize	int32 (formatted integer)	int32			QueryBurstSize represents query burst size in number of requests (nginx burst).
QueryRate	int32 (formatted integer)	int32			QueryRate represents query request rate limit per second (nginx rate in r/s).

Names

Properties

Name	Type	Go type	Required	Default	Description	Example
Kind	string	string
ShortNames	[]string	[]string

Namespace

Namespace defines namespace

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string

NetworkRanges

Properties

Name	Type	Go type	Required	Default	Description	Example
CIDRBlocks	[]string	[]string

Node

Node represents a worker node that is part of a cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	NodeSpec	NodeSpec
status	NodeStatus	NodeStatus

NodeAddress

Properties

Name	Type	Go type	Required	Default	Description	Example
Address	string	string				192.168.1.1, node1.my.dns
Type	string	string				ExternalIP, InternalIP, InternalDNS, ExternalDNS

NodeCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
alibaba	AlibabaNodeSpec	AlibabaNodeSpec
anexia	AnexiaNodeSpec	AnexiaNodeSpec
aws	AWSNodeSpec	AWSNodeSpec
azure	AzureNodeSpec	AzureNodeSpec
digitalocean	DigitaloceanNodeSpec	DigitaloceanNodeSpec
gcp	GCPNodeSpec	GCPNodeSpec
hetzner	HetznerNodeSpec	HetznerNodeSpec
kubevirt	KubevirtNodeSpec	KubevirtNodeSpec
openstack	OpenstackNodeSpec	OpenstackNodeSpec
packet	PacketNodeSpec	PacketNodeSpec
vsphere	VSphereNodeSpec	VSphereNodeSpec

NodeDeployment

NodeDeployment represents a set of worker nodes that is part of a cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	NodeDeploymentSpec	NodeDeploymentSpec
status	MachineDeploymentStatus	MachineDeploymentStatus

NodeDeploymentRequest

NodeDeploymentRequest represents an asynchronous request to create a NodeDeployment in a user cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	NodeDeploymentRequestSpec	NodeDeploymentRequestSpec

NodeDeploymentRequestSpec

NodeDeploymentRequestSpec node deployment request specification

Properties

Name	Type	Go type	Required	Default	Description	Example
nd	NodeDeployment	NodeDeployment

NodeDeploymentSpec

NodeDeploymentSpec node deployment specification

Properties

Name	Type	Go type	Required	Default	Description	Example
DynamicConfig	boolean	bool
MaxReplicas	int32 (formatted integer)	int32
MinReplicas	int32 (formatted integer)	int32
Paused	boolean	bool
Replicas	int32 (formatted integer)	int32	✓
template	NodeSpec	NodeSpec	✓

NodeMetric

NodeMetric defines a metric for the given node

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUAvailableMillicores	int64 (formatted integer)	int64
CPUTotalMillicores	int64 (formatted integer)	int64			CPUTotalMillicores in m cores
CPUUsedPercentage	int64 (formatted integer)	int64			CPUUsedPercentage in percentage
MemoryAvailableBytes	int64 (formatted integer)	int64			MemoryAvailableBytes available memory for node
MemoryTotalBytes	int64 (formatted integer)	int64			MemoryTotalBytes current memory usage in bytes
MemoryUsedPercentage	int64 (formatted integer)	int64			MemoryUsedPercentage in percentage
Name	string	string

NodeResources

NodeResources cpu and memory of a node

Properties

Name	Type	Go type	Required	Default	Description	Example
CPU	string	string
Memory	string	string

NodeSettings

NodeSettings are node specific flags which can be configured on datacenter level

Properties

Name	Type	Go type	Required	Default	Description	Example
HyperkubeImage	string	string			Optional: The hyperkube image to use. Currently only Flatcar
makes use of this option.
InsecureRegistries	[]string	[]string			Optional: These image registries will be configured as insecure
on the container runtime.
PauseImage	string	string			Optional: Translates to --pod-infra-container-image on the kubelet.
If not set, the kubelet will default it.
RegistryMirrors	[]string	[]string			Optional: These image registries will be configured as registry mirrors
on the container runtime.
http_proxy	ProxyValue	ProxyValue
no_proxy	ProxyValue	ProxyValue

NodeSpec

NodeSpec node specification

Properties

Name	Type	Go type	Required	Default	Description	Example
Labels	map of string	map[string]string			Map of string keys and values that can be used to organize and categorize (scope and select) objects.
It will be applied to Nodes allowing users run their apps on specific Node using labelSelector.
SSHUserName	string	string
Taints	[]TaintSpec	[]*TaintSpec			List of taints to set on new nodes
cloud	NodeCloudSpec	NodeCloudSpec	✓
operatingSystem	OperatingSystemSpec	OperatingSystemSpec	✓
versions	NodeVersionInfo	NodeVersionInfo	✓

NodeStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
Addresses	[]NodeAddress	[]*NodeAddress			different addresses of a node
ErrorMessage	string	string			in case of a error this will contain a detailed error explanation
ErrorReason	string	string			in case of a error this will contain a short error message
MachineName	string	string			name of the actual Machine object
allocatable	NodeResources	NodeResources
capacity	NodeResources	NodeResources
nodeInfo	NodeSystemInfo	NodeSystemInfo

NodeSystemInfo

Properties

Name	Type	Go type	Required	Default	Description	Example
Architecture	string	string
ContainerRuntime	string	string
ContainerRuntimeVersion	string	string
KernelVersion	string	string
KubeletVersion	string	string
OperatingSystem	string	string

NodeVersionInfo

NodeVersionInfo node version information

Properties

Name	Type	Go type	Required	Default	Description	Example
Kubelet	string	string

NodesMetric

NodesMetric defines a metric for a group of nodes

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUAvailableMillicores	int64 (formatted integer)	int64
CPUTotalMillicores	int64 (formatted integer)	int64			CPUTotalMillicores in m cores
CPUUsedPercentage	int64 (formatted integer)	int64			CPUUsedPercentage in percentage
MemoryAvailableBytes	int64 (formatted integer)	int64			MemoryAvailableBytes available memory for node
MemoryTotalBytes	int64 (formatted integer)	int64			MemoryTotalBytes current memory usage in bytes
MemoryUsedPercentage	int64 (formatted integer)	int64			MemoryUsedPercentage in percentage

OIDCSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
ClientID	string	string
ClientSecret	string	string
ExtraScopes	string	string
GroupsClaim	string	string
IssuerURL	string	string
RequiredClaim	string	string
UsernameClaim	string	string

OIDCSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
ClientID	string	string
ClientSecret	string	string
IssuerURL	string	string

OPAIntegrationSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool			Enabled is the flag for enabling OPA integration
ExperimentalEnableMutation	boolean	bool			Enable mutation
WebhookTimeoutSeconds	int32 (formatted integer)	int32			WebhookTimeout is the timeout that is set for the gatekeeper validating webhook admission review calls.
By default 10 seconds.

ObjectMeta

ObjectMeta defines the set of fields that objects returned from the API have

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource

ObjectReference

New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.

1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.
2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded.
3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant.
5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +structType=atomic

Properties

Name	Type	Go type	Required	Default	Description	Example
APIVersion	string	string			API version of the referent.
+optional
FieldPath	string	string			If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers{name}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object.
TODO: this design is not final and this field is subject to change in the future.
+optional
Kind	string	string			Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+optional
Name	string	string			Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+optional
Namespace	string	string			Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+optional
ResourceVersion	string	string			Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional
uid	UID	UID

ObjectReferenceResource

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+optional
Namespace	string	string			Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+optional
Type	string	string			Type of the referent.

OpaOptions

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool
Enforced	boolean	bool

OpenstackAvailabilityZone

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name is the name of the availability zone

OpenstackCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
ApplicationCredentialID	string	string
ApplicationCredentialSecret	string	string
Domain	string	string
FloatingIPPool	string	string			FloatingIPPool holds the name of the public network
The public network is reachable from the outside world
and should provide the pool of IP addresses to choose from.

When specified, all worker nodes will receive a public ip from this floating ip pool

Note that the network is external if the "External" field is set to true | | | Network | string| string | | | Network holds the name of the internal network When specified, all worker nodes will be attached to this network. If not specified, a network, subnet & router will be created

Note that the network is internal if the "External" field is set to false | | | Password | string| string | | | | | | RouterID | string| string | | | | | | SecurityGroups | string| string | | | | | | ServerGroupID | string| string | | | ServerGroupID used as schedule hint shared between all machines in the cluster, When not specified, soft-anti-affinity server group will be automatically created | | | SubnetCIDR | string| string | | | | | | SubnetID | string| string | | | | | | Tenant | string| string | | | | | | TenantID | string| string | | | | | | Token | string| string | | | Used internally during cluster creation | | | UseOctavia | boolean| bool | | | Whether or not to use Octavia for LoadBalancer type of Service implementation instead of using Neutron-LBaaS. Attention:Openstack CCM use Octavia as default load balancer implementation since v1.17.0

Takes precedence over the 'use_octavia' flag provided at datacenter level if both are specified. +optional | | | UseToken | boolean| bool | | | | | | Username | string| string | | | | | | credentialsReference | GlobalSecretKeySelector| GlobalSecretKeySelector | | | | |

OpenstackNetwork

Properties

Name	Type	Go type	Required	Default	Description	Example
External	boolean	bool			External set if network is the external network
ID	string	string			Id uniquely identifies the current network
Name	string	string			Name is the name of the network

OpenstackNodeSizeRequirements

Properties

Name	Type	Go type	Required	Default	Description	Example
MinimumMemory	int64 (formatted integer)	int64			MinimumMemory is the minimum required amount of memory, measured in MB
MinimumVCPUs	int64 (formatted integer)	int64			VCPUs is the minimum required amount of (virtual) CPUs

OpenstackNodeSpec

OpenstackNodeSpec openstack node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
AvailabilityZone	string	string			if not set, the default AZ from the Datacenter spec will be used
Flavor	string	string	✓		instance flavor
Image	string	string	✓		image to use
InstanceReadyCheckPeriod	string	string			Period of time to check for instance ready status, i.e. 10s/1m
InstanceReadyCheckTimeout	string	string			Max time to wait for the instance to be ready, i.e. 10s/1m
RootDiskSizeGB	int64 (formatted integer)	int64			if set, the rootDisk will be a volume. If not, the rootDisk will be on ephemeral storage and its size will be derived from the flavor
Tags	map of string	map[string]string			Additional metadata to set
UseFloatingIP	boolean	bool			Defines whether floating ip should be used

OpenstackSecurityGroup

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string			Id uniquely identifies the current security group
Name	string	string			Name is the name of the security group

OpenstackSize

Properties

Name	Type	Go type	Required	Default	Description	Example
Disk	int64 (formatted integer)	int64			Disk is the amount of root disk, measured in GB
IsPublic	boolean	bool			IsPublic indicates whether the size is public (available to all projects) or scoped to a set of projects
Memory	int64 (formatted integer)	int64			MemoryTotalBytes is the amount of memory, measured in MB
Region	string	string			Region specifies the geographic region in which the size resides
Slug	string	string			Slug holds the name of the size
Swap	int64 (formatted integer)	int64			Swap is the amount of swap space, measured in MB
VCPUs	int64 (formatted integer)	int64			VCPUs indicates how many (virtual) CPUs are available for this flavor

OpenstackSubnet

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string			Id uniquely identifies the subnet
Name	string	string			Name is human-readable name for the subnet

OpenstackTenant

Properties

Name	Type	Go type	Required	Default	Description	Example
ID	string	string			Id uniquely identifies the current tenant
Name	string	string			Name is the name of the tenant

OperatingSystemSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
centos	CentOSSpec	CentOSSpec
flatcar	FlatcarSpec	FlatcarSpec
rhel	RHELSpec	RHELSpec
sles	SLESSpec	SLESSpec
ubuntu	UbuntuSpec	UbuntuSpec

PacketCPU

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	int64
Type	string	string

PacketCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
APIKey	string	string
BillingCycle	string	string
ProjectID	string	string
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector

PacketDrive

Properties

Name	Type	Go type	Required	Default	Description	Example
Count	int64 (formatted integer)	int64
Size	string	string
Type	string	string

PacketNodeSpec

PacketNodeSpec specifies packet specific node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
InstanceType	string	string	✓		InstanceType denotes the plan to which the device will be provisioned.
Tags	[]string	[]string			additional instance tags

PacketSize

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUs	[]PacketCPU	[]*PacketCPU
Drives	[]PacketDrive	[]*PacketDrive
Memory	string	string
Name	string	string

PacketSizeList

[]PacketSize

Parameters

Parameters

PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Properties

Name	Type	Go type	Required	Default	Description	Example
Nameservers	[]string	[]string			A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
+optional
Options	[]PodDNSConfigOption	[]*PodDNSConfigOption			A list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Duplicated entries will be removed. Resolution options given in Options
will override those that appear in the base DNSPolicy.
+optional
Searches	[]string	[]string			A list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.
Duplicated search paths will be removed.
+optional

PodDNSConfigOption

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Required.
Value	string	string			+optional

PolicyRule

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Properties

Name	Type	Go type	Required	Default	Description	Example
APIGroups	[]string	[]string			APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of
the enumerated resources in any API group will be allowed.
+optional
NonResourceURLs	[]string	[]string			NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path
Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.
Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
+optional
ResourceNames	[]string	[]string			ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
+optional
Resources	[]string	[]string			Resources is a list of resources this rule applies to. '*' represents all resources.
+optional
Verbs	[]string	[]string			Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs.

Preset

Preset represents a preset

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool
Name	string	string
Providers	[]PresetProvider	[]*PresetProvider

PresetList

PresetList represents a list of presets

Properties

Name	Type	Go type	Required	Default	Description	Example
Items	[]Preset	[]*Preset

PresetProvider

PresetProvider represents a preset provider

Properties

Name	Type	Go type	Required	Default	Description	Example
Enabled	boolean	bool
name	ProviderType	ProviderType

Project

Project is a top-level container for a set of resources

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
ClustersNumber	int64 (formatted integer)	int64
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Labels	map of string	map[string]string
Name	string	string			Name represents human readable name for the resource
Owners	[]User	[]*User			Owners an optional owners list for the given project
Status	string	string

ProjectGroup

ProjectGroup is a helper data structure that stores the information about a project and a group prefix that a user belongs to

Properties

Name	Type	Go type	Required	Default	Description	Example
GroupPrefix	string	string
ID	string	string

ProviderType

Name	Type	Go type	Default	Description	Example
ProviderType	string	string

ProxySettings

ProxySettings allow configuring a HTTP proxy for the controlplanes and nodes

Properties

Name	Type	Go type	Required	Default	Description	Example
http_proxy	ProxyValue	ProxyValue
no_proxy	ProxyValue	ProxyValue

ProxyValue

Name	Type	Go type	Default	Description	Example
ProxyValue	string	string

PublicAWSCloudSpec

interface{}

PublicAlibabaCloudSpec

interface{}

PublicAnexiaCloudSpec

interface{}

PublicAzureCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
AssignAvailabilitySet	boolean	bool

PublicBringYourOwnCloudSpec

interface{}

PublicCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
DatacenterName	string	string
alibaba	PublicAlibabaCloudSpec	PublicAlibabaCloudSpec
anexia	PublicAnexiaCloudSpec	PublicAnexiaCloudSpec
aws	PublicAWSCloudSpec	PublicAWSCloudSpec
azure	PublicAzureCloudSpec	PublicAzureCloudSpec
bringyourown	PublicBringYourOwnCloudSpec	PublicBringYourOwnCloudSpec
digitalocean	PublicDigitaloceanCloudSpec	PublicDigitaloceanCloudSpec
fake	PublicFakeCloudSpec	PublicFakeCloudSpec
gcp	PublicGCPCloudSpec	PublicGCPCloudSpec
hetzner	PublicHetznerCloudSpec	PublicHetznerCloudSpec
kubevirt	PublicKubevirtCloudSpec	PublicKubevirtCloudSpec
openstack	PublicOpenstackCloudSpec	PublicOpenstackCloudSpec
packet	PublicPacketCloudSpec	PublicPacketCloudSpec
vsphere	PublicVSphereCloudSpec	PublicVSphereCloudSpec

PublicDigitaloceanCloudSpec

interface{}

PublicFakeCloudSpec

interface{}

PublicGCPCloudSpec

interface{}

PublicHetznerCloudSpec

interface{}

PublicKubevirtCloudSpec

interface{}

PublicOpenstackCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Domain	string	string
FloatingIPPool	string	string
Network	string	string
RouterID	string	string
SecurityGroups	string	string
SubnetCIDR	string	string
SubnetID	string	string
Tenant	string	string
TenantID	string	string

PublicPacketCloudSpec

interface{}

PublicServiceAccountToken

PublicServiceAccountToken represent an API service account token without secret fields

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
Expiry	date-time (formatted string)	strfmt.DateTime			Expiry is a timestamp representing the time when this token will expire.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource

PublicVSphereCloudSpec

interface{}

Quantity

The serialization format is:

::= (Note that may be empty, from the "" case in .) ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) ::= "e" | "E"

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+protobuf=true +protobuf.embed=string +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:deepcopy-gen=true +k8s:openapi-gen=true

interface{}

Quotas

Properties

Name	Type	Go type	Required	Default	Description	Example
FloatingIPQuota	int64 (formatted integer)	int64			FloatingIpQuota Sys11 addition with the amount of used and attached floating ips
UsedFloatingIPCount	int64 (formatted integer)	int64			UsedFloatingIpCount is the floating IP quota
limits	Limits	Limits

RHELSpec

RHELSpec contains rhel specific settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DistUpgradeOnBoot	boolean	bool			do a dist-upgrade on boot and reboot it required afterwards
RHELSubscriptionManagerPassword	string	string
RHELSubscriptionManagerUser	string	string
RHSMOfflineToken	string	string

ReadinessSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
StatsEnabled	boolean	bool			enables stats for gatekeeper audit

ReportURL

ReportURL represent an S3 pre signed URL to download a report

Name	Type	Go type	Default	Description	Example
ReportURL	string	string		ReportURL represent an S3 pre signed URL to download a report

ResourceLabelMap

ResourceLabelMap

ResourceList

ResourceList

ResourceRequirements

Properties

Name	Type	Go type	Required	Default	Description	Example
limits	ResourceList	ResourceList
requests	ResourceList	ResourceList

ResourceType

Name	Type	Go type	Default	Description	Example
ResourceType	string	string

Role

Role defines RBAC role for the user cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
Namespace	string	string			Indicates the scope of this role.
Rules	[]PolicyRule	[]*PolicyRule			Rules holds all the PolicyRules for this Role

RoleBinding

Properties

Name	Type	Go type	Required	Default	Description	Example
Namespace	string	string			Indicates the scope of this binding.
RoleRefName	string	string
Subjects	[]Subject	[]*Subject			Subjects holds references to the objects the role applies to.

RoleName

RoleName defines RBAC role name object for the user cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the role.
Namespace	[]string	[]string			Indicates the scopes of this role.

RoleUser

RoleUser defines associated user with role

Properties

Name	Type	Go type	Required	Default	Description	Example
Group	string	string
UserEmail	string	string

RuleGroup

Properties

Name	Type	Go type	Required	Default	Description	Example
Data	[]uint8 (formatted integer)	[]uint8			contains the RuleGroup data. Ref: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group
type	RuleGroupType	RuleGroupType

RuleGroupType

Name	Type	Go type	Default	Description	Example
RuleGroupType	string	string

S3BackupCredentials

S3BackupCredentials contains credentials for S3 etcd backups

Properties

Name	Type	Go type	Required	Default	Description	Example
AccessKeyID	string	string
SecretAccessKey	string	string

SLESSpec

SLESSpec contains SLES specific settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DistUpgradeOnBoot	boolean	bool			do a dist-upgrade on boot and reboot it required afterwards

SSHKey

SSHKey represents a ssh key

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
spec	SSHKeySpec	SSHKeySpec

SSHKeySpec

SSHKeySpec represents the details of a ssh key

Properties

Name	Type	Go type	Required	Default	Description	Example
Fingerprint	string	string
PublicKey	string	string

Seed

Seed represents a seed object

Properties

Name	Type	Go type	Required	Default	Description	Example
Country	string	string			Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK.
For informational purposes in the Kubermatic dashboard only.
Location	string	string			Optional: Detailed location of the cluster, like "Hamburg" or "Datacenter 7".
For informational purposes in the Kubermatic dashboard only.
Name	string	string			Name represents human readable name for the resource
SeedDNSOverwrite	string	string			Optional: This can be used to override the DNS name used for this seed.
By default the seed name is used.
SeedDatacenters	map of Datacenter	map[string]Datacenter			Datacenters contains a map of the possible datacenters (DCs) in this seed.
Each DC must have a globally unique identifier (i.e. names must be unique
across all seeds).
backupRestore	SeedBackupRestoreConfiguration	SeedBackupRestoreConfiguration
expose_strategy	ExposeStrategy	ExposeStrategy
kubeconfig	ObjectReference	ObjectReference
mla	SeedMLASettings	SeedMLASettings
proxy_settings	ProxySettings	ProxySettings

SeedBackupRestoreConfiguration

Properties

Name	Type	Go type	Required	Default	Description	Example
S3BucketName	string	string			S3BucketName is the S3 bucket name to use for backup and restore.
S3Endpoint	string	string			S3Endpoint is the S3 API endpoint to use for backup and restore. Defaults to s3.amazonaws.com.

SeedMLASettings

Properties

Name	Type	Go type	Required	Default	Description	Example
UserClusterMLAEnabled	boolean	bool			Optional: UserClusterMLAEnabled controls whether the user cluster MLA (Monitoring, Logging & Alerting) stack is enabled in the seed.

SeedNamesList

[]string

SeedSettings

SeedSettings represents settings for a Seed cluster

Properties

Name	Type	Go type	Required	Default	Description	Example
SeedDNSOverwrite	string	string			the Seed level seed dns overwrite
metering	MeteringConfigurations	MeteringConfigurations
mla	MLA	MLA

SeedSpec

The spec for a seed data

Properties

Name	Type	Go type	Required	Default	Description	Example
Country	string	string			Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK.
For informational purposes in the Kubermatic dashboard only.
Location	string	string			Optional: Detailed location of the cluster, like "Hamburg" or "Datacenter 7".
For informational purposes in the Kubermatic dashboard only.
SeedDNSOverwrite	string	string			Optional: This can be used to override the DNS name used for this seed.
By default the seed name is used.
SeedDatacenters	map of Datacenter	map[string]Datacenter			Datacenters contains a map of the possible datacenters (DCs) in this seed.
Each DC must have a globally unique identifier (i.e. names must be unique
across all seeds).
backupRestore	SeedBackupRestoreConfiguration	SeedBackupRestoreConfiguration
expose_strategy	ExposeStrategy	ExposeStrategy
kubeconfig	ObjectReference	ObjectReference
mla	SeedMLASettings	SeedMLASettings
proxy_settings	ProxySettings	ProxySettings

Semver

Semver is struct that encapsulates semver.Semver struct so we can use it in API +k8s:deepcopy-gen=true

interface{}

ServiceAccount

ServiceAccount represent an API service account

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
Group	string	string			Group that a service account belongs to
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
Status	string	string			Status describes three stages of ServiceAccount life including Active, Inactive and Terminating

ServiceAccountSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
APIAudiences	[]string	[]string			APIAudiences are the Identifiers of the API
If this is not specified, it will be set to a single element list containing the issuer URL
Issuer	string	string			Issuer is the identifier of the service account token issuer
If this is not specified, it will be set to the URL of apiserver by default
TokenVolumeProjectionEnabled	boolean	bool

ServiceAccountToken

ServiceAccountToken represent an API service account token

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
Expiry	date-time (formatted string)	strfmt.DateTime			Expiry is a timestamp representing the time when this token will expire.
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
Name	string	string			Name represents human readable name for the resource
Token	string	string			Token the JWT token

SettingSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
DefaultNodeCount	int8 (formatted integer)	int8
DisplayAPIDocs	boolean	bool
DisplayDemoInfo	boolean	bool
DisplayTermsOfService	boolean	bool
EnableDashboard	boolean	bool
EnableExternalClusterImport	boolean	bool
EnableOIDCKubeconfig	boolean	bool
MlaAlertmanagerPrefix	string	string
MlaGrafanaPrefix	string	string
RestrictProjectCreation	boolean	bool
UserProjectsLimit	int64 (formatted integer)	int64
cleanupOptions	CleanupOptions	CleanupOptions
clusterTypeOptions	ClusterType	ClusterType
customLinks	CustomLinks	CustomLinks
machineDeploymentVMResourceQuota	MachineDeploymentVMResourceQuota	MachineDeploymentVMResourceQuota
mlaOptions	MlaOptions	MlaOptions
opaOptions	OpaOptions	OpaOptions

Subject

or a value for non-objects such as user and group names. +structType=atomic

Properties

Name	Type	Go type	Required	Default	Description	Example
APIGroup	string	string			APIGroup holds the API group of the referenced subject.
Defaults to "" for ServiceAccount subjects.
Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
+optional
Kind	string	string			Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount".
If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name	string	string			Name of the object being referenced.
Namespace	string	string			Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty
the Authorizer should report an error.
+optional

Sync

Properties

Name	Type	Go type	Required	Default	Description	Example
SyncOnly	[]GVK	[]*GVK			If non-empty, entries on this list will be replicated into OPA

Sys11AuthSettings

Properties

Name	Type	Go type	Required	Default	Description	Example
Realm	string	string

TaintSpec

TaintSpec defines a node taint

Properties

Name	Type	Go type	Required	Default	Description	Example
Effect	string	string
Key	string	string
Value	string	string

Target

Properties

Name	Type	Go type	Required	Default	Description	Example
Libs	[]string	[]string
Rego	string	string
Target	string	string

Time

Programs using times should typically store and pass them as values, not pointers. That is, time variables and struct fields should be of type time.Time, not *time.Time.

A Time value can be used by multiple goroutines simultaneously except that the methods GobDecode, UnmarshalBinary, UnmarshalJSON and UnmarshalText are not concurrency-safe.

Time instants can be compared using the Before, After, and Equal methods. The Sub method subtracts two instants, producing a Duration. The Add method adds a Time and a Duration, producing a Time.

The zero value of type Time is January 1, year 1, 00:00:00.000000000 UTC. As this time is unlikely to come up in practice, the IsZero method gives a simple way of detecting a time that has not been initialized explicitly.

Each Time has associated with it a Location, consulted when computing the presentation form of the time, such as in the Format, Hour, and Year methods. The methods Local, UTC, and In return a Time with a specific location. Changing the location in this way changes only the presentation; it does not change the instant in time being denoted and therefore does not affect the computations described in earlier paragraphs.

Representations of a Time value saved by the GobEncode, MarshalBinary, MarshalJSON, and MarshalText methods store the Time.Location's offset, but not the location name. They therefore lose information about Daylight Saving Time.

In addition to the required “wall clock” reading, a Time may contain an optional reading of the current process's monotonic clock, to provide additional precision for comparison or subtraction. See the “Monotonic Clocks” section in the package documentation for details.

Note that the Go == operator compares not just the time instant but also the Location and the monotonic clock reading. Therefore, Time values should not be used as map or database keys without first guaranteeing that the identical Location has been set for all values, which can be achieved through use of the UTC or Local method, and that the monotonic clock reading has been stripped by setting t = t.Round(0). In general, prefer t.Equal(u) to t == u, since t.Equal uses the most accurate comparison available and correctly handles the case when only one of its arguments has a monotonic clock reading.

Name	Type	Go type	Default	Description	Example
Time	date-time (formatted string)	strfmt.DateTime		Programs using times should typically store and pass them as values,
not pointers. That is, time variables and struct fields should be of
type time.Time, not *time.Time.

A Time value can be used by multiple goroutines simultaneously except that the methods GobDecode, UnmarshalBinary, UnmarshalJSON and UnmarshalText are not concurrency-safe.

Time instants can be compared using the Before, After, and Equal methods. The Sub method subtracts two instants, producing a Duration. The Add method adds a Time and a Duration, producing a Time.

The zero value of type Time is January 1, year 1, 00:00:00.000000000 UTC. As this time is unlikely to come up in practice, the IsZero method gives a simple way of detecting a time that has not been initialized explicitly.

Each Time has associated with it a Location, consulted when computing the presentation form of the time, such as in the Format, Hour, and Year methods. The methods Local, UTC, and In return a Time with a specific location. Changing the location in this way changes only the presentation; it does not change the instant in time being denoted and therefore does not affect the computations described in earlier paragraphs.

Representations of a Time value saved by the GobEncode, MarshalBinary, MarshalJSON, and MarshalText methods store the Time.Location's offset, but not the location name. They therefore lose information about Daylight Saving Time.

In addition to the required “wall clock” reading, a Time may contain an optional reading of the current process's monotonic clock, to provide additional precision for comparison or subtraction. See the “Monotonic Clocks” section in the package documentation for details.

Note that the Go == operator compares not just the time instant but also the Location and the monotonic clock reading. Therefore, Time values should not be used as map or database keys without first guaranteeing that the identical Location has been set for all values, which can be achieved through use of the UTC or Local method, and that the monotonic clock reading has been stripped by setting t = t.Round(0). In general, prefer t.Equal(u) to t == u, since t.Equal uses the most accurate comparison available and correctly handles the case when only one of its arguments has a monotonic clock reading. | |

Trace

Properties

Name	Type	Go type	Required	Default	Description	Example
Dump	string	string			Also dump the state of OPA with the trace. Set to All to dump everything.
User	string	string			Only trace requests from the specified user
kind	GVK	GVK

UID

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Name	Type	Go type	Default	Description	Example
UID	string	string		UID is a type that holds unique ID values, including UUIDs. Because we
don't ONLY use UUIDs, this is an alias to string. Being a type captures
intent and helps make sure that UIDs and names do not get conflated.

UbuntuSpec

UbuntuSpec ubuntu specific settings

Properties

Name	Type	Go type	Required	Default	Description	Example
DistUpgradeOnBoot	boolean	bool			do a dist-upgrade on boot and reboot it required afterwards

UpdateWindow

Properties

Name	Type	Go type	Required	Default	Description	Example
Length	string	string
Start	string	string

User

User represent an API user

Properties

Name	Type	Go type	Required	Default	Description	Example
Annotations	map of string	map[string]string			Annotations that can be added to the resource
CreationTimestamp	date-time (formatted string)	strfmt.DateTime			CreationTimestamp is a timestamp representing the server time when this object was created.
DeletionTimestamp	date-time (formatted string)	strfmt.DateTime			DeletionTimestamp is a timestamp representing the server time when this object was deleted.
Email	string	string			Email an email address of the user
ID	string	string			ID unique value that identifies the resource generated by the server. Read-Only.
IsAdmin	boolean	bool			IsAdmin indicates admin role
Name	string	string			Name represents human readable name for the resource
Projects	[]ProjectGroup	[]*ProjectGroup			Projects holds the list of project the user belongs to
along with the group names
userSettings	UserSettings	UserSettings

UserSettings

UserSettings represent an user settings

Properties

Name	Type	Go type	Required	Default	Description	Example
CollapseSidenav	boolean	bool
DisplayAllProjectsForAdmin	boolean	bool
ItemsPerPage	int8 (formatted integer)	int8
LastSeenChangelogVersion	string	string
SelectProjectTableView	boolean	bool
SelectedProjectID	string	string
SelectedTheme	string	string

VSphereCloudSpec

Properties

Name	Type	Go type	Required	Default	Description	Example
Datastore	string	string			Datastore to be used for storing virtual machines and as a default for
dynamic volume provisioning, it is mutually exclusive with
DatastoreCluster.
+optional
DatastoreCluster	string	string			DatastoreCluster to be used for storing virtual machines, it is mutually
exclusive with Datastore.
+optional
Folder	string	string			Folder is the folder to be used to group the provisioned virtual
machines.
+optional
Password	string	string			Password is the vSphere user password.
+optional
ResourcePool	string	string			ResourcePool is used to manage resources such as cpu and memory for vSphere virtual machines. The resource pool
should be defined on vSphere cluster level.
+optional
StoragePolicy	string	string			StoragePolicy to be used for storage provisioning
Username	string	string			Username is the vSphere user name.
+optional
VMNetName	string	string			VMNetName is the name of the vSphere network.
credentialsReference	GlobalSecretKeySelector	GlobalSecretKeySelector
infraManagementUser	VSphereCredentials	VSphereCredentials

VSphereCredentials

VSphereCredentials credentials represents a credential for accessing vSphere

Properties

Name	Type	Go type	Required	Default	Description	Example
Password	string	string
Username	string	string

VSphereDatastoreList

Properties

Name	Type	Go type	Required	Default	Description	Example
Datastores	[]string	[]string

VSphereFolder

Properties

Name	Type	Go type	Required	Default	Description	Example
Path	string	string			Path is the path of the folder

VSphereNetwork

Properties

Name	Type	Go type	Required	Default	Description	Example
AbsolutePath	string	string			AbsolutePath is the absolute path inside vCenter
Name	string	string			Name is the name of the network
RelativePath	string	string			RelativePath is the relative path inside the datacenter
Type	string	string			Type defines the type of network

VSphereNodeSpec

VSphereNodeSpec VSphere node settings

Properties

Name	Type	Go type	Required	Default	Description	Example
CPUs	int64 (formatted integer)	int64
DiskSizeGB	int64 (formatted integer)	int64
Memory	int64 (formatted integer)	int64
Template	string	string

Validation

Properties

Name	Type	Go type	Required	Default	Description	Example
LegacySchema	boolean	bool			+kubebuilder:default=true
openAPIV3Schema	JSONSchemaProps	JSONSchemaProps

Version

interface{}

VersionList

VersionList represents a list of versions

[]MasterVersion

Violation

Violation represents a gatekeeper constraint violation

Properties

Name	Type	Go type	Required	Default	Description	Example
EnforcementAction	string	string
Kind	string	string
Message	string	string
Name	string	string
Namespace	string	string

bcBody

Properties

Name	Type	Go type	Required	Default	Description	Example
backup_credentials	BackupCredentials	BackupCredentials

body

Properties

Name	Type	Go type	Required	Default	Description	Example
Kubeconfig	string	string			Kubeconfig Base64 encoded kubeconfig
Name	string	string			Name is human readable name for the external cluster

constraintBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name is the name for the constraint
Spec	ConstraintSpec	ConstraintSpec

ctBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the constraint template
spec	ConstraintTemplateSpec	ConstraintTemplateSpec

ebcBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the etcd backup config
spec	EtcdBackupConfigSpec	EtcdBackupConfigSpec

erBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the etcd backup restore. If not set, it will be generated
spec	EtcdRestoreSpec	EtcdRestoreSpec

unsealKeys

Properties

Name	Type	Go type	Required	Default	Description	Example
Keys	[]string	[]string

wrBody

Properties

Name	Type	Go type	Required	Default	Description	Example
Name	string	string			Name of the allowed registry
spec	AllowedRegistrySpec	AllowedRegistrySpec