Skip to main content

Verify Kubernetes Cluster Name Availability

GET https://infrahub-api.nexgencloud.com/v1/core/clusters/name-availability/{cluster_name}​

Specify the cluster name in the path to verify its availability for deployment using the Create Cluster API.


Path Parameters​

cluster_name string   Required​

The name to verify for availability before using it to deploy a cluster.

Cluster names must consist only of lowercase alphanumeric characters and hyphens. Uppercase letters, special characters, and spaces are not allowed. Maximum length of 50 characters.


Attributes​

name string​

The name specified for availability verification.

available boolean​

true indicates the name is available, while false means it is already in use and unavailable.

message string​

A message describing the status of the request to verify cluster name availability.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/clusters/name-availability/{cluster_name}" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
  • To authenticate Infrahub API requests, add an api_key header to your API request that contains an API Key.
Response
{
  "name": "example-cluster",
  "available": true,
  "message": "This name is available"
}

Returns​

Returns the availability status of the specified name for deploying a Kubernetes cluster as either true (available) or false (unavailable). If an error occurs, refer to the error documentation.


Back to top​