Package

get

Get extended package details

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

namestringRequired

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

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

returnSlimbooleanOptional

Return slim version of bricks.json if exists

Default: false

Responses

200

Package info and bricks.json content

application/json

Package info and bricks.json content

400

Failed to fetch package information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/package

GET /api/v1/package?name=%40bluebricks%2Faws-vpc HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "package_info": {
    "name": "@bluebricks/aws-vpc",
    "version": "1.2.3",
    "url": "https://url.to.git.repo",
    "created": "2026-03-03T04:32:39.943Z",
    "updated": null,
    "is_latest": true,
    "enabler_email": "[email protected]",
    "verified_at": "2021-08-17T10:00:00Z",
    "description": "A package for blueprinting a VPC",
    "type": "blueprint",
    "iac_type": [
      "terraform"
    ],
    "tags": [
      "my-tag"
    ],
    "cost": 500,
    "is_pre_release": true,
    "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
    "git_short_sha": "a1b2c3d4",
    "git_remote_url": "https://github.com/username/repository.git",
    "git_branch": "main",
    "git_subdir_path": "path/to/subdirectory",
    "owner": "[email protected]",
    "published_by": {
      "id": "prov0|1234567890",
      "name": "John Doe",
      "email": "[email protected]",
      "picture": "https://example.com/profile.jpg"
    },
    "organization": "org_abCdeFghIjklMnmP",
    "publisherJobId": "123e4567-e89b-12d3-a456-42661417400",
    "id": "pkg_12345",
    "enabled": true
  },
  "config": {
    "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"
    }
  },
  "slim_config": {
    "name": "eks_redis",
    "version": "1.0.0",
    "description": "A package for blueprinting a secure VPC",
    "cost": 500,
    "tags": [
      "my-tag"
    ],
    "inputs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "default": "us-west-2",
        "type": "string",
        "description": "AWS region to deploy into",
        "allowed_values": [
          "my-vpc"
        ],
        "sensitive": true
      }
    },
    "packages": [
      {
        "id": "main_s3_bucket",
        "name": "eks_auto_mode",
        "description": "A package for managing S3 buckets",
        "version": "1.0.0+abcdef",
        "props": {
          "ANY_ADDITIONAL_PROPERTY": "${data.eks_auto_mode.cluster_id}"
        },
        "source": "git::https://github.com/bb/vpc.git",
        "native": {
          "type": "terraform",
          "version": "text",
          "path": "text",
          "state_path": "text"
        }
      }
    ],
    "outputs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "value": "${data.eks_auto_mode.cluster_id}",
        "description": "The EKS cluster ID"
      }
    }
  },
  "package_children": [
    {
      "name": "@bluebricks/aws-vpc",
      "version": "1.2.3",
      "url": "https://url.to.git.repo",
      "created": "2026-03-03T04:32:39.943Z",
      "updated": null,
      "is_latest": true,
      "enabler_email": "[email protected]",
      "verified_at": "2021-08-17T10:00:00Z",
      "description": "A package for blueprinting a VPC",
      "type": "blueprint",
      "iac_type": [
        "terraform"
      ],
      "tags": [
        "my-tag"
      ],
      "cost": 500,
      "is_pre_release": true,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory",
      "owner": "[email protected]",
      "published_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "email": "[email protected]",
        "picture": "https://example.com/profile.jpg"
      },
      "organization": "org_abCdeFghIjklMnmP",
      "publisherJobId": "123e4567-e89b-12d3-a456-42661417400",
      "id": "pkg_12345",
      "enabled": true
    }
  ]
}

post

Publish a bricks.json-based blueprint to the package registry. Supports both traditional bricks.json format and new slim bricks.yaml format. The package will be uploaded to the provided namespace.

If no namespace is provided, it will be uploaded to the organization namespace by default. This ensures that packages are properly organized and accessible within the appropriate scope.

Supported formats:

bricks.json: Traditional full-format blueprint
bricks.json (slim): Slim format in JSON (automatically converted to "traditional" format)
bricks.yaml / bricks.yml: YAML declarative format (automatically converted to "traditional" format)

