Deployments

post

Create a new deployment or start run for existing deployment

🔒 Requires the create:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

deploymentSlugstringRequired

The deployment slug for creating or targeting existing deployment

blueprintstringOptional

The blueprint/package name, e.g. @bluebricks/postgres

versionstringOptional

The package version e.g. 1.2.3

Example: 1.2.3

forcebooleanOptional

Force deployment without approval

validateOnlybooleanOptional

Validate deployment creation without execution

Default: false

planOnlybooleanOptional

Plan the deployment without executing

Default: false

incrementalbooleanOptional

Enable incremental mode to skip deployments with no changes

Default: false

noActivitybooleanOptional

Create deployment without starting an activity

Default: false

driftDetectionbooleanOptional

Execute drift detection for the deployment

Default: false

isDriftDetectionEnabledbooleanOptional

Enable drift detection for the deployment

Default: false

envstringOptional

Target environment for deployment

Responses

200

Created deployment and task details or validation result

application/json

Responseone of

Created deployment and task details or validation result

400

Failed to create deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:deployment permission

application/json

404

Package not found or not enabled for organization

application/json

409

Deployment slug already exists

application/json

429

Too many requests

application/json

500

Failed to create deployment

application/json

post

/api/v1/deployment/create

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

{
  "deploymentSlug": "text",
  "blueprint": "text",
  "version": "1.2.3",
  "force": true,
  "validateOnly": false,
  "planOnly": false,
  "incremental": false,
  "noActivity": false,
  "driftDetection": false,
  "isDriftDetectionEnabled": false,
  "env": "text",
  "props": {
    "password": "$postgres.prodPass"
  }
}

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

get

Return deployment information

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Query parameters

parse_typestring · enumOptional

The parsing type to fetch e.g. state

Default: planPossible values:

Responses

200

Deployment details

application/json

Responseone of

Deployment details

400

Failed to get deployment details and state

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentIdOrSlug}

GET /api/v1/deployment/{deploymentIdOrSlug} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "driftMetadata": {
    "unchanged": 1,
    "add": 1,
    "change": 1,
    "destroy": 1
  },
  "outputMetadata": {
    "unchanged": 1,
    "add": 1,
    "change": 1,
    "destroy": 1
  },
  "costMetadata": {
    "totalFrom": 1,
    "totalTo": 1,
    "totalMargin": 1,
    "packageCost": 1
  },
  "plannedResourcesMetadata": {
    "unchanged": 1,
    "add": 1,
    "change": 1,
    "destroy": 1
  },
  "stateMetadata": {
    "managed": 1,
    "unmanaged": 1
  },
  "deployment": "123e4567-e89b-12d3-a456-426614174000",
  "task": "123e4567-e89b-12d3-a456-426614174000",
  "parent": null,
  "name": "text",
  "version": "text",
  "type": "blueprint",
  "uniqueId": null,
  "stage": "pending",
  "is_archived": true,
  "created": "2026-01-10T03:42:45.481Z",
  "outdated_package": true,
  "timestamp": "2026-01-10T03:42:45.481Z",
  "errors": null,
  "plan_file_url": null,
  "state_file_url": null,
  "iac_type": "terraform",
  "parsed": {
    "type": "plan",
    "data": {
      "driftMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "outputMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "costMetadata": {
        "totalFrom": 1,
        "totalTo": 1,
        "totalMargin": 1,
        "packageCost": 1
      },
      "plannedResourcesMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "outputs": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      }
    }
  }
}

get

Return deployment properties

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

Deployment props

application/json

400

Failed to get deployment props

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentIdOrSlug}/props

GET /api/v1/deployment/{deploymentIdOrSlug}/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "activity_id": "text",
  "slug": null,
  "updated": "text",
  "package": "text",
  "version": "text",
  "env": "text",
  "props": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

Return deployment image

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdstring · uuidRequired

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

Query parameters

formatstring · enumOptional

Image format

Default: pngPossible values:

Responses

200

Deployment image

image/png

Responsestring · binary

Deployment image, describing the deployment

400

Failed to get deployment image

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentId}/image

