Rescue

post

Refactor Terraform codebase by extracting variables from resources and modules to separated files

🔒 Requires the read:rescue permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

terraformstring · binaryRequiredExample: terraform=@terraform.zip

iac_typestring · enumOptional

The type of IaC source

Default: terraformPossible values:

Responses

200

Zip archive of refactored data

application/zip

string · binaryOptional

400

Failed to refactor terraform

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:rescue permission

application/json

429

Too many requests

application/json

post

/api/v1/rescue/tf/extract

HTTPcURLJavaScriptPython

POST /api/v1/rescue/tf/extract HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 63

{
  "terraform": "terraform=@terraform.zip",
  "iac_type": "terraform"
}

binary

post

Generate bricks file template from IaC source

🔒 Requires the read:rescue permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

sourcestringRequired

The path to the IaC source directory

package_namestringRequired

The package name e.g. @bluebricks/aws-vpc

iac_typestring · enumRequired

The type of IaC source

Possible values:

Responses

200

Generated bricks file template

application/json

Generated bricks file template

namestringRequiredExample: @bluebricks/aws-vpc

descriptionstringOptionalExample: A package for blueprinting a secure VPC

versionstringRequiredExample: 1.2.3Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

tagsstring[]OptionalExample: my-tag

costnumberOptional

Declared cost of the package

Example: 500

manifest_versionnumberOptional

The version of the bricks manifest

Example: 1

statestring · enumOptionalPossible values:

sourcestringOptionalExample: git::https://github.com/bb/vpc.git

400

IaC source directory or package name are invalid

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:rescue permission

application/json

429

Too many requests

application/json

post

/api/v1/rescue

HTTPcURLJavaScriptPython

POST /api/v1/rescue HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "source": "text",
  "package_name": "text",
  "iac_type": "terraform"
}

{
  "name": "@bluebricks/aws-vpc",
  "description": "A package for blueprinting a secure VPC",
  "version": "1.2.3",
  "tags": [
    "my-tag"
  ],
  "cost": 500,
  "manifest_version": 1,
  "state": "managed",
  "repository": {
    "type": "git",
    "url": "https://github.com/bluebricks/aws-vpc.git"
  },
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "description": "The name of the VPC",
      "default": "my-vpc",
      "value": "my-vpc1",
      "allowed_values": [
        "my-vpc"
      ],
      "sensitive": true
    }
  },
  "outs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "description": "The VPC ID",
      "value": "my-vpc123",
      "sensitive": true
    }
  },
  "packages": [
    {
      "id": "s3",
      "name": "terraform-aws-s3",
      "description": "A package for managing S3 buckets",
      "version": "1.2.3",
      "props": {
        "region": {
          "value": "'us-west-2'"
        },
        "vpc_id": {
          "value": "Props.vpc_id ?? Data.vpc1.vpc_id"
        }
      },
      "path": "https://github.com/bb/vpc.git",
      "kind": "terraform",
      "source": "git::https://github.com/bb/vpc.git",
      "native": {
        "type": "terraform",
        "version": "text",
        "path": "text",
        "state_path": "text"
      }
    }
  ],
  "source": "git::https://github.com/bb/vpc.git",
  "native": {
    "type": "terraform",
    "version": "text",
    "path": "text",
    "state_path": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}