modules

Publish a Module

Changed on

This endpoint creates a Module from a VCS repository.

The module's source code directory should follow the standard module structure.

Scalr extracts various meta information from the module's source:

  • It's important to provide each variable and output blocks with a meaningful descriptions, as they will be displayed in a Module and Workspace Variables pages for your internal users.
  • README or README.md file will be displayed on a Module page.
  • Nested modules from modules/ directory will be searchable and available though the Registry just like top-level modules.

Modules can be published on both account and environment scopes. If neither scope is specified in the request body, the module will be published in the same scope that the related vcs-provider is published.

post/modules

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/modules
  • Auth
    HTTP bearer

Request body

includedobject[]
metaobject

Response

Successfully created module.

includedobject[]
metaobject

Changes