GET /api/v1/deployment/{deploymentId}/image HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

post

Approve deployment plan

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdstring · uuidRequired

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

Responses

200

Deployment approval details

application/json

400

Failed to approve deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

500

Failed to approve deployment

application/json

post

/api/v1/deployment/{deploymentId}/approve

POST /api/v1/deployment/{deploymentId}/approve HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deployment": "123e4567-e89b-12d3-a456-426614174000",
  "parent": null,
  "type": "blueprint",
  "stage": "pending"
}

get

Get a deployment plan

🔒 Requires the read:deployment-plan permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdstring · uuidRequired

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

Query parameters

formatstring · enumOptional

Plan format

Default: jsonPossible values:

Responses

200

Plan downloaded successfully

Responsestring · binary

Deployment plan file in JSON format

400

Failed to download plan

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment-plan permission

application/json

404

Deployment plan not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentId}/plan

GET /api/v1/deployment/{deploymentId}/plan HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

post

Parse a deployment plan

🔒 Requires the read:deployment-plan permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

plan_filestring · binaryRequired

A plan file

Example: plan_file=@path/to/tfplan.json

Responses

200

Plan generated successfully

application/json

400

Failed to generate plan

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment-plan permission

application/json

429

Too many requests

application/json

post

/api/v1/deployment/plan

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

{
  "plan_file": "plan_file=@path/to/tfplan.json"
}

{
  "name": "text",
  "deployment": "123e4567-e89b-12d3-a456-426614174000",
  "parsed": {
    "data": {
      "driftMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "outputMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "costMetadata": {
        "totalFrom": 1,
        "totalTo": 1,
        "totalMargin": 1,
        "packageCost": 1
      },
      "plannedResourcesMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "outputs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "empty",
          "action": "unchanged",
          "state": null,
          "desired": null,
          "planned": null,
          "actual": null,
          "force_replace": true
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": null
      }
    }
  }
}

get

Get a deployment state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdstring · uuidRequired

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

Responses

200

State retrieved successfully

application/json

Responsestring · binary

Deployment state file in JSON format

400

Failed to download state

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment state not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentId}/state

GET /api/v1/deployment/{deploymentId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

get

Get deployment states information

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

List of deployment states with metadata

application/json

400

Bad request

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentIdOrSlug}/states

GET /api/v1/deployment/{deploymentIdOrSlug}/states HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "state_id": "123e4567-e89b-12d3-a456-426614174000",
    "package_id": "terraform_aws_secretsmanager",
    "hierarchical_path": "root.terraform_aws_secretsmanager",
    "status": "live",
    "run_id": "run-abc123",
    "locked": false,
    "created_at": "2025-10-10T12:34:56.123Z",
    "updated_at": "2025-10-12T08:20:00.456Z"
  }
]

put

Set deployment alias

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

outputIdstring · uuidRequired

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

Body

aliasstringRequired

The deployment output alias e.g. my_output

Example: my-my_output

Responses

200

Deployment alias updated successfully

application/json

400

Failed to update deployment alias

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment not found

application/json

409

Alias already exists

application/json

429

Too many requests

application/json

put

/api/v1/deployment/outputs/{outputId}/set-alias

PUT /api/v1/deployment/outputs/{outputId}/set-alias HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "alias": "my-my_output"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "my-my_output"
}

get

Return list of deployment outputs for a deployment

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentSlugstringRequired

The deployment's slug e.g. my-deployment

Query parameters

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted ' + 'e.g. key

Default: updatedPossible 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 deployment outputs key that match a particular query e.g. my_output

include_metadatabooleanOptional

If true, includes metadata with all package IDs from the filtered outputs. If false or omitted, metadata will not be included.

Default: false

environmentstringOptional

Filter deployments by environment slug in filters

Responses

200

Paginated information of filtered deployment outputs

application/json

400

Failed to get deployment outputs information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentSlug}/outputs

