---
title: "Create new system module from template"
method: POST
path: "/modules/"
tags: ["Modules"]
---

# Create new system module from template

`POST /modules/`

## Request body

- ModelsModuleInfo
  - `actions` string[], required
  - `events` string[], required
  - `fields` string[], required
  - `name` string, required
  - `os` ModelsModuleInfoOS, required
  - `system` boolean
  - `tags` string[], required
  - `template` 'generic' | 'empty' | 'collector' | 'detector' | 'responder' | 'custom', required
  - `version` ModelsSemVersion, required
    - `major` integer
    - `minor` integer
    - `patch` integer

## Response `201`

system module created successful

- object
  - `data` object
    - `action_config_schema` object, required
    - `changelog` ModelsChangelog, required
    - `config_schema` object, required
    - `default_action_config` ModelsActionConfig, required
    - `default_config` ModelsModuleConfig, required
    - `default_event_config` ModelsEventConfig, required
    - `event_config_schema` object, required
    - `fields_schema` object, required
    - `id` integer
    - `info` ModelsModuleInfo, required
      - `actions` string[], required
      - `events` string[], required
      - `fields` string[], required
      - `name` string, required
      - `os` ModelsModuleInfoOS, required
      - `system` boolean
      - `tags` string[], required
      - `template` 'generic' | 'empty' | 'collector' | 'detector' | 'responder' | 'custom', required
      - `version` ModelsSemVersion, required
        - `major` integer
        - `minor` integer
        - `patch` integer
    - `last_update` string
    - `locale` ModelsLocale, required
      - `action_config` object, required
      - `actions` object, required
      - `config` object, required
      - `event_config` object, required
      - `events` object, required
      - `fields` object, required
      - `module` ModelsModuleLocaleDesc, required
      - `secure_config` object
      - `tags` object, required
    - `secure_config_schema` object
    - `secure_default_config` ModelsModuleSecureConfig
    - `service_type` 'vxmonitor'
    - `state` 'draft' | 'release'
    - `static_dependencies` ModelsDependencyItem[], required
      - `min_agent_version` string
      - `min_module_version` string
      - `module_name` string
      - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
    - `tenant_id` integer
  - `status` string

## Other responses

- `400` — invalid system module info
- `403` — creating system module not permitted
- `500` — internal error on creating system module

---

[API](https://skmtc.net/vxcontrol/apis/soldr-swagger-api.md) · [All operations](https://skmtc.net/vxcontrol/apis/soldr-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vxcontrol/soldr-swagger-api/versions/ac519ec936b3/schema)