Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Codification

Create a module call

Create a module call using the provided resource along with its dependencies

post/api/codify/module

Request body

assetIdstring required

The id of the resource to be codified using module call

assetTypestring required

The Terraform asset type (e.g. aws_s3_bucket)

format'HCL' | 'YAML' | 'JSON' | 'TFVARS' | 'TFVARS_JSON' | 'TERRAGRUNT'

The format of the codified result (e.g. terraform, json)

moduleMD5string required

The MD5 hash of the module path

repoProtocol'ssh' | 'https'

The protocol to reach the module's repository

provider'akamai' | 'aws' | 'azurerm' | 'cloudflare' | 'datadog' | 'gcp' | 'github' | 'mongodbatlas' | 'newrelic' | 'ns1' | 'oci' | 'pagerduty' | 'vault' required

The provider of the resource type

providerIdstring required

The Firefly integration ID where the resource is located

sourceType'private' | 'public' required

The source type of the module (e.g. private, public)

withAiboolean

Whether to use AI to codify the module

Response

Successful module call

Filesobject

Map of file paths to their contents

CodifiedMismatchesstring[]

List of asset types that could not be codified

ModuleMismatchesstring[]

Asset types present in the module that are not part of the original request

TerraformCMDsstring[]

Terraform commands to import the generated module

TerraformImportBlocksstring[]

Terraform import blocks

HasUnknownModulesboolean

Whether the module has unknown modules

ModuleCallGapsstring[]

Potential issues with existing module call considering input and output

Format'HCL' | 'YAML' | 'JSON' | 'TFVARS' | 'TFVARS_JSON' | 'TERRAGRUNT'

The format of the codified result based on the request