🔒 Requires the create:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

bricksstring · binaryRequired

The blueprint configuration file. Supports bricks.json ("traditional" and "slim" version), bricks.yaml

slimBricksbooleanOptional

Set to true if the provided bricks file is in slim format (YAML or JSON). If false or not provided, the file is expected to be in traditional bricks.json format

Default: false

packagestring · binaryOptional

The package content, zipped (required only for native packages)

statebooleanOptional

Whether the package includes initial state, e.g. true

Default: false

gitCommitHashstringOptional

The git commit hash of the package source

Example: 8f63e821f0df35c1f0c354c2ce15d5f8a65a6039

gitRemoteUrlstringOptional

The git remote url of the package repository

Example: https://github.com/username/repository.git

gitBranchstringOptional

The git branch name the package was created from

Example: main

gitSubdirPathstringOptional

The git subdirectory path of the package repository

Example: path/to/subdirectory

artifactHashstringOptional

SHA-256 hash of the artifact files for collision validation purposes (relevant only for packages of type artifact)

Example: ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015adPattern: ^[a-fA-F0-9]{64}$

bricksRawSlimstring · binaryOptional

Optional original slim bricks file provided during CLI publishing

eventIdstringOptional

The ID of the event triggering the publish

Responses

200

Information about published package

application/json

Information about published package

namestringRequired

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

Example: @bluebricks/aws-vpc

versionstringRequired

The package version e.g. 1.2.3

Example: 1.2.3

urlstring · nullableOptionalExample: https://url.to.git.repo

createdstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

updatedstring · nullableOptional

The date and time the resource was updated e.g. 2022-01-01T00:00:00.000Z

is_latestbooleanOptional

enabler_emailstringOptional

The user's email address

Example: [email protected]

verified_atstring · nullableOptionalExample: 2021-08-17T10:00:00Z

descriptionstring · nullableOptionalExample: A package for blueprinting a VPC

typestring · enumRequiredExample: blueprintPossible values:

iac_typeone ofRequired

string · enumOptionalExample: terraformPossible values:

tagsstring[]Required

The tag name e.g. my-tag

Example: my-tag

costnumberOptional

Declared cost of the package

Example: 500

is_pre_releasebooleanRequired

Is this a pre-release version of the package

Example: true

git_commit_hashstringOptional

The git commit hash of the package source

Example: 8f63e821f0df35c1f0c354c2ce15d5f8a65a6039

git_short_shastringOptional

The git short SHA of the package source

Example: a1b2c3d4

git_remote_urlstringOptional

The git remote url of the package repository

Example: https://github.com/username/repository.git

git_branchstringOptional

The git branch name the package was created from

Example: main

git_subdir_pathstringOptional

The git subdirectory path of the package repository

Example: path/to/subdirectory

ownerstringRequired

The user's email address

Example: [email protected]

organizationstringRequired

The organization ID

Example: org_abCdeFghIjklMnmP

publisherJobIdstring · uuidOptional

Unique identifier for the publisher status stream job

Example: 123e4567-e89b-12d3-a456-42661417400

400

Failed to publish package

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:package permission

application/json

404

Child package not found

application/json

409

Package or version already exists or namespace is taken

application/json

429

Too many requests

application/json

500

Failed to publish package due to an internal error

application/json

post

/api/v1/package

POST /api/v1/package HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 372

{
  "bricks": "binary",
  "slimBricks": false,
  "package": "binary",
  "state": false,
  "gitCommitHash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
  "gitRemoteUrl": "https://github.com/username/repository.git",
  "gitBranch": "main",
  "gitSubdirPath": "path/to/subdirectory",
  "artifactHash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
  "bricksRawSlim": "binary",
  "eventId": "text"
}

