Codification

The Codification API allows you to generate Infrastructure as Code (Terraform HCL) for cloud assets programmatically.

Codify Asset

Codify a single cloud asset to Infrastructure as Code

post

Generate IaC code (Terraform HCL) for a specific cloud asset

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

assetTypestringRequired

The Terraform asset type (e.g., aws_s3_bucket)

assetIdstringRequired

The unique identifier of the cloud asset (e.g., ARN)

iacTypestring · enumRequired

The Infrastructure as Code type

Possible values:

providerstringRequired

The cloud provider (e.g., aws, azure, gcp)

accountNumberstringRequired

The cloud account number/ID

ignoreEscapingbooleanOptional

If true, returns raw HCL without escaping newlines

Default: false

Responses

200

Successfully codified asset

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify

HTTPcURLJavaScriptPython

POST /v2/api/codify HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "assetType": "text",
  "assetId": "text",
  "iacType": "terraform",
  "provider": "text",
  "accountNumber": "text",
  "ignoreEscaping": false
}

{
  "codifiedResult": "text",
  "importBlocks": "text",
  "importCommand": "text",
  "providerBlock": "text"
}

List Module Repositories

Fetches repositories

get

Fetches repositories that contain terraform modules

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

resourceTypesstring[]Required

Responses

200

Successfully retrieved module repos

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/api/codify/repos

HTTPcURLJavaScriptPython

GET /v2/api/codify/repos?resourceTypes=text HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "key": {
      "repoFullName": "text",
      "vcsType": "text",
      "isPublic": true
    },
    "doc_count": 1
  }
]

List Modules

Fetches modules from a given repository

get

Fetches modules available in a repository

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

repositorystringRequired

Full repository path (e.g., owner/name/subdirectory)

resourceTypesstring[]Required

List of resource types to filter modules by, separated by commas

Responses

200

Successfully fetched modules

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/api/codify/repos/modules

HTTPcURLJavaScriptPython

GET /v2/api/codify/repos/modules?repository=text&resourceTypes=text HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "moduleSourceType": "text",
    "moduleName": "text",
    "moduleFullPathMD5": "text",
    "moduleResourceTypes": [
      "text"
    ],
    "missingAssetTypes": true
  }
]

Codify Module

Create a module call

post

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

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

assetIdstringRequired

The id of the resource to be codified using module call

assetTypestringRequired

The Terraform asset type (e.g. aws_s3_bucket)

formatstring · enumOptional

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

Default: HCLPossible values:

moduleMD5stringRequired

The MD5 hash of the module path

repoProtocolstring · enumOptional

The protocol to reach the module's repository

Default: sshPossible values:

providerstring · enumRequired

The provider of the resource type

Possible values:

providerIdstringRequired

The Firefly integration ID where the resource is located

sourceTypestring · enumRequired

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

Possible values:

withAibooleanOptional

Whether to use AI to codify the module

Default: true

Responses

200

Successful module call

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/module

HTTPcURLJavaScriptPython

POST /v2/api/codify/module HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "assetId": "text",
  "assetType": "text",
  "format": "HCL",
  "moduleMD5": "text",
  "repoProtocol": "ssh",
  "provider": "akamai",
  "providerId": "text",
  "sourceType": "private",
  "withAi": true
}

{
  "Files": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "CodifiedMismatches": [
    "text"
  ],
  "ModuleMismatches": [
    "text"
  ],
  "TerraformCMDs": [
    "text"
  ],
  "TerraformImportBlocks": [
    "text"
  ],
  "HasUnknownModules": true,
  "ModuleCallGaps": [
    "text"
  ],
  "Format": "HCL"
}

Create Module

Create a new module

post

Create a new module using the provided resource

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

assetIdstringRequired

The id of the resource to be codified using create module

assetTypestringRequired

The Terraform asset type (e.g. aws_s3_bucket)

providerstring · enumRequired

The provider of the resource type

Possible values:

providerIdstringRequired

The Firefly integration ID where the resource is located

tfVersionstringOptional

The Terraform version to use from the specified provider

withAibooleanOptional

Whether to use AI to create the module

Default: true

withDependenciesbooleanOptional

Whether to include dependencies in the module (only available when withAi is true)

Default: false

Responses

200

Successfully created module

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/module/create

HTTPcURLJavaScriptPython

POST /v2/api/codify/module/create HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "assetId": "text",
  "assetType": "text",
  "provider": "akamai",
  "providerId": "text",
  "tfVersion": "text",
  "withAi": true,
  "withDependencies": false
}

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Create Pull Request

Create a pull request with codified assets

post

Creates a pull request containing Infrastructure as Code for specified cloud resources

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

vcsIdstringRequired

VCS integration ID

repositorystringRequired

Repository full name (e.g., org/repo)

iacTypestring · enumRequired

Infrastructure as Code type

Possible values:

prCommentstringOptional

Comment to include in the pull request description

fileNamestringOptional

File path for the codified output

selectedBranchstringOptional

Target branch name (defaults to main/master)

Responses

200

Successfully created pull request

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/pullRequest

HTTPcURLJavaScriptPython

POST /v2/api/codify/pullRequest HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 519

