Skip to content
Docs

List Quotas

$ nirvana quotas list
GET/v1/quotas

List quota usage and limits for the current organization across all regions

ReturnsExpand Collapse
quota_list: object { items, pagination }
items: array of Quota { compute, networking, nks, 2 more }
compute: object { memory_gb, vcpu }

Compute quota.

memory_gb: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
vcpu: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
networking: object { connect_connections, public_ips, vpcs }

Networking quota.

connect_connections: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
public_ips: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
vpcs: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
nks: object { clusters, node_pool_memory_gb, node_pool_vcpu, public_ips }

NKS quota.

clusters: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
node_pool_memory_gb: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
node_pool_vcpu: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
public_ips: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
region: "us-sva-2"

Region the resource is in.

"us-sva-2"
storage: object { abs, local_nvme }

Storage quota.

abs: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number
local_nvme: object { limit, remaining, used }

Quota dimension detail.

limit: number
remaining: number
used: number

List Quotas

nirvana quotas list \
  --api-key 'My API Key'
{
  "items": [
    {
      "compute": {
        "memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "networking": {
        "connect_connections": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vpcs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "nks": {
        "clusters": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "region": "us-sva-2",
      "storage": {
        "abs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "local_nvme": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
Returns Examples
{
  "items": [
    {
      "compute": {
        "memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "networking": {
        "connect_connections": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vpcs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "nks": {
        "clusters": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "region": "us-sva-2",
      "storage": {
        "abs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "local_nvme": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}