GET /api/v1/deployment/{deploymentSlug}/outputs HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "deployment_slug": "text",
      "package_id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": null,
      "key": "bucket_name",
      "type": "string",
      "value": "my-bucket",
      "is_sensitive": true,
      "is_hidden": true,
      "is_destroyed": true,
      "created_at": "2026-01-10T03:42:45.481Z",
      "updated_at": null
    }
  ],
  "filters": {
    "deployment_slugs": [
      [
        "deployment-slug-1",
        "deployment-slug-2"
      ]
    ],
    "current_env": [
      [
        "deployment-slug-1",
        "deployment-slug-2"
      ]
    ]
  },
  "metadata": {
    "packages": [
      [
        "package-id-1",
        "package-id-2"
      ]
    ]
  }
}

get

Return deployment manifest

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

Deployment manifest in YAML format

application/yaml

Responsestring

YAML manifest for the deployment

400

Failed to get deployment manifest

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

get

/api/v1/deployment/{deploymentIdOrSlug}/manifest

GET /api/v1/deployment/{deploymentIdOrSlug}/manifest HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

delete

Delete a deployment activity

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

runIdstring · uuidRequired

The deployment run ID to delete

Responses

200

Deployment activity deleted successfully

application/json

400

Failed to delete deployment activity

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment activity not found

application/json

429

Too many requests

application/json

500

Failed to delete deployment activity due to internal error

application/json

delete

/api/v1/deployment/activity/{runId}

DELETE /api/v1/deployment/activity/{runId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}

delete

Delete a deployment activity

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

runIdstring · uuidRequired

The deployment run ID to delete

Responses

200

Deployment activity deleted successfully

application/json

400

Failed to delete deployment activity

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission. 🔒 Requires the update:deployment permission

application/json

404

Deployment activity not found

application/json

429

Too many requests

application/json

500

Failed to delete deployment activity due to internal error

application/json

delete

/api/v1/deployment/run/{runId}

DELETE /api/v1/deployment/run/{runId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}

get

Return deployments information by environment

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

environmentIdstring · uuidOptional

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

Example: f27d96be-c486-4075-a926-0ee96775119e

querystringOptional

sortstring · enumOptional

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

Default: timestampPossible values:

typestring · enumOptional

Specifies the type of deployments list to be returned: runs or deployments. Note: runs and activities return the same data for backward compatibility.

Default: runsPossible 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]

expandbooleanOptional

If true, return detailed graph information. If false, return basic information

latestbooleanOptional

If true, return unique latest deployments only

searchstringOptional

Enables searching within the list for deployment names that match a particular query e.g. my_app

archivedbooleanOptional

Also includes archived props

outdatedbooleanOptional

If true, return only deployments with outdated package versions (only applicable when type=deployments)

Responses

200

Paginated information of filtered deployments for an environment

application/json

400

Failed to get deployments information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Package not found

application/json

429

Too many requests

application/json

get

/api/v1/deployments

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