{
  "name": "@bluebricks/aws-vpc",
  "version": "1.2.3",
  "url": "https://url.to.git.repo",
  "created": "2026-03-03T04:32:39.943Z",
  "updated": null,
  "is_latest": true,
  "enabler_email": "[email protected]",
  "verified_at": "2021-08-17T10:00:00Z",
  "description": "A package for blueprinting a VPC",
  "type": "blueprint",
  "iac_type": [
    "terraform"
  ],
  "tags": [
    "my-tag"
  ],
  "cost": 500,
  "is_pre_release": true,
  "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
  "git_short_sha": "a1b2c3d4",
  "git_remote_url": "https://github.com/username/repository.git",
  "git_branch": "main",
  "git_subdir_path": "path/to/subdirectory",
  "owner": "[email protected]",
  "published_by": {
    "id": "prov0|1234567890",
    "name": "John Doe",
    "email": "[email protected]",
    "picture": "https://example.com/profile.jpg"
  },
  "organization": "org_abCdeFghIjklMnmP",
  "publisherJobId": "123e4567-e89b-12d3-a456-42661417400"
}

get

List the available versions of a package

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

packagestringRequired

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

Example: @bluebricks/aws-vpc

include_disabledbooleanOptionalDefault: false

Responses

200

Package info and list of versions

application/json

Package info and list of versions

400

Failed to fetch package version information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/package/versions

GET /api/v1/package/versions?package=%40bluebricks%2Faws-vpc HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "package_info": {
    "name": "@bluebricks/aws-vpc",
    "version": "1.2.3",
    "url": "https://url.to.git.repo",
    "created": "2026-03-03T04:32:39.943Z",
    "updated": null,
    "is_latest": true,
    "enabler_email": "[email protected]",
    "verified_at": "2021-08-17T10:00:00Z",
    "description": "A package for blueprinting a VPC",
    "type": "blueprint",
    "iac_type": [
      "terraform"
    ],
    "tags": [
      "my-tag"
    ],
    "cost": 500,
    "is_pre_release": true,
    "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
    "git_short_sha": "a1b2c3d4",
    "git_remote_url": "https://github.com/username/repository.git",
    "git_branch": "main",
    "git_subdir_path": "path/to/subdirectory",
    "owner": "[email protected]",
    "published_by": {
      "id": "prov0|1234567890",
      "name": "John Doe",
      "email": "[email protected]",
      "picture": "https://example.com/profile.jpg"
    },
    "organization": "org_abCdeFghIjklMnmP",
    "publisherJobId": "123e4567-e89b-12d3-a456-42661417400"
  },
  "versions": [
    {
      "version": "1.2.3",
      "is_pre_release": true,
      "is_latest": true,
      "iac_type": [
        "terraform"
      ],
      "tags": [
        "my-tag"
      ],
      "created": "2026-03-03T04:32:39.943Z",
      "description": null,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory",
      "enabled": true
    }
  ]
}

get

Get the last message from a publisher status stream by job ID. Returns the latest status update including progress, message, and status information.

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdstring · uuidRequired

Unique identifier for the publisher status stream job

Example: 123e4567-e89b-12d3-a456-42661417400

Responses

200

Last message from the publisher stream

application/json

Last message from the publisher stream

messageIdstringRequired

Stream message ID

Example: 1234567890123-0

400

Bad request

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Redis stream not found

application/json

429

Too many requests

application/json

500

Failed to get message from Redis stream

application/json

get

/api/v1/package/stream/{jobId}

GET /api/v1/package/stream/{jobId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "messageId": "1234567890123-0",
  "data": {
    "progress": 50,
    "event_type": "manual_hydration",
    "package_name": "@bluebricks/aws-vpc",
    "package_version": "1.2.3",
    "status": "processing",
    "error": false,
    "message": "Processing package...",
    "org_id": "org_abCdeFghIjklMnmP"
  }
}

post

Search through published packages

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10

orderstringOptional

Specifies the order - ascending or descending - by which the returned list should be sorted e.g. ASC

limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 10Example: 10

querystringRequired

Search query e.g. blue*, *blue

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted

Possible values:

Responses

200

List of packages matching the query

application/json

List of packages matching the query

resultsnumberRequired

totalnumberRequired

400

Failed to search through packages

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Author of package not found

application/json

429

Too many requests

application/json

post

/api/v1/package/search

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

{
  "offset": 10,
  "order": "text",
  "limit": 10,
  "query": "text",
  "sort": "created"
}

