> ## Documentation Index
> Fetch the complete documentation index at: https://developers.onidel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get resource quotas and current usage

> Returns resource limits, current usage, and remaining quotas for a team.
Uses your primary team when team_id is omitted. Requires team read permission.
Quotas may apply to the team, its owner, or an individual IP list, as indicated
by scope. Available quota does not guarantee provisioning; billing and capacity
checks still apply.




## OpenAPI

````yaml /api-reference/openapi.yaml get /resource_quotas
openapi: 3.0.3
info:
  title: Onidel Cloud API - OpenAPI 3.0
  description: >-
    Welcome to the **Onidel Cloud API** documentation. This API allows
    developers to seamlessly integrate with the Onidel Cloud platform, enabling
    them to manage cloud resources efficiently and securely. With our API, you
    can automate processes, retrieve detailed account information, and manage
    virtual machines (VPS), networking, storage, and more.
  termsOfService: https://docs.onidel.com/policies/terms-of-service
  contact:
    email: support@onidel.com
  version: 1.2.0
servers:
  - url: https://api.cloud.onidel.com
security: []
tags:
  - name: Teams
    description: List teams and retrieve their resource quotas and current usage.
  - name: SSH Key
    description: Manage SSH keys for secure server access.
  - name: VPC
    description: Manage Virtual Private Cloud (VPC) networks for isolated networking.
  - name: Firewall
    description: Manage firewall groups for VM security.
  - name: OS Template
    description: >-
      We have a wide range of operating systems available to deploy server
      instances.
  - name: Instance Type
    description: We provide different instance types for different workload.
  - name: Startup Script
    description: >-
      Manage startup scripts that run on first boot of a server instance.
      Maximum 10 scripts per team.
  - name: IP List
    description: >-
      Manage IP lists for use in firewall rules. IP lists group multiple IP
      addresses/CIDRs together.
  - name: Firewall Rule
    description: Manage firewall rules within a firewall group.
  - name: Object Storage
    description: Manage S3-compatible object storage services, buckets, and access keys.
  - name: Custom ISO
    description: Manage custom ISO images that can be used to boot server instances (BYOI).
  - name: Measured Boot Image
    description: >-
      Manage SEV-SNP measured direct boot images (UKIs) and attach/detach them
      to instances.
paths:
  /resource_quotas:
    get:
      tags:
        - Teams
      summary: Get resource quotas and current usage
      description: >
        Returns resource limits, current usage, and remaining quotas for a team.

        Uses your primary team when team_id is omitted. Requires team read
        permission.

        Quotas may apply to the team, its owner, or an individual IP list, as
        indicated

        by scope. Available quota does not guarantee provisioning; billing and
        capacity

        checks still apply.
      operationId: getResourceQuotas
      parameters:
        - name: team_id
          in: query
          description: >-
            Team to retrieve quotas for. Uses the user's primary team when
            omitted.
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Current quotas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceQuotas'
        '400':
          description: Invalid team ID
          content:
            application/json:
              schema:
                type: object
                required:
                  - err
                properties:
                  err:
                    type: string
                    enum:
                      - INVALID_TEAM_ID
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    type: string
                    example: Authentication credentials were not provided.
        '403':
          description: Team read permission denied. The response body is empty.
        '404':
          description: Team or primary membership not found
          content:
            application/json:
              schema:
                type: object
                required:
                  - err
                properties:
                  err:
                    type: string
                    enum:
                      - TEAM_NOT_FOUND
        '503':
          description: Quota configuration or owner membership unavailable
          content:
            application/json:
              schema:
                type: object
                required:
                  - err
                properties:
                  err:
                    type: string
                    enum:
                      - QUOTAS_UNAVAILABLE
      security:
        - api_key: []
        - token_auth: []
components:
  schemas:
    ResourceQuotas:
      type: object
      required:
        - team_id
        - quotas
      properties:
        team_id:
          type: string
          format: uuid
        quotas:
          type: object
          required:
            - hourly_vms
            - hourly_vm_cost
            - hourly_vm_provisions_today
            - ip_lists
            - ip_list_entries
            - reserved_ips
            - reserved_ip_creations_today
            - reserved_ip_conversions_today
            - startup_scripts
            - firewall_groups
            - vpcs
            - custom_isos
            - snapshots
            - backup_destinations
          properties:
            hourly_vms:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            hourly_vm_cost:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            hourly_vm_provisions_today:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            ip_lists:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            reserved_ips:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            reserved_ip_creations_today:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            reserved_ip_conversions_today:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            startup_scripts:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            firewall_groups:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            vpcs:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            custom_isos:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            snapshots:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            backup_destinations:
              $ref: '#/components/schemas/ResourceQuotaUsage'
            ip_list_entries:
              $ref: '#/components/schemas/IPListEntryQuotas'
    ResourceQuotaUsage:
      type: object
      required:
        - limit
        - used
        - remaining
        - scope
      properties:
        limit:
          type: number
          description: >-
            Effective cap used by the current creation check. Zero is not
            unlimited.
        used:
          type: number
        remaining:
          type: number
          minimum: 0
          description: max(0, limit - used).
        scope:
          type: string
          enum:
            - owner
            - team
            - ip_list
        configured_limit:
          type: number
          description: >-
            Owner's configured instance cap for hourly_vms, or twice that cap
            for hourly_vm_provisions_today.
        team_used:
          type: integer
          description: Hourly VMs belonging to the selected team.
        other_teams_used:
          type: integer
          description: >-
            Hourly VMs in other teams owned by the same owner; no resource
            details are exposed.
        unit:
          type: string
          example: monthly_cost
        currency:
          type: string
          description: >-
            Selected team's billing currency; cost enforcement values are not
            converted.
          example: AUD
        max_size_bytes:
          type: integer
          description: Maximum size of an individual custom ISO.
    IPListEntryQuotas:
      type: object
      required:
        - limit_per_list
        - scope
        - lists
      properties:
        limit_per_list:
          type: integer
        scope:
          type: string
          enum:
            - ip_list
        lists:
          type: array
          items:
            allOf:
              - $ref: '#/components/schemas/ResourceQuotaUsage'
              - type: object
                required:
                  - id
                  - name
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    token_auth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token authentication. Enter the complete header value: Token
        <api_token>.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.