{
  "total": 1,
  "has_outdated": true,
  "stats": {
    "live": 1,
    "drafts": 1
  },
  "list": [
    {
      "driftMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "outputMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "costMetadata": {
        "totalFrom": 1,
        "totalTo": 1,
        "totalMargin": 1,
        "packageCost": 1
      },
      "plannedResourcesMetadata": {
        "unchanged": 1,
        "add": 1,
        "change": 1,
        "destroy": 1
      },
      "stateMetadata": {
        "managed": 1,
        "unmanaged": 1
      },
      "deployment": "123e4567-e89b-12d3-a456-426614174000",
      "task": "123e4567-e89b-12d3-a456-426614174000",
      "parent": null,
      "name": "text",
      "version": "text",
      "type": "blueprint",
      "uniqueId": null,
      "stage": "pending",
      "is_archived": true,
      "created": "2026-01-10T03:42:45.481Z",
      "outdated_package": true,
      "timestamp": "2026-01-10T03:42:45.481Z",
      "errors": null,
      "user": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "email": "[email protected]"
      },
      "reviewed_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "email": "[email protected]",
        "action": "approve",
        "timestamp": "2026-01-10T03:42:45.481Z"
      },
      "slug": null,
      "origin_state_location": null,
      "environment": {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "slug": "production-europe",
        "name": "Production Europe",
        "color": "#0000ff",
        "allow_pre_release": false,
        "is_default": true,
        "enabled_policies": [
          "require_owner_approval"
        ],
        "is_active": true,
        "is_deleted": true,
        "created": "2026-01-10T03:42:45.481Z",
        "users": [
          {
            "id": "prov0|1234567890",
            "name": "John Doe",
            "email": "[email protected]",
            "nickname": "JD",
            "picture": "https://example.com/profile.jpg",
            "roles": [
              {
                "id": "rol_abCdeFghIjklMnmP",
                "name": "Admin",
                "description": "Role for managing Admin permissions"
              }
            ],
            "membership_role": "member"
          }
        ],
        "cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "type": "execution",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2026-01-10T03:42:45.481Z",
          "cloud_account": "123456789012",
          "assume_role_arn": "arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF",
          "external_id": "abcdef-ghijklm",
          "cloud_config": {
            "service_account_email": "sa@project_id.iam.gserviceaccount.com",
            "scopes": "https://www.googleapis.com/auth/cloud-platform",
            "tenant_id": "text",
            "subscription_id": "text",
            "federated_app_client_id": "text",
            "oidc_issuer_url": "https://example.com",
            "oidc_audience": "text",
            "cluster_name": "text",
            "service_account_namespace": "text",
            "service_account_name": "text",
            "cluster_oidc_url": "https://example.com",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "is_primary": true,
          "profile": "secrets-manager"
        },
        "discovery_cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "type": "execution",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2026-01-10T03:42:45.481Z",
          "cloud_account": "123456789012",
          "assume_role_arn": "arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF",
          "external_id": "abcdef-ghijklm",
          "cloud_config": {
            "service_account_email": "sa@project_id.iam.gserviceaccount.com",
            "scopes": "https://www.googleapis.com/auth/cloud-platform",
            "tenant_id": "text",
            "subscription_id": "text",
            "federated_app_client_id": "text",
            "oidc_issuer_url": "https://example.com",
            "oidc_audience": "text",
            "cluster_name": "text",
            "service_account_namespace": "text",
            "service_account_name": "text",
            "cluster_oidc_url": "https://example.com",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      },
      "is_latest": true,
      "is_uninstall": true,
      "is_plan_only": true,
      "drift_detection": true,
      "children": [
        {
          "driftMetadata": {
            "unchanged": 1,
            "add": 1,
            "change": 1,
            "destroy": 1
          },
          "outputMetadata": {
            "unchanged": 1,
            "add": 1,
            "change": 1,
            "destroy": 1
          },
          "costMetadata": {
            "totalFrom": 1,
            "totalTo": 1,
            "totalMargin": 1,
            "packageCost": 1
          },
          "plannedResourcesMetadata": {
            "unchanged": 1,
            "add": 1,
            "change": 1,
            "destroy": 1
          },
          "stateMetadata": {
            "managed": 1,
            "unmanaged": 1
          },
          "deployment": "123e4567-e89b-12d3-a456-426614174000",
          "task": "123e4567-e89b-12d3-a456-426614174000",
          "parent": null,
          "name": "text",
          "version": "text",
          "type": "blueprint",
          "uniqueId": null,
          "stage": "pending",
          "is_archived": true,
          "created": "2026-01-10T03:42:45.481Z",
          "outdated_package": true,
          "timestamp": "2026-01-10T03:42:45.481Z",
          "errors": null,
          "plan_file_url": null,
          "state_file_url": null,
          "iac_type": "terraform",
          "parsed": "[Circular Reference]"
        }
      ],
      "deployment_metadata": {
        "created_by": {
          "id": "prov0|1234567890",
          "name": "John Doe",
          "nickname": "JD",
          "picture": "https://example.com/profile.jpg",
          "email": "[email protected]"
        },
        "created_at": "2026-01-10T03:42:45.481Z"
      }
    }
  ]
}

get

Return deployments filters

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumOptional

Will return a specific list with type of available filters if provided, otherwise returns all results

Possible values:

archivedbooleanOptional

