Skip to content
DocsOpenAPI spec

    List Quotas

    $ nirvana quotas list
    GET/v1/quotas

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

    ParametersExpand Collapse
    --cursor: optional string

    Pagination cursor returned by a previous request. Only valid for the same filters and sort order.

    --limit: optional number

    Maximum number of items to return

    --region: optional string

    Filter by region

    --sort: optional string

    Comma-separated sort terms in precedence order, each field:asc or field:desc. Fields: region

    ReturnsExpand Collapse
    quota_list: object { items, pagination }
    items: array of Quota { compute, networking, nks, 3 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 { public_ips, vpcs }

    Networking quota.

    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" or "us-wdc-1"

    Region the resource is in.

    "us-sva-2"
    "us-wdc-1"
    sandboxes: object { clusters, memory_gb, vcpu }

    Sandbox quota. vcpu and memory_gb count the nodes of the organization’s sandbox clusters in the region.

    clusters: object { limit, remaining, used }

    Quota dimension detail.

    limit: number
    remaining: number
    used: number
    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
    storage: object { abs, local_nvme, longhorn, object_storage }

    Storage quota. object_storage is the data stored in the organization’s buckets in the region, in GB (10^9 bytes), rounded up per project. It is measured periodically, so it can trail recent writes by several minutes and can exceed the limit. New buckets cannot be created once used reaches the limit; a limit of 0 means object storage is not available to the organization in the region.

    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
    longhorn: object { limit, remaining, used }

    Quota dimension detail.

    limit: number
    remaining: number
    used: number
    object_storage: 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": {
            "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",
          "sandboxes": {
            "clusters": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "memory_gb": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "vcpu": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            }
          },
          "storage": {
            "abs": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "local_nvme": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "longhorn": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "object_storage": {
              "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": {
            "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",
          "sandboxes": {
            "clusters": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "memory_gb": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "vcpu": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            }
          },
          "storage": {
            "abs": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "local_nvme": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "longhorn": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            },
            "object_storage": {
              "limit": 32,
              "remaining": 24,
              "used": 8
            }
          }
        }
      ],
      "pagination": {
        "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
        "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
        "total_count": 125
      }
    }