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

# quota

> cpln quota — Display resource quotas and current usage for your organization.

Show quotas

For a detailed overview, please visit the [quota's](/reference/quota) reference page.

```none theme={null}
cpln quota [SUBCOMMAND]
```

```text theme={null}
Commands:
  cpln quota edit <ref>    Edit the referenced quota, as YAML, within an editor
  cpln quota get [ref...]  Retrieve one or more referenced quotas
  cpln quota patch <ref>   Update the referenced quota's metadata using an input file
  cpln quota permissions   Show the grantable permissions for a quota object type
  cpln quota query         Find all the quotas based on the given query

Options:
  --help  Show help  [boolean]
```

***

#### quota edit

Edit the referenced quota, as YAML, within an editor

**Usage**

```none theme={null}
cpln quota edit <ref> [OPTIONS]
```

<Note>
  The default editor can be set by using the EDITOR environment variable.
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Command options:
    --replace, -r  Replace instead of patch/merge  [boolean] [default: false]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln quota edit b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
    ```

    ```text Output theme={null}
    Your default editor will be launched.

    Once any modifications are saved, the updates will be sent to the API.
    ```
  </CodeGroup>
</Accordion>

***

#### quota get

Retrieve one or more referenced quotas

**Usage**

```none theme={null}
cpln quota get [ref...] [OPTIONS]
```

<Note>
  An empty reference will return all references
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  * Get all quotas

  <CodeGroup>
    ```bash Command theme={null}
    cpln quota get --org demo-cpln-organization
    ```

    ```text Output theme={null}
    +-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
    |ID                                   |NAME                  |DESCRIPTION                              |ORIGIN  |CURRENT |MAX  |UNIT      |DIMENSIONS                        |
    |-------------------------------------|----------------------|-----------------------------------------|--------|--------|-----|----------|----------------------------------|
    |01812a67-44d6-40d8-b5c1-5d1a2bc04717 |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |1       |20   |count     |gvcLink="demo-gvc-workload"       |
    |189a7ef1-d6b5-4496-9bbc-eb933a64cb81 |agents                |Max number of agents                     |builtin |4       |10   |count     |                                  |
    |27acde85-acee-4e4a-a8d7-a00cba61b9a4 |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |5    |count     |gvcLink="demo-cpln-gvc"           |
    |3319b55b-c307-4240-ba79-f1892c76f70e |memory-per-workload   |Max memory per container                 |builtin |0       |1024 |MiB       |                                  |
    |3dd4d521-6c5f-44a9-90bd-ae7f25fe2fca |replicas-per-workload |Max replicas per workload                |builtin |0       |5    |count     |                                  |
    |5c4a180c-9c5d-4048-b940-37329dacbd28 |identities-per-gvc    |Max number of workload identities in ... |builtin |4       |20   |count     |gvcLink="demo-gvc-identity"       |
    |605d0bd8-1263-447c-a925-b5712bd7c5ae |cpu-per-workload      |Max CPU per container                    |builtin |0       |1000 |millicore |                                  |
    |6d68c00c-7019-4b68-81cd-990ce092ead3 |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |5    |count     |gvcLink="test-gvc"                |
    |96b373be-d7e1-4e5a-b2dd-db4de190c59d |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |5    |count     |gvcLink="demo-gvc-get-streams"    |
    |b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs                  |Max number of gvc's                      |builtin |10      |20   |count     |                                  |
    |b4e49406-5671-480e-919c-4ec313949698 |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |3    |count     |gvcLink="quick-start-4"           |
    |ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains               |Max number of domains                    |builtin |3       |20   |count     |                                  |
    |d2e6bffd-f479-4824-976e-d5037a43a27f |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |5    |count     |gvcLink="demo-gvc-logs"           |
    |d89142a6-01d8-4a33-877b-c9c7f3be37b8 |workloads-per-gvc     |Max number of workloads in a gvc         |builtin |0       |20   |count     |gvcLink="demo-gvc-with-workloads" |
    |e31e22c9-3a7e-4548-bb2c-9467ca820381 |cloudaccounts         |Max number of cloudaccounts              |builtin |5       |10   |count     |                                  |
    +-------------------------------------+----------------------+-----------------------------------------+--------+--------+-----+----------+----------------------------------+
    ```
  </CodeGroup>

  * Get one quota

  <CodeGroup>
    ```bash Command theme={null}
    cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --org demo-cpln-organization
    ```

    ```text Output theme={null}
    +-------------------------------------+-----+--------------------+--------+--------+----+------+-----------+
    |ID                                   |NAME |DESCRIPTION         |ORIGIN  |CURRENT |MAX |UNIT  |DIMENSIONS |
    |-------------------------------------|-----|--------------------|--------|--------|----|------|-----------|
    |b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs |Max number of gvc's |builtin |10      |20  |count |           |
    +-------------------------------------+-----+--------------------+--------+--------+----+------+-----------+
    ```
  </CodeGroup>

  * Get multiple quotas

  <CodeGroup>
    ```bash Command theme={null}
    cpln quota get b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 --org demo-cpln-organization
    ```

    ```text Output theme={null}
    +-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
    |ID                                   |NAME    |DESCRIPTION           |ORIGIN  |CURRENT |MAX |UNIT  |DIMENSIONS |
    |-------------------------------------|--------|----------------------|--------|--------|----|------|-----------|
    |b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a |gvcs    |Max number of gvc's   |builtin |10      |20  |count |           |
    |ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |3       |20  |count |           |
    +-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
    ```
  </CodeGroup>
</Accordion>

***

#### quota patch

Update the referenced quota's metadata using an input file

**Usage**

```none theme={null}
cpln quota patch <ref> --file FILE_NAME [OPTIONS]
```

<Note>
  Running this command with the option **`--file -`** sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., `{"description": "My new description"}` or `description: My new description`). To complete the update, press Control-D (or Control-Z if you are using Windows).
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Command options:
    --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln quota patch b2a6bbc3-e3bb-4623-8689-9fcd71c1c86a --file update.json --org demo-cpln-organization
    ```

    ```text Output theme={null}
    The changes within the JSON file will be performed against the referenced quota.
    ```
  </CodeGroup>
</Accordion>

***

#### quota permissions

Show the grantable permissions for a quota object type

**Usage**

```none theme={null}
cpln quota permissions [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln quota permissions --org demo-cpln-organization
    ```

    ```text Output theme={null}
    +-------+-----------------------+---------------------------+
    |NAME   |DESCRIPTION            |IMPLIES                    |
    |-------|-----------------------|---------------------------|
    |create |Create new quotas      |                           |
    |edit   |Modify existing quotas |view                       |
    |manage |Full access            |create, edit, manage, view |
    |view   |Read-only access       |                           |
    +-------+-----------------------+---------------------------+
    ```
  </CodeGroup>
</Accordion>

***

#### quota query

Find all the quotas based on the given query

**Usage**

```none theme={null}
cpln quota query QUERY_OPTIONS [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Query options:
    --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
    --property, --prop  Property to query
    --tag               Tag to query
    --rel               Relation to query

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <Note>
    Use the `--match` option to display **all**, **none**, or **any** of the results based on a given property, tag, or relation
  </Note>

  * Search for a quota based on a property named `description`

  <CodeGroup>
    ```bash Command theme={null}
    cpln quota query --match any --prop description="Max number of domains" --org demo-cpln-organization
    ```

    ```text Output theme={null}
    +-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
    |ID                                   |NAME    |DESCRIPTION           |ORIGIN  |CURRENT |MAX |UNIT  |DIMENSIONS |
    |-------------------------------------|--------|----------------------|--------|--------|----|------|-----------|
    |ce98ccc8-e4da-4dcb-a61d-4761f22b8eb2 |domains |Max number of domains |builtin |3       |20  |count |           |
    +-------------------------------------+--------+----------------------+--------+--------+----+------+-----------+
    ```
  </CodeGroup>
</Accordion>

***