If true, shows only archived deployments. if false, shows only non-archived deployments

Default: false

slugstringOptional

Filter by deployment slug

Responses

200

Deployments filters

application/json

400

Failed to get deployments filters

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

429

Too many requests

application/json

get

/api/v1/deployments/filters

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

{
  "deployments_filters": {
    "slugs": [
      "slug1",
      "slug2"
    ],
    "stages": [
      "plan_approved",
      "completed"
    ],
    "blueprints": [
      "blueprint1",
      "blueprint2"
    ],
    "environments": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "name",
        "slug": "slug",
        "color": "color"
      }
    ],
    "users": [
      {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "email": "[email protected]"
      }
    ],
    "types": [
      "is_plan_only"
    ],
    "iac_types": [
      "terraform"
    ]
  }
}

get

Return list of deployment outputs

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted ' + 'e.g. key

Default: updatedPossible 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 deployment outputs key that match a particular query e.g. my_output

include_metadatabooleanOptional

If true, includes metadata with all package IDs from the filtered outputs. If false or omitted, metadata will not be included.

Default: false

environmentstringOptional

Filter deployments by environment slug in filters

Responses

200

Paginated information of filtered deployment outputs

application/json

400

Failed to get deployment outputs information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission. 🔒 Requires the read:deployment permission

application/json

429

Too many requests

application/json

get

/api/v1/deployments/outputs

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

{
  "total": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "deployment_slug": "text",
      "package_id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": null,
      "key": "bucket_name",
      "type": "string",
      "value": "my-bucket",
      "is_sensitive": true,
      "is_hidden": true,
      "is_destroyed": true,
      "created_at": "2026-01-10T03:42:45.481Z",
      "updated_at": null
    }
  ],
  "filters": {
    "deployment_slugs": [
      [
        "deployment-slug-1",
        "deployment-slug-2"
      ]
    ],
    "current_env": [
      [
        "deployment-slug-1",
        "deployment-slug-2"
      ]
    ]
  },
  "metadata": {
    "packages": [
      [
        "package-id-1",
        "package-id-2"
      ]
    ]
  }
}

post

Get deployments plans

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

deploymentsstring · uuid[]Required

List of deployment IDs, e.g. ["123e4567-e89b-12d3-a456-426614174000", "456e4567-e89b-12d3-a456-426614174000"]

Example: ["123e4567-e89b-12d3-a456-426614174000","456e4567-e89b-12d3-a456-426614174000"]

Responses

200

Plans downloaded successfully

text/markdown

Responsestring · binary

Deployments plans file in Markdown format

400

Failed to download plans

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployments plans not found

application/json

429

Too many requests

application/json

post

/api/v1/deployments/plans

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

{
  "deployments": [
    "123e4567-e89b-12d3-a456-426614174000",
    "456e4567-e89b-12d3-a456-426614174000"
  ]
}

binary

post

Approve multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring · uuid[]

string · uuid[]Optional

List of deployment IDs, e.g. ["123e4567-e89b-12d3-a456-426614174000", "456e4567-e89b-12d3-a456-426614174000"]

Example: ["123e4567-e89b-12d3-a456-426614174000","456e4567-e89b-12d3-a456-426614174000"]

Responses

200

Deployment approval details

application/json

400

Failed to approve deployments

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

One or more of the deployment was not found

application/json

429

Too many requests

application/json

500

Failed to approve deployments

application/json

post

/api/v1/deployments/approve

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

[
  "123e4567-e89b-12d3-a456-426614174000",
  "456e4567-e89b-12d3-a456-426614174000"
]

[
  {
    "deployment": "123e4567-e89b-12d3-a456-426614174000",
    "parent": null,
    "type": "blueprint",
    "stage": "pending"
  }
]

post

Cancel multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring · uuid[]

string · uuid[]Optional

List of deployment IDs, e.g. ["123e4567-e89b-12d3-a456-426614174000", "456e4567-e89b-12d3-a456-426614174000"]

Example: ["123e4567-e89b-12d3-a456-426614174000","456e4567-e89b-12d3-a456-426614174000"]