{
  "packages": [
    {
      "name": "@bluebricks/aws-vpc",
      "version": "1.2.3",
      "url": "https://url.to.git.repo",
      "created": "2026-03-03T04:32:39.943Z",
      "updated": null,
      "is_latest": true,
      "enabler_email": "[email protected]",
      "verified_at": "2021-08-17T10:00:00Z",
      "description": "A package for blueprinting a VPC",
      "type": "blueprint",
      "iac_type": [
        "terraform"
      ],
      "tags": [
        "my-tag"
      ],
      "cost": 500,
      "is_pre_release": true,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory",
      "owner": "[email protected]",
      "published_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "email": "[email protected]",
        "picture": "https://example.com/profile.jpg"
      },
      "organization": "org_abCdeFghIjklMnmP",
      "publisherJobId": "123e4567-e89b-12d3-a456-42661417400",
      "id": "pkg_12345",
      "enabled": true
    }
  ],
  "results": 1,
  "total": 1
}

get

Return package filters

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Package filters

application/json

Package filters

400

Bad request

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

429

Too many requests

application/json

500

Failed to get package filters

application/json

get

/api/v1/package/filters

GET /api/v1/package/filters HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "package_filters": {
    "artifacts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "iac_type": "TERRAFORM",
        "tags": [
          "text"
        ]
      }
    ],
    "technologies": [
      "terraform"
    ],
    "tags": {
      "artifact": [
        "text"
      ],
      "blueprint": [
        "text"
      ]
    }
  }
}

get

Provide the status of a specific package for the account. Mostly used to indicate if package is already enabled for an account

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

packagestringRequired

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

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

include_pre_releasebooleanOptional

Include pre-release versions

Responses

200

List of enabled versions of a package

application/json

List of enabled versions of a package

namestringRequired

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

Example: @bluebricks/aws-vpc

versionstringRequired

The package version e.g. 1.2.3

Example: 1.2.3

is_pre_releasebooleanRequired

Is this a pre-release version of the package

Example: true

createdstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

enablerstringRequired

400

Failed to get enabled package versions list

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/package/status

GET /api/v1/package/status?package=%40bluebricks%2Faws-vpc HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "@bluebricks/aws-vpc",
    "version": "1.2.3",
    "is_pre_release": true,
    "created": "2026-03-03T04:32:39.943Z",
    "enabler": "text"
  }
]

get

Validate package properties

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

packagestringRequired

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

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

validate_propsstring[]Required

List of properties to validate if they are customizable e.g. ["bucket_name.region", "vpc_id"]

Responses

200

Validation result for package properties

application/json

Validation result for package properties

statusCodenumberRequiredExample: 200

errorstringOptional

messagestringRequiredExample: All provided properties are customizable for the package '@bluebricks/aws-vpc

400

Failed to validate package properties

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/package/validation/customizable

GET /api/v1/package/validation/customizable?package=%40bluebricks%2Faws-vpc&validate_props=text HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200,
  "error": "text",
  "message": "All provided properties are customizable for the package '@bluebricks/aws-vpc",
  "details": {
    "package": "@bluebricks/aws-vpc",
    "version": "1.2.3",
    "suggestion": "You can proceed with customizing the provided properties"
  }
}

post

Enable package version/s within the org

🔒 Requires the update:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

packagestringRequired

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

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

Responses

200

Package version/s enabled

application/json

Package version/s enabled

enabledboolean · enumRequiredPossible values:

versionsstring[]Required

List of enabled package versions

Example: 1.2.3

400

Failed to enable package version/s

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

post

/api/v1/package/enable

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

{
  "package": "@bluebricks/aws-vpc",
  "version": "1.2.3"
}

{
  "enabled": true,
  "versions": [
    "1.2.3"
  ]
}

post

Disable package version/s within the org

🔒 Requires the update:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

packagestringRequired

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

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

Responses

200

Package version/s disabled

application/json

Package version/s disabled

enabledboolean · enumRequiredPossible values:

versionsstring[]Required

List of disabled package versions

