# Collector > **Package : spaceone.api.inventory.v1** ## Collector {% hint style="info" %} **Collector Methods:** {% endhint %} | Method | Request | Response | | ---------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | [**create**](#create) | [CreateCollectorRequest](#createcollectorrequest) | [CollectorInfo](#collectorinfo) | | [**update**](#update) | [UpdateCollectorRequest](#updatecollectorrequest) | [CollectorInfo](#collectorinfo) | | [**update\_plugin**](#update_plugin) | [UpdatePluginRequest](#updatepluginrequest) | [CollectorInfo](#collectorinfo) | | [**verify\_plugin**](#verify_plugin) | [VerifyPluginRequest](#verifypluginrequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | | [**delete**](#delete) | [CollectorRequest](#collectorrequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | | [**get**](#get) | [GetCollectorRequest](#getcollectorrequest) | [CollectorInfo](#collectorinfo) | | [**enable**](#enable) | [CollectorRequest](#collectorrequest) | [CollectorInfo](#collectorinfo) | | [**disable**](#disable) | [CollectorRequest](#collectorrequest) | [CollectorInfo](#collectorinfo) | | [**list**](#list) | [CollectorQuery](#collectorquery) | [CollectorsInfo](#collectorsinfo) | | [**stat**](#stat) | [CollectorStatQuery](#collectorstatquery) | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | [**collect**](#collect) | [CollectRequest](#collectrequest) | [JobInfo](#jobinfo) | | [**add\_schedule**](#add_schedule) | [CreateScheduleRequest](#createschedulerequest) | [ScheduleInfo](#scheduleinfo) | | [**get\_schedule**](#get_schedule) | [ScheduleRequest](#schedulerequest) | [ScheduleInfo](#scheduleinfo) | | [**update\_schedule**](#update_schedule) | [UpdateScheduleRequest](#updateschedulerequest) | [ScheduleInfo](#scheduleinfo) | | [**delete\_schedule**](#delete_schedule) | [DeleteScheduleRequest](#deleteschedulerequest) | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | | [**list\_schedules**](#list_schedules) | [ScheduleQuery](#schedulequery) | [SchedulesInfo](#schedulesinfo) | ### create > **POST** /inventory/v1/collectors | Type | Message | | -------- | ------------------------------------------------- | | Request | [CreateCollectorRequest](#createcollectorrequest) | | Response | [CollectorInfo](#collectorinfo) | ### update > **PUT** /inventory/v1/collector/{collector\_id} | Type | Message | | -------- | ------------------------------------------------- | | Request | [UpdateCollectorRequest](#updatecollectorrequest) | | Response | [CollectorInfo](#collectorinfo) | ### update\_plugin > **PUT** /inventory/v1/collector/{collector\_id}/plugin | Type | Message | | -------- | ------------------------------------------- | | Request | [UpdatePluginRequest](#updatepluginrequest) | | Response | [CollectorInfo](#collectorinfo) | ### verify\_plugin > **POST** /inventory/v1/collector/{collector\_id}/plugin/verify | Type | Message | | -------- | ---------------------------------------------------------------------------------------------------------------- | | Request | [VerifyPluginRequest](#verifypluginrequest) | | Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | ### delete > **DELETE** /inventory/v1/collector/{collector\_id} | Type | Message | | -------- | ---------------------------------------------------------------------------------------------------------------- | | Request | [CollectorRequest](#collectorrequest) | | Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | ### get > **GET** /inventory/v1/collector/{collector\_id} | Type | Message | | -------- | ------------------------------------------- | | Request | [GetCollectorRequest](#getcollectorrequest) | | Response | [CollectorInfo](#collectorinfo) | ### enable > **PUT** /inventory/v1/collector/{collector\_id}/enable | Type | Message | | -------- | ------------------------------------- | | Request | [CollectorRequest](#collectorrequest) | | Response | [CollectorInfo](#collectorinfo) | ### disable > **PUT** /inventory/v1/collector/{collector\_id}/disable | Type | Message | | -------- | ------------------------------------- | | Request | [CollectorRequest](#collectorrequest) | | Response | [CollectorInfo](#collectorinfo) | ### list > **GET** /inventory/v1/collectors > > **POST** /inventory/v1/collectors/search | Type | Message | | -------- | --------------------------------- | | Request | [CollectorQuery](#collectorquery) | | Response | [CollectorsInfo](#collectorsinfo) | ### stat > **POST** /inventory/v1/collectors/stat | Type | Message | | -------- | ------------------------------------------------------------------------------------------------------------------ | | Request | [CollectorStatQuery](#collectorstatquery) | | Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ### collect > **POST** /inventory/v1/collector/{collector\_id}/collect | Type | Message | | -------- | --------------------------------- | | Request | [CollectRequest](#collectrequest) | | Response | [JobInfo](#jobinfo) | ### add\_schedule > **POST** /inventory/v1/collector/{collector\_id}/schedule | Type | Message | | -------- | ----------------------------------------------- | | Request | [CreateScheduleRequest](#createschedulerequest) | | Response | [ScheduleInfo](#scheduleinfo) | ### get\_schedule > **GET** /inventory/v1/collector/{collector\_id}/schedule/{schedule\_id} | Type | Message | | -------- | ----------------------------------- | | Request | [ScheduleRequest](#schedulerequest) | | Response | [ScheduleInfo](#scheduleinfo) | ### update\_schedule > **POST** /inventory/v1/collector/{collector\_id}/schedule/{schedule\_id} | Type | Message | | -------- | ----------------------------------------------- | | Request | [UpdateScheduleRequest](#updateschedulerequest) | | Response | [ScheduleInfo](#scheduleinfo) | ### delete\_schedule > **DELETE** /inventory/v1/collector/{collector\_id}/schedule/{schedule\_id} | Type | Message | | -------- | ---------------------------------------------------------------------------------------------------------------- | | Request | [DeleteScheduleRequest](#deleteschedulerequest) | | Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) | ### list\_schedules > **GET** /inventory/v1/collector/{collector\_id}/schedules > > **POST** /inventory/v1/collector/{collector\_id}/schedules/search | Type | Message | | -------- | ------------------------------- | | Request | [ScheduleQuery](#schedulequery) | | Response | [SchedulesInfo](#schedulesinfo) | ## ## Message ### CollectRequest | Field | Type | Required | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | collector\_id | string | ✔ | | | filter | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | secret\_id | string | ✘ | | | collect\_mode | string | ✘ | | | domain\_id | string | ✔ | | | use\_cache | bool | ✘ | | ### CollectorInfo | Field | Type | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | collector\_id | string | | | name | string | | | state | | | | plugin\_info | [PluginInfo](#plugininfo) | | | priority | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | created\_at | string | | | last\_collected\_at | string | | | domain\_id | string | | | provider | string | | | capability | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | is\_public | bool | | | project\_id | string | | ### CollectorQuery | Field | Type | Description | | ------------- | -------------------------------------------------------------------------------------------------- | ----------- | | query | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | | | collector\_id | string | | | name | string | | | state | | | | priority | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | plugin\_id | string | | | domain\_id | string | | ### CollectorRequest | Field | Type | Required | Description | | ------------- | ------ | :------: | ----------- | | collector\_id | string | ✔ | | | domain\_id | string | ✔ | | ### CollectorStatQuery | Field | Type | Required | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) | ✔ | | | domain\_id | string | ✔ | | ### CollectorsInfo | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------------------------- | ----------- | | results | [list of CollectorInfo](#collectorinfo) | | | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### CreateCollectorRequest | Field | Type | Required | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | -------------------------------------------------------------------- | | name | string | ✔ | | | plugin\_info | [PluginInfo](#plugininfo) | ✔ | | | priority | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | | is\_public | bool | ✘ | default is true | | project\_id | string | ✔ | if is\_public is false, project\_id is requireremained as is\_public | ### CreateScheduleRequest | Field | Type | Required | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | domain\_id | string | ✔ | | | collector\_id | string | ✔ | | | name | string | ✘ | | | collect\_mode | string | ✘ | | | schedule | [Scheduled](#scheduled) | ✔ | | | filter | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | ### DeleteScheduleRequest | Field | Type | Required | Description | | ------------- | ------ | :------: | ----------- | | domain\_id | string | ✔ | | | schedule\_id | string | ✔ | | | collector\_id | string | ✔ | | ### ErrorInfo | Field | Type | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | error\_code | string | | | message | string | | | additional | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | ### GetCollectorRequest | Field | Type | Required | Description | | ------------- | -------------- | :------: | ----------- | | collector\_id | string | ✔ | | | domain\_id | string | ✔ | | | only | list of string | ✘ | | ### JobInfo | Field | Type | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------- | | job\_id | string | | | status | | | | filter | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | total\_tasks | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | remained\_tasks | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | errors | [list of ErrorInfo](#errorinfo) | | | collector\_info | [CollectorInfo](#collectorinfo) | | | project\_id | string | | | domain\_id | string | | | created\_at | string | | | updated\_at | string | | | finished\_at | string | | ### PluginInfo | Field | Type | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | plugin\_id | string | | | version | string | | | options | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | secret\_id | string | | | secret\_group\_id | string | | | provider | string | | | service\_account\_id | string | | | metadata | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | | upgrade\_mode | | | ### ScheduleInfo | Field | Type | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | | domain\_id | string | | | schedule\_id | string | | | name | string | | | collect\_mode | string | | | schedule | [Scheduled](#scheduled) | | | created\_at | string | | | last\_scheduled\_at | string | | | collector\_info | [CollectorInfo](#collectorinfo) | | | filter | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | | ### ScheduleQuery | Field | Type | Required | Description | | ------------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- | | query | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘ | | | collector\_id | string | ✔ | | | schedule\_id | string | ✘ | | | domain\_id | string | ✔ | | ### ScheduleRequest | Field | Type | Required | Description | | ------------- | ------ | :------: | ----------- | | domain\_id | string | ✔ | | | schedule\_id | string | ✔ | | | collector\_id | string | ✔ | | ### Scheduled | Field | Type | Description | | -------- | ------------------------------------------------------------------------------------------------------- | ----------- | | cron | string | | | interval | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | minutes | [list of int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | | hours | [list of int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### SchedulesInfo | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------------------------- | ----------- | | results | [list of ScheduleInfo](#scheduleinfo) | | | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | | ### UpdateCollectorRequest | Field | Type | Required | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | collector\_id | string | ✔ | | | name | string | ✘ | | | plugin\_info | [PluginInfo](#plugininfo) | ✘ | | | priority | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) | ✘ | | | tags | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | ### UpdatePluginRequest | Field | Type | Required | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- | | collector\_id | string | ✔ | | | version | string | ✘ | | | options | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | | domain\_id | string | ✔ | | | upgrade\_mode | | ✘ | | ### UpdateScheduleRequest | Field | Type | Required | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- | | domain\_id | string | ✔ | | | schedule\_id | string | ✔ | | | collector\_id | string | ✔ | | | name | string | ✘ | | | collect\_mode | string | ✘ | | | schedule | [Scheduled](#scheduled) | ✘ | | | filter | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘ | | ### VerifyInfo | Field | Type | Description | | ------ | ---- | ----------- | | status | bool | | ### VerifyPluginRequest | Field | Type | Required | Description | | ------------- | ------ | :------: | ----------- | | collector\_id | string | ✔ | | | secret\_id | string | ✘ | | | domain\_id | string | ✔ | | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://spaceone-dev.gitbook.io/spaceone-apis/inventory/v1/collector.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.