Responses

200

Deployment canceled successfully

application/json

400

Failed to cancel deployment

application/json

401

Failed to authenticate user or runtime

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment not found

application/json

429

Too many requests

application/json

post

/api/v1/deployments/cancel

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

[
  "123e4567-e89b-12d3-a456-426614174000",
  "456e4567-e89b-12d3-a456-426614174000"
]

[
  {
    "deployment": "123e4567-e89b-12d3-a456-426614174000",
    "parent": null,
    "type": "blueprint",
    "stage": "canceled"
  }
]

post

Archive multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring[]

string[]Optional

List of deployment slugs, e.g. ["test-deployment", "my-deployment"]

Example: ["test-deployment","my-deployment"]

Responses

200

Deployment archived / unarchived successfully

application/json

400

Failed to archive / unarchive deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployments not found to be archived / unarchived

application/json

429

Too many requests

application/json

post

/api/v1/deployments/archive

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

[
  "test-deployment",
  "my-deployment"
]

[
  {
    "deployment": "text",
    "archived": true
  }
]

post

Unarchive multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring[]

string[]Optional

List of deployment slugs, e.g. ["test-deployment", "my-deployment"]

Example: ["test-deployment","my-deployment"]

Responses

200

Deployment archived / unarchived successfully

application/json

400

Failed to archive / unarchive deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission. 🔒 Requires the update:deployment permission

application/json

404

Deployments not found to be archived / unarchived

application/json

429

Too many requests

application/json

post

/api/v1/deployments/unarchive

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

[
  "test-deployment",
  "my-deployment"
]

[
  {
    "deployment": "text",
    "archived": true
  }
]

post

Enable drift detection for multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring[]

string[]Optional

List of deployment slugs, e.g. ["test-deployment", "my-deployment"]

Example: ["test-deployment","my-deployment"]

Responses

200

Deployment drift detection status updated successfully

application/json

400

Failed to update drift detection status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployments not found to update drift detection status

application/json

429

Too many requests

application/json

post

/api/v1/deployments/enable-drift-detection

POST /api/v1/deployments/enable-drift-detection HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  "test-deployment",
  "my-deployment"
]

[
  {
    "deployment": "text",
    "is_drift_detection_enabled": true
  }
]

post

Disable drift detection for multiple deployments

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring[]

string[]Optional

List of deployment slugs, e.g. ["test-deployment", "my-deployment"]

Example: ["test-deployment","my-deployment"]

Responses

200

Deployment drift detection status updated successfully

application/json

400

Failed to update drift detection status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission. 🔒 Requires the update:deployment permission

application/json

404

Deployments not found to update drift detection status

application/json

429

Too many requests

application/json

post

/api/v1/deployments/disable-drift-detection

POST /api/v1/deployments/disable-drift-detection HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  "test-deployment",
  "my-deployment"
]

[
  {
    "deployment": "text",
    "is_drift_detection_enabled": true
  }
]

post

Upload state files to draft deployments

🔒 Requires the create:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Body

packageVersionstringRequired

The package version e.g. 1.2.3

Example: 1.2.3

statesstringRequired

JSON string containing array of state metadata with file references for root-level packages only.

Example:

[{"package_id":"terraform_aws_secretsmanager","state_file":"state_1"},{"package_id":"terraform_aws_eks_auto","state_file":"state_2"}]

Other propertiesanyOptional

Responses

200

State upload results

application/json

400

Failed to upload state files

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:deployment permission

application/json

404

Deployment / Package not found

application/json

429

Too many requests

application/json

post

/api/v1/deployments/{deploymentIdOrSlug}/states

POST /api/v1/deployments/{deploymentIdOrSlug}/states HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 224

