> For the complete documentation index, see [llms.txt](https://spaceone-dev.gitbook.io/spaceone-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spaceone-dev.gitbook.io/spaceone-apis/notification/v1/quota.md).

# Quota

> **Package : spaceone.api.notification.v1**

## Quota

{% hint style="info" %}
**Quota Methods:**
{% endhint %}

| Method                | Request                                   | Response                                                                                                           |
| --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [CreateQuotaRequest](#createquotarequest) | [QuotaInfo](#quotainfo)                                                                                            |
| [**update**](#update) | [UpdateQuotaRequest](#updatequotarequest) | [QuotaInfo](#quotainfo)                                                                                            |
| [**delete**](#delete) | [QuotaRequest](#quotarequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [QuotaRequest](#quotarequest)             | [QuotaInfo](#quotainfo)                                                                                            |
| [**list**](#list)     | [QuotaQuery](#quotaquery)                 | [QuotasInfo](#quotasinfo)                                                                                          |
| [**stat**](#stat)     | [QuotaStatQuery](#quotastatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /notification/v1/quotas

> Creates a new Quota for Protocol.

| Type     | Message                                   |
| -------- | ----------------------------------------- |
| Request  | [CreateQuotaRequest](#createquotarequest) |
| Response | [QuotaInfo](#quotainfo)                   |

### update

> **PUT** /notification/v1/quota/{quota\_id}

> Updates a exist Quota information.

| Type     | Message                                   |
| -------- | ----------------------------------------- |
| Request  | [UpdateQuotaRequest](#updatequotarequest) |
| Response | [QuotaInfo](#quotainfo)                   |

### delete

> **DELETE** /notification/v1/quota/{quota\_id}

> Delete the Quota.

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [QuotaRequest](#quotarequest)                                                                                    |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### get

> **GET** /notification/v1/quota/{quota\_id}

> Gets a single Quota information.

| Type     | Message                       |
| -------- | ----------------------------- |
| Request  | [QuotaRequest](#quotarequest) |
| Response | [QuotaInfo](#quotainfo)       |

### list

> **GET** /notification/v1/quotas
>
> **POST** /notification/v1/quotas/search

> Lists the specified Quota information.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.

| Type     | Message                   |
| -------- | ------------------------- |
| Request  | [QuotaQuery](#quotaquery) |
| Response | [QuotasInfo](#quotasinfo) |

### stat

> **POST** /notification/v1/quotas/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [QuotaStatQuery](#quotastatquery)                                                                                  |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

##

## Message

### CreateQuotaRequest

| Field        | Type                                                                                                               | Required | Description                             |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | --------------------------------------- |
| protocol\_id | string                                                                                                             |     ✔    |                                         |
| limit        | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    | The information about Quota limitation. |
| domain\_id   | string                                                                                                             |     ✔    | The ID of domain.                       |

### QuotaInfo

| Field        | Type                                                                                                               | Description                             |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| quota\_id    | string                                                                                                             | The ID of Quota.                        |
| protocol\_id | string                                                                                                             | The ID of Protocol.                     |
| limit        | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | The information about Quota limitation. |
| domain\_id   | string                                                                                                             | The ID of domain                        |

### QuotaQuery

| Field        | Type                                                                                               | Required | Description                                                                    |
| ------------ | -------------------------------------------------------------------------------------------------- | :------: | ------------------------------------------------------------------------------ |
| query        | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    | Query format provided by SpaceONE. Please check the link for more information. |
| quota\_id    | string                                                                                             |     ✘    | The ID of Quota.                                                               |
| protocol\_id | string                                                                                             |     ✘    | The ID of Protocol.                                                            |
| domain\_id   | string                                                                                             |     ✔    | The ID of domain.                                                              |

### QuotaRequest

| Field      | Type   | Required | Description       |
| ---------- | ------ | :------: | ----------------- |
| quota\_id  | string |     ✔    | The ID of Quota.  |
| domain\_id | string |     ✔    | The ID of domain. |

### QuotaStatQuery

| Field      | Type                                                                                                             | Required | Description                                                                               |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------- |
| query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    | Statistics Query format provided by SpaceONE. Please check the link for more information. |
| domain\_id | string                                                                                                           |     ✔    | The ID of domain.                                                                         |

### QuotasInfo

| Field        | Type                                                                                            | Description                    |
| ------------ | ----------------------------------------------------------------------------------------------- | ------------------------------ |
| results      | [list of QuotaInfo](#quotainfo)                                                                 | List of queried Quota.         |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | Total counts of queried Quota. |

### UpdateQuotaRequest

| Field      | Type                                                                                                               | Required | Description                             |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | :------: | --------------------------------------- |
| quota\_id  | string                                                                                                             |     ✔    | The ID of Quota.                        |
| limit      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    | The information about Quota limitation. |
| domain\_id | string                                                                                                             |     ✔    |                                         |