# Domain Config

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

## DomainConfig

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

| Method                | Request                                           | Response                                                                                                           |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [SetDomainConfigRequest](#setdomainconfigrequest) | [DomainConfigInfo](#domainconfiginfo)                                                                              |
| [**update**](#update) | [SetDomainConfigRequest](#setdomainconfigrequest) | [DomainConfigInfo](#domainconfiginfo)                                                                              |
| [**set**](#set)       | [SetDomainConfigRequest](#setdomainconfigrequest) | [DomainConfigInfo](#domainconfiginfo)                                                                              |
| [**delete**](#delete) | [DomainConfigRequest](#domainconfigrequest)       | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [GetDomainConfigRequest](#getdomainconfigrequest) | [DomainConfigInfo](#domainconfiginfo)                                                                              |
| [**list**](#list)     | [DomainConfigQuery](#domainconfigquery)           | [DomainConfigsInfo](#domainconfigsinfo)                                                                            |
| [**stat**](#stat)     | [DomainConfigStatQuery](#domainconfigstatquery)   | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /config/v1/domain-configs

| Type     | Message                                           |
| -------- | ------------------------------------------------- |
| Request  | [SetDomainConfigRequest](#setdomainconfigrequest) |
| Response | [DomainConfigInfo](#domainconfiginfo)             |

### update

> **PUT** /config/v1/domain-config/{name}

| Type     | Message                                           |
| -------- | ------------------------------------------------- |
| Request  | [SetDomainConfigRequest](#setdomainconfigrequest) |
| Response | [DomainConfigInfo](#domainconfiginfo)             |

### set

> **POST** /config/v1/domain-config/{name}

| Type     | Message                                           |
| -------- | ------------------------------------------------- |
| Request  | [SetDomainConfigRequest](#setdomainconfigrequest) |
| Response | [DomainConfigInfo](#domainconfiginfo)             |

### delete

> **DELETE** /config/v1/domain-config/{name}

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

### get

> **GET** /config/v1/domain-config/{name}

| Type     | Message                                           |
| -------- | ------------------------------------------------- |
| Request  | [GetDomainConfigRequest](#getdomainconfigrequest) |
| Response | [DomainConfigInfo](#domainconfiginfo)             |

### list

> **GET** /config/v1/domain-config
>
> **POST** /config/v1/domain-config/search

| Type     | Message                                 |
| -------- | --------------------------------------- |
| Request  | [DomainConfigQuery](#domainconfigquery) |
| Response | [DomainConfigsInfo](#domainconfigsinfo) |

### stat

> **POST** /config/v1/domain-config/stat

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

##

## Message

### DomainConfigInfo

| Field       | Type                                                                                                               | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| name        | string                                                                                                             |             |
| data        | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| tags        | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| domain\_id  | string                                                                                                             |             |
| created\_at | string                                                                                                             |             |
| updated\_at | string                                                                                                             |             |

### DomainConfigQuery

| Field      | Type                                                                                               | Required | Description |
| ---------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query      | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    |             |
| name       | string                                                                                             |     ✘    |             |
| domain\_id | string                                                                                             |     ✔    |             |

### DomainConfigRequest

| Field      | Type   | Required | Description |
| ---------- | ------ | :------: | ----------- |
| name       | string |     ✔    |             |
| domain\_id | string |     ✔    |             |

### DomainConfigStatQuery

| Field      | Type                                                                                                             | Required | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    |             |
| domain\_id | string                                                                                                           |     ✔    |             |

### DomainConfigsInfo

| Field        | Type                                                                                            | Description |
| ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| results      | [list of DomainConfigInfo](#domainconfiginfo)                                                   |             |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |

### GetDomainConfigRequest

| Field      | Type           | Required | Description |
| ---------- | -------------- | :------: | ----------- |
| name       | string         |     ✔    |             |
| domain\_id | string         |     ✔    |             |
| only       | list of string |     ✘    |             |

### SetDomainConfigRequest

| Field      | Type                                                                                                               | Required | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| name       | string                                                                                                             |     ✔    |             |
| data       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✔    |             |
| tags       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id | string                                                                                                             |     ✔    |             |
