Virtual Machine

Fetch virtual machine name availability

Check if a Virtual Machine name is available.

get/core/virtual-machines/name-availability/{name}

Request

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

Path parameters

namestring required

Virtual machine name to check for availability.

Query parameters

countinteger

Number of instances to check availability for.

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.