{
  "packageVersion": "1.2.3",
  "states": "[{\"package_id\":\"terraform_aws_secretsmanager\",\"state_file\":\"state_1\"},{\"package_id\":\"terraform_aws_eks_auto\",\"state_file\":\"state_2\"}]",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

[
  {
    "package_id": "terraform_aws_secretsmanager",
    "status": "success",
    "reason": "text"
  }
]

post

Get statuses for the requested Deployment IDs

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

deploymentsstring · uuid[]Required

List of deployment IDs, e.g. ["123e4567-e89b-12d3-a456-426614174000", "456e4567-e89b-12d3-a456-426614174000"]

Example: ["123e4567-e89b-12d3-a456-426614174000","456e4567-e89b-12d3-a456-426614174000"]

Responses

200

Deployments status

application/json

400

Failed to get deployments status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:deployment permission

application/json

404

Deployments not found

application/json

429

Too many requests

application/json

post

/api/v1/deployments/status

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

{
  "deployments": [
    "123e4567-e89b-12d3-a456-426614174000",
    "456e4567-e89b-12d3-a456-426614174000"
  ]
}

[
  {
    "deployment": "123e4567-e89b-12d3-a456-426614174000",
    "type": "blueprint",
    "name": "text",
    "version": "text",
    "stage": "pending",
    "errors": null,
    "created": "2026-01-10T03:42:45.481Z",
    "updated": null,
    "completed": null,
    "statusTimestamps": {
      "pending": "2026-01-10T03:42:45.481Z",
      "planning": "2026-01-10T03:42:45.481Z",
      "no_change": "2026-01-10T03:42:45.481Z",
      "planned": "2026-01-10T03:42:45.481Z",
      "plan_approved": "2026-01-10T03:42:45.481Z",
      "installing": "2026-01-10T03:42:45.481Z",
      "completed": "2026-01-10T03:42:45.481Z",
      "canceled": "2026-01-10T03:42:45.481Z",
      "skipped": "2026-01-10T03:42:45.481Z",
      "error": "2026-01-10T03:42:45.481Z"
    }
  }
]

get

Returns all existing mappings between a hierarchical package path and its state id by specific deployment

🔒 Requires the read:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

rootRunIdstringRequired

Root deployment run ID, e.g. 44cd0bd6-d09b-4924-abfb-12345d111fe7

Responses

200

All the existing for specified deployment state mappings

application/json

Responseany

All the existing for specified deployment state mappings

Example:

{"deploymentId":"25cd0bd6-d09b-4924-abfb-41768d111fe7","mappings":{"root.vpc.subnet-1":"bae58bdb-9924-4831-a341-405313cfca92","root.vpc.subnet-2":"cabf22cf-6a57-47d9-9a11-69ab318d3e08","root.database":"90d8f41b-f886-4b96-b05c-1c7d23bbcff7"}}

400

Bad request

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the read:deployment permission

application/json

404

Deployment or state mappings not found

application/json

429

Too many requests

application/json

get

/api/v1/deployments/{rootRunId}/state

GET /api/v1/deployments/{rootRunId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deploymentId": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
  "mappings": {
    "root.vpc.subnet-1": "bae58bdb-9924-4831-a341-405313cfca92",
    "root.vpc.subnet-2": "cabf22cf-6a57-47d9-9a11-69ab318d3e08",
    "root.database": "90d8f41b-f886-4b96-b05c-1c7d23bbcff7"
  }
}

post

Sets the mapping for deployment's state with hierarchical package path and its deployment run id. Optionally, it can also set the stage of state.

🔒 Requires all of the following permissions: read:deployment, update:deployment, create:deployment

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdstring · uuidRequired

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

Body

hierarchical_pathstringRequired

The hierarchical package path, e.g. root.vpc2.subnet_new. Notice: hierarchical_path must represent the path from the root module (root) to the artifact identifier, with each level separated by a dot (.)

run_idstring · uuidRequired

The deployment run id that produced/updated the state

stagestring · enumOptional

The state stage

Possible values:

Responses

200

Deployment state mapping updated successfully

application/json

Responseany

Deployment state mapping updated successfully

Example: {"root.vpc.subnet-1":"bae58bdb-9924-4831-a341-405313cfca92"}

201

Deployment state mapping created successfully

application/json

400

Bad request

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires all of the following permissions: read:deployment, update:deployment, create:deployment

application/json

404

Deployment or state mappings not found

application/json

429

Too many requests

application/json

post

/api/v1/deployments/{deploymentId}/state

POST /api/v1/deployments/{deploymentId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "hierarchical_path": "text",
  "run_id": "123e4567-e89b-12d3-a456-426614174000",
  "stage": "installed"
}

{
  "root.vpc.subnet-1": "bae58bdb-9924-4831-a341-405313cfca92"
}

get

Return deployment remote state config

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

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

packageUniqueIdstringRequired

Unique package ID

Example: package-id-1

Responses

200

Deployment remote state config

application/json

400

Failed to get deployment remote state config

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:deployment permission

application/json

404

Deployment or package not found

application/json

429

Too many requests

application/json

get

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/config

GET /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/config HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terraform_backend_config": {
    "terraform": {
      "backend": {
        "http": {
          "address": "https://api.bluebricks.co/api/v1/deployments/<deployment_id>/<package_unique_id>/state",
          "lock_address": "https://api.bluebricks.co/api/v1/deployments/<deployment_id>/<package_unique_id>/state/lock",
          "unlock_address": "https://api.bluebricks.co/api/v1/deployments/<deployment_id>/<package_unique_id>/state/lock",
          "username": "25cd0bd6-d09b-4924-abfb-41768d111fe7",
          "password": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"
        }
      }
    },
    "variables": null
  }
}

