Environment

Get environment VM quota

Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit.

get/core/environments/{id}/vm-quota

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/environments/{id}/vm-quota
  • Auth: API key in header api_key

Path parameters

idinteger required

ID of the environment.

Response

VM quota information retrieved successfully.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

current_vmsinteger

Number of virtual machines currently provisioned.

max_vmsinteger

Maximum number of virtual machines allowed by the quota.

available_vmsinteger

Number of additional virtual machines that can still be created.

percentage_usednumber

Percentage of the virtual machine quota currently used.

cidrstring

CIDR block allocated for the virtual machines.

Example response

{
  "current_vms": 1,
  "max_vms": 250,
  "available_vms": 249,
  "percentage_used": 0.4,
  "cidr": "10.0.11.0/24"
}

Changes

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