Example: 1.2.3

400

Failed to disable package version/s

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

post

/api/v1/package/disable

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

{
  "package": "@bluebricks/aws-vpc",
  "version": "1.2.3"
}

{
  "enabled": false,
  "versions": [
    "1.2.3"
  ]
}

post

Install package on remote cloud

🔒 Requires the create:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

validate_onlybooleanOptional

Validate package for installation without execution

Default: false

Body

packagestringRequired

The package name, e.g. @bluebricks/postgres. Optional if planId is provided

Example: @bluebricks/aws-vpc

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

deployTypestring · enumOptional

The deployment type

Example: autoApprovePossible values:

forcebooleanOptional

Force installation without approval

planOnlybooleanOptional

Plan the installation/uninstall without executing

Default: false

incrementalbooleanOptional

Enable incremental mode to skip deployments with no changes

Default: false

driftDetectionbooleanOptional

Execute drift detection for the deployment

Default: false

isDriftDetectionEnabledbooleanOptional

Enable drift detection for the environment

Default: false

envstringOptionalDeprecated

DEPRECATED: Use collection instead. Target environment for installation

collectionstringOptional

Target collection for installation

slugstringOptional

Provides a slug for a newly created environment. Cannot be specified together with environmentSlug or runId

deploymentstringOptionalDeprecated

DEPRECATED: Use environmentSlug or runId instead. Identify a previous environment using its ID or slug e.g. postgres-prod or 5ecbb18d-04c7-4298-b550-ab12bf661477

environmentSlugstringOptional

Identify a previous environment by its slug e.g. postgres-prod

runIdstring · uuidOptional

Identify a previous environment by its run ID (UUID) e.g. 5ecbb18d-04c7-4298-b550-ab12bf661477

Responses

200

Created task id for installation process or validate installation

application/json

Created task id for installation process or validate installation

400

Failed to start installation

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:environment permission

application/json

404

Package not found or not enabled for organization

application/json

409

Environment slug already exists

application/json

429

Too many requests

application/json

500

Failed to start installation

application/json

post

/api/v1/package/install

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

{
  "package": "@bluebricks/aws-vpc",
  "version": "1.2.3",
  "deployType": "autoApprove",
  "force": true,
  "planOnly": false,
  "incremental": false,
  "driftDetection": false,
  "isDriftDetectionEnabled": false,
  "collection": "text",
  "slug": "text",
  "props": {
    "password": "$postgres.prodPass"
  },
  "environmentSlug": "text",
  "runId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "deployment": "123e4567-e89b-12d3-a456-426614174000",
  "task": "123e4567-e89b-12d3-a456-426614174000"
}

post

Uninstall package from cloud

🔒 Requires the create:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

anyOptional

Responses

200

Created task id for uninstall process

application/json

Created task id for uninstall process

deploymentstring · uuidRequired

The deployment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e

taskstring · uuidRequired

The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e

400

Failed to start uninstall process

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:environment permission

application/json

404

Package not found or not enabled for organization

application/json

429

Too many requests

application/json

post

/api/v1/package/uninstall

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

{
  "deployType": "autoApply",
  "environmentSlug": "text",
  "runId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "deployment": "123e4567-e89b-12d3-a456-426614174000",
  "task": "123e4567-e89b-12d3-a456-426614174000"
}

get

Load package by name and version

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

packageNamestringRequired

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

Example: @bluebricks/aws-vpc

versionstringRequired

The package version e.g. 1.2.3

Example: 1.2.3

Responses

200

Presigned URL for package download

application/json

Presigned URL for package download

urlstring · uriRequired

Presigned URL for package download

400

Failed to generate presigned url to download package

application/json

401

Failed to authenticate user or runtime

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/package/{packageName}/{version}

GET /api/v1/package/{packageName}/{version} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://example.com"
}

get

Get package properties with their values, sources, and metadata for a specific deployment context

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

packageNamestringOptional

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

Example: @bluebricks/aws-vpc

packageVersionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

environmentSlugstringOptionalDeprecated

The environment slug e.g. production-europe

Example: production-europe

collectionSlugstringOptional