get

Return deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID.

packageUniqueIdstringRequired

Query parameters

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Responses

200

Deployment remote state

application/json

400

Failed to get deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission

application/json

404

Remote state not found

application/json

429

Too many requests

application/json

get

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state

GET /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

post

Set deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID.

packageUniqueIdstringRequired

Query parameters

IDstringOptional

Lock ID

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Body

Remote state

Other propertiesanyOptional

Responses

200

Deployment remote state set successfully

application/json

Responseany

Deployment remote state set successfully

400

Failed to set deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

post

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state

POST /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

delete

Delete deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID.

packageUniqueIdstringRequired

Query parameters

IDstringOptional

Lock ID

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Responses

200

Deployment remote state deleted successfully

application/json

Responseany

Deployment remote state deleted successfully

400

Failed to delete deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

delete

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state

DELETE /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/state HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

post

Lock deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID

packageUniqueIdstringRequired

Query parameters

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Body

Remote state lock details

Other propertiesanyOptional

Responses

200

Deployment remote state locked successfully

application/json

400

Failed to lock deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

post

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock

POST /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

lock

Lock deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID

packageUniqueIdstringRequired

Query parameters

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Body

Remote state lock details

Other propertiesanyOptional

Responses

200

Deployment remote state locked successfully

application/json

400

Failed to lock deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission. 🔒 Requires the update:deployment permission

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

lock

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock

LOCK /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

delete

Unlock deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID

packageUniqueIdstringRequired

Query parameters

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Body

Remote state lock details

Other propertiesanyOptional

Responses

200

Deployment remote state unlocked successfully

application/json

Responseany

Deployment remote state unlocked successfully

400

Failed to unlock deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission

application/json

404

Remote state lock not found

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

delete

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock

DELETE /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

unlock

Unlock deployment remote state

🔒 Requires the update:deployment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

Origin run ID

packageUniqueIdstringRequired

Query parameters

iac_typestring · enumOptional

IaC type of the remote state

Default: terraformPossible values:

Body

Remote state lock details

Other propertiesanyOptional

Responses

200

Deployment remote state unlocked successfully

application/json

Responseany

Deployment remote state unlocked successfully

400

Failed to unlock deployment remote state

application/json

401

Failed to authenticate user or runtime

application/json

403

Cannot access deployment remote state. 🔒 Requires the update:deployment permission. 🔒 Requires the update:deployment permission

application/json

404

Remote state lock not found

application/json

409

Remote state updates locked

application/json

429

Too many requests

application/json

unlock

/api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock

UNLOCK /api/v1/deployments/{originDeploymentId}/{packageUniqueId}/lock HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

PreviousCloud Accounts NextEnvironments

Last updated 1 month ago

Was this helpful?

Good night