---
title: "Get Resource Quota"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044/operations/get-resource-quota"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-dev-2/versions/ecf70889-e649-4a6a-8151-214a472a1044.md

# Get Resource Quota

`GET` `/cloud-gateways/resource-quotas/{resourceQuotaId}`

Operation ID: `get-resource-quota`

Retrieves a resource quota by ID.

## Path parameters

- `resourceQuotaId` (string, uuid, required) - The ID of the resource quota to operate on.

## Responses

- `200` - Response format for retrieving a resource quota for an organization.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
paths:
  /cloud-gateways/resource-quotas/{resourceQuotaId}:
    get:
      operationId: get-resource-quota
      summary: Get Resource Quota
      description: Retrieves a resource quota by ID.
      parameters:
        - $ref: "#/components/parameters/ResourceQuotaId"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveResourceQuotaResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Cloud Gateways Resource Quotas
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ResourceQuotaId:
      name: resourceQuotaId
      in: path
      description: The ID of the resource quota to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/ResourceQuotaId"
  responses:
    RetrieveResourceQuotaResponse:
      description: Response format for retrieving a resource quota for an organization.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ResourceQuota"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ResourceQuotaId:
      type: string
      format: uuid
      example: 9678f205-49a1-47bb-82d9-d01cafa42a0d
      readOnly: true
    ResourceQuota:
      description: Object containing information about a resource quota for an organization.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/ResourceQuotaId"
        resource:
          $ref: "#/components/schemas/ResourceQuotaQualifier"
        name:
          $ref: "#/components/schemas/ResourceQuotaName"
        description:
          $ref: "#/components/schemas/ResourceQuotaDescription"
        value:
          $ref: "#/components/schemas/ResourceQuotaValue"
        created_at:
          description: An RFC-3339 timestamp representation of resource quota creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of resource quota update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - resource
        - name
        - description
        - value
        - created_at
        - updated_at
      title: Resource Quota
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ResourceQuotaQualifier:
      description: Enumeration of resources available for quota enforcement.
      type: string
      enum:
        - count/provider-accounts.per-provider
        - count/networks.not-offline
        - count/data-planes-estimate
        - count/serverless-data-planes-estimate
        - count/data-plane-groups-estimate
    ResourceQuotaName:
      description: The human-readable name of this resource quota.
      type: string
      example: Active Networks
      readOnly: true
    ResourceQuotaDescription:
      description: A more verbose description of what this resource quota enforces.
      type: string
      example: Across the organization, the aggregate number of active networks cannot
        exceed this value.
      readOnly: true
    ResourceQuotaValue:
      description: >
        The aggregate non-negative integer count of this resource that's allowed
        for the organization.
      type: integer
      example: 2
      minimum: 0
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
