Clusters

Fetch cluster name availability

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

get/core/clusters/name-availability/{name}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/clusters/name-availability/{name}
  • Auth: API key in header api_key

Path parameters

namestring required

Cluster name to check for availability.

Response

Success

namestring

Resource name to check for availability.

availableboolean

Whether stock is currently available.

messagestring

Human-readable description of the result.

Example response

{
  "name": "example-availability-check",
  "message": "Name must not exceed 20 characters"
}

Changes

No recorded changes to this operation across all 1 revision of this API.