Interface IClusterApi

Defines the headend cluster management REST APIs.

Namespace: Neon.Kube.Models.Headend

Assembly: Neon.Kube.Models.dll

Syntax

[Target("all")]
[Target("headend")]
[ServiceModel("Headend", "Cluster")]
[Route("cluster")]
[ApiVersion("2023-04-06")]
public interface IClusterApi

Methods

CreateSsoClientAsync(string, string)

Creates an SSO client for a cluster.

Declaration

[HttpPost(null)]
[Route("{clusterId}/sso-client")]
Dictionary<string, string> CreateSsoClientAsync(string clusterId, string clusterName)

Parameters

Type	Name	Description
string	clusterId	The cluster ID.
string	clusterName

Returns

Type	Description
Dictionary<string, string>	A dictionary holding the ClientId, Secret, and RedirectURI.

GetCertificateAsync(string)

Returns a cluster's certificate information.

Declaration

[HttpGet(null)]
[Route("{clusterId}/certificate")]
IDictionary<string, byte[]> GetCertificateAsync(string clusterId)

Parameters

Type	Name	Description
string	clusterId	Specifies the cluster ID.

Returns

Type	Description
IDictionary<string, byte[]>	A dictionary with the certificate tls.crt and private tls.key.

GetTokenAsync(string)

Renews a cluster JWT.

Declaration

[HttpGet(null)]
[Route("{clusterId}/token/renew")]
string GetTokenAsync(string clusterId)

Parameters

Type	Name	Description
string	clusterId

Returns

Type	Description
string	The updated JWT.

UpdateClusterDomainAsync(string, string)

Updates a cluster's DNS records to reference a new IP address.

Declaration

[HttpPut(null)]
[Route("{clusterId}/domain")]
string UpdateClusterDomainAsync(string clusterId, string addresses)

Parameters

Type	Name	Description
string	clusterId	The cluster ID.
string	addresses	The new IP addresses.

Returns

Type	Description
string	The action result.