The collection slug e.g. production-europe

Example: production-europe

deploymentIdOrSlugstringOptional

The deployment's ID or environment's slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-deployment

Responses

200

Package properties with their metadata

application/json

Package properties with their metadata

400

Invalid request parameters

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

Package, collection, or deployment not found

application/json

429

Too many requests

application/json

500

Failed to retrieve package properties

application/json

get

/api/v1/package/props

GET /api/v1/package/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text",
      "default": "text",
      "valueFromCollection": "text",
      "type": "text",
      "originalType": "text",
      "required": true,
      "customizable": true,
      "valueSource": "text",
      "allowedValues": [
        "text"
      ],
      "description": "text",
      "sensitive": true
    }
  }
}

get

List packages used by organization

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

allbooleanOptional

When true, returns all packages including those that were already deployed. When false, returns only not-deployed packages.

latestbooleanOptional

When true, returns only the latest version for each package

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted e.g. name

Default: createdPossible values:

offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10

orderstringOptional

Specifies the order - ascending or descending - by which the returned list should be sorted e.g. ASC

limitnumber · min: 3 · max: 1000Optional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10

filterstringOptional

Structure: [key1=value1,key2=value2&value3]

searchstringOptional

Enables searching within the list for package names that match a particular query e.g. sns

Responses

200

List of organization packages

application/json

List of organization packages

totalnumberRequired

publishednumberRequired

draftsnumberRequired

400

Failed to list organization packages

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

404

User / Organization not found

application/json

429

Too many requests

application/json

get

/api/v1/packages

GET /api/v1/packages HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "packages": [
    {
      "name": "@bluebricks/aws-vpc",
      "version": "1.2.3",
      "url": "https://url.to.git.repo",
      "created": "2026-03-03T04:32:39.943Z",
      "updated": null,
      "is_latest": true,
      "enabler_email": "[email protected]",
      "verified_at": "2021-08-17T10:00:00Z",
      "description": "A package for blueprinting a VPC",
      "type": "blueprint",
      "iac_type": [
        "terraform"
      ],
      "tags": [
        "my-tag"
      ],
      "cost": 500,
      "is_pre_release": true,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory",
      "owner": "[email protected]",
      "published_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "email": "[email protected]",
        "picture": "https://example.com/profile.jpg"
      },
      "organization": "org_abCdeFghIjklMnmP",
      "publisherJobId": "123e4567-e89b-12d3-a456-42661417400",
      "environments": 3,
      "active_git_trigger": {
        "id": "123e4567-e89b-12d3-a456-42661417400",
        "git_ref": "main",
        "path": "path/to/subdirectory",
        "repo": "organization/repository"
      },
      "blueprint_metadata": {
        "downloaded_by": "text",
        "downloaded_at": null,
        "cost": 500
      },
      "allowed_versions": [
        "text"
      ]
    }
  ],
  "total": 1,
  "published": 1,
  "drafts": 1
}

post

Compare package file hashes to identify changed packages

🔒 Requires the read:package permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Comparison result with changed and unchanged packages

application/json

Comparison result with changed and unchanged packages

totalnumberOptional

400

Failed to compare package changes

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:package permission

application/json

429

Too many requests

application/json

post

/api/v1/package-changes

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

{
  "packages": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "version": "1.2.3",
        "hash": "text"
      }
    ]
  }
}

{
  "changed": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "@bluebricks/aws-vpc",
      "version": "1.2.3",
      "hash": "text",
      "previous_hash": null,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory"
    }
  ],
  "unchanged": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "@bluebricks/aws-vpc",
      "version": "1.2.3",
      "hash": "text",
      "previous_hash": null,
      "git_commit_hash": "8f63e821f0df35c1f0c354c2ce15d5f8a65a6039",
      "git_short_sha": "a1b2c3d4",
      "git_remote_url": "https://github.com/username/repository.git",
      "git_branch": "main",
      "git_subdir_path": "path/to/subdirectory"
    }
  ],
  "total": 1
}

PreviousOrganization NextRescue

Last updated 2 months ago

Was this helpful?