Publish a Module

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
data
object

A terraform module in the Private Module Registry.

Responses

403

User unauthorized to perform action.

404

Relationship resource not found, or user unauthorized to perform action.

422

Malformed request body (missing attributes, wrong types, etc.).

4XX

Client error.

5XX

Server error.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json