Skip to content
Nirvana LabsNirvana Labs API
Docs
    API Reference
    Quotas

    Get Region Quota

    client.Quotas.Get(ctx, region) (*Quota, error)
    GET/v1/quotas/{region}

    Get quota usage and limits for the current organization in a single region

    ParametersExpand Collapse
    ReturnsExpand Collapse
    type Quota struct{…}

    Quota response.

    Compute QuotaCompute

    Compute quota.

    MemoryGB QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    Vcpu QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    Networking QuotaNetworking

    Networking quota.

    ConnectConnections QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    PublicIPs QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    VPCs QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    NKS QuotaNKS

    NKS quota.

    Clusters QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    NodePoolMemoryGB QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    NodePoolVcpu QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    PublicIPs QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    Region RegionName

    Region the resource is in.

    Storage QuotaStorage

    Storage quota.

    ABS QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64
    LocalNvme QuotaDimensionDetail

    Quota dimension detail.

    Limit int64
    Remaining int64
    Used int64

    Get Region Quota

    package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/option"
  "github.com/nirvana-labs/nirvana-go/quotas"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  quota, err := client.Quotas.Get(context.TODO(), quotas.QuotaGetParamsRegionUsSva2)
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", quota.Compute)
}

    {
  "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
    }
  }
}
    Returns Examples
    {
  "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
    }
  }
}