{
  "vcsId": "text",
  "repository": "text",
  "iacType": "terraform",
  "resources": [
    {
      "assetType": "text",
      "assetId": "text",
      "providerId": "text",
      "provider": "text",
      "revisionId": "text",
      "isDeleted": true,
      "frn": "text"
    }
  ],
  "codificationData": {
    "codificationMode": "text",
    "preparedContent": [
      {
        "filePath": "text",
        "content": "text"
      }
    ],
    "selectedModule": "text",
    "fileExtension": "tf",
    "codifyType": "text",
    "commitDetails": "text",
    "language": "hcl",
    "withImportBlocks": false,
    "withProviderBlock": false
  },
  "prComment": "text",
  "fileName": "text",
  "selectedBranch": "text"
}

{
  "ok": true,
  "url": "text",
  "branchName": "text"
}

List Module Repositories

Fetches repositories

get

Fetches repositories that contain terraform modules

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

resourceTypesstring[]Required

Responses

200

Successfully retrieved module repos

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/api/codify/repos

HTTPcURLJavaScriptPython

GET /v2/api/codify/repos?resourceTypes=text HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "key": {
      "repoFullName": "text",
      "vcsType": "text",
      "isPublic": true
    },
    "doc_count": 1
  }
]

List Modules

Fetches modules from a given repository

get

Fetches modules available in a repository

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

repositorystringRequired

Full repository path (e.g., owner/name/subdirectory)

resourceTypesstring[]Required

List of resource types to filter modules by, separated by commas

Responses

200

Successfully fetched modules

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/api/codify/repos/modules

HTTPcURLJavaScriptPython

GET /v2/api/codify/repos/modules?repository=text&resourceTypes=text HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "moduleSourceType": "text",
    "moduleName": "text",
    "moduleFullPathMD5": "text",
    "moduleResourceTypes": [
      "text"
    ],
    "missingAssetTypes": true
  }
]

Codify Module

Create a module call

post

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

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

assetIdstringRequired

The id of the resource to be codified using module call

assetTypestringRequired

The Terraform asset type (e.g. aws_s3_bucket)

formatstring · enumOptional

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

Default: HCLPossible values:

moduleMD5stringRequired

The MD5 hash of the module path

repoProtocolstring · enumOptional

The protocol to reach the module's repository

Default: sshPossible values:

providerstring · enumRequired

The provider of the resource type

Possible values:

providerIdstringRequired

The Firefly integration ID where the resource is located

sourceTypestring · enumRequired

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

Possible values:

withAibooleanOptional

Whether to use AI to codify the module

Default: true

Responses

200

Successful module call

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/module

HTTPcURLJavaScriptPython

POST /v2/api/codify/module HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "assetId": "text",
  "assetType": "text",
  "format": "HCL",
  "moduleMD5": "text",
  "repoProtocol": "ssh",
  "provider": "akamai",
  "providerId": "text",
  "sourceType": "private",
  "withAi": true
}

{
  "Files": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "CodifiedMismatches": [
    "text"
  ],
  "ModuleMismatches": [
    "text"
  ],
  "TerraformCMDs": [
    "text"
  ],
  "TerraformImportBlocks": [
    "text"
  ],
  "HasUnknownModules": true,
  "ModuleCallGaps": [
    "text"
  ],
  "Format": "HCL"
}

Create Module

Create a new module

post

Create a new module using the provided resource

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

assetIdstringRequired

The id of the resource to be codified using create module

assetTypestringRequired

The Terraform asset type (e.g. aws_s3_bucket)

providerstring · enumRequired

The provider of the resource type

Possible values:

providerIdstringRequired

The Firefly integration ID where the resource is located

tfVersionstringOptional

The Terraform version to use from the specified provider

withAibooleanOptional

Whether to use AI to create the module

Default: true

withDependenciesbooleanOptional

Whether to include dependencies in the module (only available when withAi is true)

Default: false

Responses

200

Successfully created module

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/module/create

HTTPcURLJavaScriptPython

POST /v2/api/codify/module/create HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "assetId": "text",
  "assetType": "text",
  "provider": "akamai",
  "providerId": "text",
  "tfVersion": "text",
  "withAi": true,
  "withDependencies": false
}

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Create Pull Request

Create a pull request with codified assets

post

Creates a pull request containing Infrastructure as Code for specified cloud resources

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

vcsIdstringRequired

VCS integration ID

repositorystringRequired

Repository full name (e.g., org/repo)

iacTypestring · enumRequired

Infrastructure as Code type

Possible values:

prCommentstringOptional

Comment to include in the pull request description

fileNamestringOptional

File path for the codified output

selectedBranchstringOptional

Target branch name (defaults to main/master)

Responses

200

Successfully created pull request

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/api/codify/pullRequest

HTTPcURLJavaScriptPython

POST /v2/api/codify/pullRequest HTTP/1.1
Host: api.firefly.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 519

{
  "vcsId": "text",
  "repository": "text",
  "iacType": "terraform",
  "resources": [
    {
      "assetType": "text",
      "assetId": "text",
      "providerId": "text",
      "provider": "text",
      "revisionId": "text",
      "isDeleted": true,
      "frn": "text"
    }
  ],
  "codificationData": {
    "codificationMode": "text",
    "preparedContent": [
      {
        "filePath": "text",
        "content": "text"
      }
    ],
    "selectedModule": "text",
    "fileExtension": "tf",
    "codifyType": "text",
    "commitDetails": "text",
    "language": "hcl",
    "withImportBlocks": false,
    "withProviderBlock": false
  },
  "prComment": "text",
  "fileName": "text",
  "selectedBranch": "text"
}

{
  "ok": true,
  "url": "text",
  "branchName": "text"
}