> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/repository/v1/plugin.md). # Plugin A Plugin is a resource containing data of deployable plugins such as container image and registry URL. > **Package : spaceone.api.repository.v1** \
## Plugin **Plugin Methods:** | Method | Request | Response | | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | [**register**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#register) | [RegisterPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#registerpluginrequest) | [PluginInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#plugininfo) | | [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#update) | [UpdatePluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#updatepluginrequest) | [PluginInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#plugininfo) | | [**deregister**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#deregister) | [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#empty) | | [**enable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#enable) | [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) | [PluginInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#plugininfo) | | [**disable**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#disable) | [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) | [PluginInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#plugininfo) | | [**get\_versions**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#get_versions) | [RepositoryPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#repositorypluginrequest) | [VersionsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#versionsinfo) | | [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#get) | [RepositoryPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#repositorypluginrequest) | [PluginInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#plugininfo) | | [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#list) | [PluginQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginquery) | [PluginsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginsinfo) |
### register Registers a Plugin. The parameter `registry_type`, meaning container registry type, can be either `DOCKER_HUB` or `AWS_PRIVATE_ECR`. The default value of the `registry_type` is `DOCKER_HUB`. The parameter `registry_url` is required if the `registry_type` is not `DOCKER_HUB`. The parameter `image` is limited to 40 characters. > **POST** /repository/v1/plugin/register {{< tabs " register " >}} {{< tab "Request Example" >}} [RegisterPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#registerpluginrequest) * **name** (string) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) * **registry\_type** (PublicRegistryType) * **registry\_config** (Struct) * **capability** (Struct) * **labels** (ListValue) * **tags** (Struct) * **plugin\_id** (string) *if plugin\_id is not provided, it will be generated by image name* * **docs** (Struct) {{< highlight json >}} { "name": "JIRA Software Collector", "service\_type": "inventory.Collector", "image": "cloudforet/plugin-jira-noti-protocol", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "provider": "jira", "capability": { "supported\_schema": \[ "jira-software-secret-api-token" ] }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" } } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginInfo](#PLUGININFO) * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-jira-noti-protocol", "name": "JIRA Issue notification", "image": "pyengine/plugin-jira-noti-protocol", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "notification.Procotol", "provider": "atlassian", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": { "supported\_schema": \[ "atlassian\_jira" ] }, "template": { "options": { "schema": { "type": "object", "required": \[], "properties": { "project\_id": { "type": "string", "title": "Project ID", "minLength": 4.0 }, "sa\_name": { "title": "Service Account", "type": "string", "minLength": 4.0 } } } } }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T08:02:38.094Z", "updated\_at": "2022-01-01T08:02:38.094Z" } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### update Updates a specific Plugin registered. A Plugin can be updated only if its Repository's `repository_type` is `local`. You can make changes in Plugin settings, including `template` and its options, `schema`. > **POST** /repository/v1/plugin/update {{< tabs " update " >}} {{< tab "Request Example" >}} [UpdatePluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#updatepluginrequest) * **plugin\_id** (string) `Required` * **name** (string) * **capability** (Struct) * **labels** (ListValue) * **tags** (Struct) * **docs** (Struct) {{< highlight json >}} { "name": "JIRA Software Collector", "capability": { "supported\_schema": \[ "jira-software-secret-api-token" ] }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" } } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginInfo](#PLUGININFO) * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-jira-noti-protocol", "name": "JIRA Issue notification", "image": "pyengine/plugin-jira-noti-protocol", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "notification.Procotol", "provider": "atlassian", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": { "supported\_schema": \[ "atlassian\_jira" ] }, "template": { "options": { "schema": { "type": "object", "required": \[], "properties": { "project\_id": { "type": "string", "title": "Project ID", "minLength": 4.0 }, "sa\_name": { "title": "Service Account", "type": "string", "minLength": 4.0 } } } } }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T08:02:38.094Z", "updated\_at": "2022-01-01T08:02:38.094Z" } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### deregister Deregisters and deletes a specific Plugin. You must specify the `plugin_id` of the Plugin to deregister. > **POST** /repository/v1/plugin/deregister {{< tabs " deregister " >}} {{< tab "Request Example" >}} [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) * **plugin\_id** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-aws-sns-mon-webhook", } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### enable Enables a specific Plugin. If the Plugin is enabled, the Plugin can be used as its parameter `state` becomes `ENABLED`. > **POST** /repository/v1/plugin/enable {{< tabs " enable " >}} {{< tab "Request Example" >}} [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) * **plugin\_id** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-aws-sns-mon-webhook", } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginInfo](#PLUGININFO) * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-jira-noti-protocol", "name": "JIRA Issue notification", "image": "pyengine/plugin-jira-noti-protocol", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "notification.Procotol", "provider": "atlassian", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": { "supported\_schema": \[ "atlassian\_jira" ] }, "template": { "options": { "schema": { "type": "object", "required": \[], "properties": { "project\_id": { "type": "string", "title": "Project ID", "minLength": 4.0 }, "sa\_name": { "title": "Service Account", "type": "string", "minLength": 4.0 } } } } }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T08:02:38.094Z", "updated\_at": "2022-01-01T08:02:38.094Z" } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### disable Disables a specific Plugin. If the Plugin is disabled, the Plugin cannot be used as its parameter `state` becomes `DISABLED`. > **POST** /repository/v1/plugin/disable {{< tabs " disable " >}} {{< tab "Request Example" >}} [PluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginrequest) * **plugin\_id** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-aws-sns-mon-webhook", } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginInfo](#PLUGININFO) * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-jira-noti-protocol", "name": "JIRA Issue notification", "image": "pyengine/plugin-jira-noti-protocol", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "notification.Procotol", "provider": "atlassian", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": { "supported\_schema": \[ "atlassian\_jira" ] }, "template": { "options": { "schema": { "type": "object", "required": \[], "properties": { "project\_id": { "type": "string", "title": "Project ID", "minLength": 4.0 }, "sa\_name": { "title": "Service Account", "type": "string", "minLength": 4.0 } } } } }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T08:02:38.094Z", "updated\_at": "2022-01-01T08:02:38.094Z" } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### get\_versions Gets all version data of a specific Plugin from its Repository. The parameter `plugin_id` is used as an identifier of a Plugin to get version data. > **POST** /repository/v1/plugin/get-versions {{< tabs " get\_versions " >}} {{< tab "Request Example" >}} [RepositoryPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#repositorypluginrequest) * **plugin\_id** (string) `Required` * **repository\_id** (string) {{< highlight json >}} { "plugin\_id": "plugin-aws-sns-mon-webhook", } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [VersionsInfo](#VERSIONSINFO) * **version** (string) `Repeated` `Required` deprecated field * **total\_count** (int32) `Required` * **results** (string) `Repeated` `Required` {{< highlight json >}} { "total\_count": 1, "results": \[ "1.2.2", "1.2.1.20220429.104002", "1.2.1.20220422.161421", "1.2.1.20220411.113807", "1.2.1" ] } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### get Gets a specific Plugin. Prints detailed information about the Plugin, including `image`, `registry_url`, and `state`. > **POST** /repository/v1/plugin/get {{< tabs " get " >}} {{< tab "Request Example" >}} [RepositoryPluginRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#repositorypluginrequest) * **plugin\_id** (string) `Required` * **repository\_id** (string) {{< highlight json >}} { "plugin\_id": "plugin-aws-sns-mon-webhook", } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginInfo](#PLUGININFO) * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required` {{< highlight json >}} { "plugin\_id": "plugin-jira-noti-protocol", "name": "JIRA Issue notification", "image": "pyengine/plugin-jira-noti-protocol", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "notification.Procotol", "provider": "atlassian", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": { "supported\_schema": \[ "atlassian\_jira" ] }, "template": { "options": { "schema": { "type": "object", "required": \[], "properties": { "project\_id": { "type": "string", "title": "Project ID", "minLength": 4.0 }, "sa\_name": { "title": "Service Account", "type": "string", "minLength": 4.0 } } } } }, "labels": \[ "jira", "atlassian", "notification" ], "tags": { "description": "Atlassian JIRA Issue notification", "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T08:02:38.094Z", "updated\_at": "2022-01-01T08:02:38.094Z" } {{< /highlight >}} {{< /tab >}} {{< /tabs >}}
### list Gets a list of all Plugins registered in a specific Repository. The parameter `repository_id` is used as an identifier of a Repository to get its list of Plugins. You can use a query to get a filtered list of Plugins. > **POST** /repository/v1/plugin/list {{< tabs " list " >}} {{< tab "Request Example" >}} [PluginQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/repository/v1/Plugin/README.md#pluginquery) * **query** (Query) * **plugin\_id** (string) * **name** (string) * **state** (State) * **resource\_type** (string) * **provider** (string) * **registry\_type** (PublicRegistryType) * **repository\_id** (string) {{< highlight json >}} { "query": {}, "repository\_id": "repo-123456789012" } {{< /highlight >}} {{< /tab >}} {{< tab "Response Example" >}} [PluginsInfo](#PLUGINSINFO) * **results** (PluginInfo) `Repeated` `Required` * **total\_count** (int32) `Required` {{< highlight json >}} { "results": \[ { "plugin\_id": "plugin-api-direct-mon-webhook", "name": "API Direct Webhook", "image": "pyengine/plugin-api-direct-mon-webhook", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "monitoring.Webhook", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": {}, "template": {}, "labels": \[], "tags": { "icon": "" }, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-987654321098", "created\_at": "2022-01-01T03:25:10.408Z", "updated\_at": "2022-01-01T03:25:10.408Z" }, { "plugin\_id": "plugin-aws-hyperbilling-cost-datasource", "name": "AWS HyperBilling Cost Analysis Data Source", "image": "pyengine/plugin-aws-hyperbilling-cost-datasource", "registry\_url": "registry.hub.docker.com", "state": "ENABLED", "service\_type": "cost\_analysis.DataSoruce", "registry\_type": "DOCKER\_HUB", "registry\_config": {}, "capability": {}, "template": {}, "labels": \[], "tags": {}, "repository\_info": { "repository\_id": "repo-123456789012", "name": "Marketplace", "repository\_type": "remote" }, "domain\_id": "domain-987654321098", "created\_at": "2022-01-01T04:56:55.082Z", "updated\_at": "2022-01-01T04:56:55.082Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}} {{< /tabs >}} \
## Message ### PluginInfo * **plugin\_id** (string) `Required` * **name** (string) `Required` * **state** (State) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) `Required` * **registry\_type** (PublicRegistryType) `Required` * **registry\_url** (string) `Required` * **registry\_config** (Struct) `Required` * **capability** (Struct) `Required` * **labels** (ListValue) `Required` * **tags** (Struct) `Required` * **docs** (Struct) `Required` * **domain\_id** (string) `Required` * **repository\_info** (RepositoryInfo) `Required` * **created\_at** (string) `Required` * **updated\_at** (string) `Required`
### PluginQuery * **query** (Query) * **plugin\_id** (string) * **name** (string) * **state** (State) * **resource\_type** (string) * **provider** (string) * **registry\_type** (PublicRegistryType) * **repository\_id** (string)
### PluginRequest * **plugin\_id** (string) `Required`
### PluginsInfo * **results** (PluginInfo) `Repeated` `Required` * **total\_count** (int32) `Required`
### RegisterPluginRequest * **name** (string) `Required` * **resource\_type** (string) `Required` * **image** (string) `Required` * **provider** (string) * **registry\_type** (PublicRegistryType) * **registry\_config** (Struct) * **capability** (Struct) * **labels** (ListValue) * **tags** (Struct) * **plugin\_id** (string) *if plugin\_id is not provided, it will be generated by image name* * **docs** (Struct)
### RepositoryPluginRequest * **plugin\_id** (string) `Required` * **repository\_id** (string)
### UpdatePluginRequest * **plugin\_id** (string) `Required` * **name** (string) * **capability** (Struct) * **labels** (ListValue) * **tags** (Struct) * **docs** (Struct)
### VersionsInfo * **version** (string) `Repeated` `Required` *deprecated field* * **total\_count** (int32) `Required` * **results** (string) `Repeated` `Required`
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://cloudforet.gitbook.io/cloudforet-apis/content/en/repository/v1/plugin.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.