Deployments (Deprecated)

Deprecated

post

DEPRECATED: Use POST /api/v1/env/create instead. Create a new deployment or start run for existing deployment (legacy deployment endpoint).

🔒 Requires the create:environment 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

deployTypestring · enumOptional

Controls how the deployment is executed. autoApply automatically applies changes without manual approval; autoApprove skips approval and pending; validateOnly validates the deployment without executing; planOnly generates a plan without executing; driftDetection runs only configuration-drift detection; draft creates the deployment record without starting any activity. deployType can't be used together with deprecated flags: force, planOnly, validateOnly, noActivity and driftDetection.

Example: autoApprovePossible values:

forcebooleanOptional

Use deployType='autoApprove' instead

validateOnlybooleanOptional

Use deployType='validateOnly' instead

Default: false

planOnlybooleanOptional

Use deployType='planOnly' instead

Default: false

incrementalbooleanOptional

Enable incremental mode to skip deployments with no changes

Default: false

noActivitybooleanOptional

Use deployType='draft' instead

Default: false

driftDetectionbooleanOptional

Use deployType='driftDetection' instead

Default: false

isDriftDetectionEnabledbooleanOptional

Enable drift detection for the deployment

Default: false

envstringOptional

Use collection instead. Target environment for deployment

collectionstringOptional

Target collection for deployment

Responses

200

Created deployment and task details or validation result

application/json

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:environment 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: 309

{
  "deploymentSlug": "text",
  "blueprint": "text",
  "version": "1.2.3",
  "deployType": "autoApprove",
  "force": true,
  "validateOnly": false,
  "planOnly": false,
  "incremental": false,
  "noActivity": false,
  "driftDetection": false,
  "isDriftDetectionEnabled": false,
  "env": "text",
  "collection": "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:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

The deployment's ID or environment's 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

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:environment 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-03-08T23:26:14.580Z",
  "outdated_package": true,
  "timestamp": "2026-03-08T23:26:14.580Z",
  "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:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

Deployment props

application/json

Deployment props

activity_idstringRequired

slugone ofRequired

nullOptional

stringOptional

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

updatedstringRequired

packagestringRequired

versionstringRequired

envstringRequired

collectionstringRequired

400

Failed to get deployment props

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment 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",
  "collection": "text",
  "props": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

Return deployment image

🔒 Requires the read:environment 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

string · binaryOptional

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:environment 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:environment 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

Deployment approval details

deploymentstring · uuidRequired

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

parentstring · nullableRequired

typestring · enumRequiredPossible values:

stagestring · enumRequired

The deployment stage e.g. pending

Possible values:

400

Failed to approve deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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

string · binaryOptional

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

Plan generated successfully

namestringRequired

deploymentstring · uuidRequired

Unique id assigned to plan file for client-side storage

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:environment 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

string · binaryOptional

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:environment 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

Deprecated

get

DEPRECATED: Use GET /api/v1/env/:environmentIdOrSlug/states instead. Get deployment states information (legacy deployment endpoint).

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

List of deployment states with metadata

application/json

List of deployment states with metadata

state_idstringRequired

The unique identifier of the state

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

package_idstringRequired

The unique identifier of the package

Example: terraform_aws_secretsmanager

hierarchical_pathstring · nullableOptional

The hierarchical path of the package in the deployment

Example: root.terraform_aws_secretsmanager

statusstring · enumRequired

The current status of the deployment state. Returns "n/a" when metadata is not available

Example: livePossible values:

run_idstring · nullableRequired

ID of the latest run that created/updated the state. Returns "n/a" when metadata is not available

Example: run-abc123

lockedbooleanRequired

Whether the state is currently locked

Example: false

created_atstring · nullableRequired

When the state was first created. Returns "n/a" when metadata is not available

Example: 2025-10-10T12:34:56.123Z

updated_atstring · nullableRequired

When the state was last updated

Example: 2025-10-12T08:20:00.456Z

400

Bad request

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment 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:environment 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

Deployment alias updated successfully

idstring · uuidRequired

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

aliasstringRequired

The deployment output alias e.g. my_output

Example: my-my_output

400

Failed to update deployment alias

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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 deployment manifest

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Responses

200

Deployment manifest in YAML format

application/yaml

stringOptional

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:environment 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:environment 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

Deployment activity deleted successfully

messagestringRequired

Success message

400

Failed to delete deployment activity

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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:environment 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

Deployment activity deleted successfully

messagestringRequired

Success message

400

Failed to delete deployment activity

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment permission. 🔒 Requires the update:environment 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 collection

🔒 Requires the read:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

environmentIdstring · uuidOptionalDeprecated

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

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

collectionIdstring · uuidOptional

The collection'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:

typeone ofOptional

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

Default: runs

undefined · enumOptionalPossible values:

undefined · enumOptionalDeprecated

DEPRECATED: Use /api/v1/envs endpoint instead. This type is maintained for backward compatibility.

Possible 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 deployments 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 a collection

application/json

Paginated information of filtered deployments for a collection

totalnumberRequired

has_outdatedbooleanOptional

Indicates if any outdated deployments exist (only returned when type=deployments)

statsone ofRequired

listone ofRequired

400

Failed to get deployments information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment 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-03-08T23:26:14.580Z",
      "outdated_package": true,
      "timestamp": "2026-03-08T23:26:14.580Z",
      "errors": null,
      "user": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "email": "johndoe@mail.com"
      },
      "reviewed_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg",
        "email": "johndoe@mail.com",
        "action": "approve",
        "timestamp": "2026-03-08T23:26:14.580Z"
      },
      "slug": null,
      "origin_state_location": null,
      "collection": {
        "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-03-08T23:26:14.580Z",
        "users": [
          {
            "id": "prov0|1234567890",
            "name": "John Doe",
            "email": "johndoe@mail.com",
            "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-03-08T23:26:14.580Z",
          "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",
            "client_secret": "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-03-08T23:26:14.580Z",
          "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",
            "client_secret": "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,
      "is_incremental": true,
      "is_force_install": true,
      "task_type": "install",
      "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-03-08T23:26:14.580Z",
          "outdated_package": true,
          "timestamp": "2026-03-08T23:26:14.580Z",
          "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": "johndoe@mail.com"
        },
        "created_at": "2026-03-08T23:26:14.580Z"
      },
      "git_info": {
        "provider": "text",
        "base_branch": "text",
        "repository": "text",
        "head_branch": "text",
        "git_user_name": "text",
        "git_org": "text",
        "commit_link": "text",
        "pr_link": null
      }
    }
  ]
}

get

Return deployments filters

🔒 Requires the read:environment 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

Deployments filters

400

Failed to get deployments filters

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment 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"
    ],
    "collections": [
      {
        "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": "johndoe@mail.com"
      }
    ],
    "types": [
      "is_plan_only"
    ],
    "iac_types": [
      "terraform"
    ]
  }
}

get

Return list of deployment outputs

🔒 Requires the read:environment 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

environmentstringOptionalDeprecated

DEPRECATED: Use collection instead. Filter deployments by environment slug in filters

collectionstringOptional

Filter deployments by collection slug in filters

Responses

200

Paginated information of filtered deployment outputs

application/json

Paginated information of filtered deployment outputs

totalnumberRequired

400

Failed to get deployment outputs information

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment permission. 🔒 Requires the read:environment 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",
      "environment_slug": "text",
      "package_id": "pkg-12345",
      "alias": null,
      "key": "bucket_name",
      "type": "string",
      "value": "my-bucket",
      "is_sensitive": true,
      "is_hidden": true,
      "is_destroyed": true,
      "created_at": "2026-03-08T23:26:14.580Z",
      "updated_at": null
    }
  ],
  "filters": {
    "environment_slugs": [
      [
        "environment-slug-1",
        "environment-slug-2"
      ]
    ],
    "current_collection": [
      [
        "environment-slug-1",
        "environment-slug-2"
      ]
    ]
  },
  "metadata": {
    "packages": [
      [
        "package-id-1",
        "package-id-2"
      ]
    ]
  }
}

post

Get deployments plans

🔒 Requires the read:environment 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

string · binaryOptional

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:environment 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:environment 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

Deployment approval details

deploymentstring · uuidRequired

parentstring · nullableRequired

typestring · enumRequiredPossible values:

stagestring · enumRequired

The deployment stage e.g. pending

Possible values:

400

Failed to approve deployments

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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:environment 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

Deployment canceled successfully

deploymentstring · uuidRequired

parentstring · nullableRequired

typestring · enumRequiredPossible values:

stagestring · enumRequiredPossible values:

400

Failed to cancel deployment

application/json

401

Failed to authenticate user or runtime

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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"
  }
]

Deprecated

post

DEPRECATED: Use POST /api/v1/envs/archive instead. Archive multiple deployments (legacy deployment endpoint).

🔒 Requires the update:environment 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

Deployment archived / unarchived successfully

deploymentstringRequired

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

archivedbooleanRequired

Updated archived status

400

Failed to archive / unarchive deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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
  }
]

Deprecated

post

DEPRECATED: Use POST /api/v1/envs/unarchive instead. Unarchive multiple deployments (legacy deployment endpoint).

🔒 Requires the update:environment 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

Deployment archived / unarchived successfully

deploymentstringRequired

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

archivedbooleanRequired

Updated archived status

400

Failed to archive / unarchive deployment

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment permission. 🔒 Requires the update:environment 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
  }
]

Deprecated

post

DEPRECATED: Use POST /api/v1/envs/enable-drift-detection instead. Enable drift detection for multiple deployments (legacy deployment endpoint).

🔒 Requires the update:environment 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

Deployment drift detection status updated successfully

deploymentstringRequired

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

is_drift_detection_enabledbooleanRequired

Updated drift detection status

400

Failed to update drift detection status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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
  }
]

Deprecated

post

DEPRECATED: Use POST /api/v1/envs/disable-drift-detection instead. Disable drift detection for multiple deployments (legacy deployment endpoint).

🔒 Requires the update:environment 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

Deployment drift detection status updated successfully

deploymentstringRequired

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

is_drift_detection_enabledbooleanRequired

Updated drift detection status

400

Failed to update drift detection status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment permission. 🔒 Requires the update:environment 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
  }
]

Deprecated

post

DEPRECATED: Use POST /api/v1/envs/:environmentIdOrSlug/states instead. Upload state files to deployments (legacy deployment endpoint).

🔒 Requires the create:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

deploymentIdOrSlugstringRequired

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

Body

statesstringRequired

JSON string containing array of state metadata with file references. Each item must have either package_id (for unique packages) or hierarchical_path (for packages that appear at multiple positions in the blueprint tree, e.g., bpA.bpB.mypackageid).

Example:

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

versionstringOptional

Optional blueprint version to use for resolving the package tree. If not provided, the latest published version is used.

Example: 1.0.0

Other propertiesanyOptional

Responses

200

State upload results

application/json

State upload results

package_idstringRequired

Package identifier

Example: terraform_aws_secretsmanager

hierarchical_pathstringOptional

Full hierarchical path of the package in the blueprint tree (e.g., root.bpA.bpB.mypackageid)

Example: root.terraform_aws_secretsmanager

statusstring · enumRequired

Upload status

Example: successPossible values:

reasonstringOptional

Reason for failure (only present when status is failed)

400

Failed to upload state files

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:environment 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: 238

{
  "states": "[{\"package_id\":\"terraform_aws_secretsmanager\",\"state_file\":\"state_1\"},{\"hierarchical_path\":\"sub_blueprint.terraform_aws_eks_auto\",\"state_file\":\"state_2\"}]",
  "version": "1.0.0",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

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

post

Get statuses for the requested Deployment IDs

🔒 Requires the read:environment 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

Deployments status

deploymentstring · uuidRequired

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

typestring · enumRequired

The deployment type e.g. blueprint

Possible values:

namestringRequired

versionstringRequired

stagestring · enumRequired

The deployment stage e.g. pending

Possible values:

errorsone ofRequired

nullOptional

createdstring · date-timeRequired

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

updatedstring · nullableRequired

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

completedstring · nullableRequired

400

Failed to get deployments status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:environment 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-03-08T23:26:14.580Z",
    "updated": null,
    "completed": null,
    "statusTimestamps": {
      "pending": "2026-03-08T23:26:14.580Z",
      "planning": "2026-03-08T23:26:14.580Z",
      "no_change": "2026-03-08T23:26:14.580Z",
      "planned": "2026-03-08T23:26:14.580Z",
      "plan_approved": "2026-03-08T23:26:14.580Z",
      "installing": "2026-03-08T23:26:14.580Z",
      "completed": "2026-03-08T23:26:14.580Z",
      "canceled": "2026-03-08T23:26:14.580Z",
      "skipped": "2026-03-08T23:26:14.580Z",
      "error": "2026-03-08T23:26:14.580Z"
    }
  }
]

get

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

🔒 Requires the read:environment 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

anyOptional

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:environment 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"
  }
}

get

Return deployment remote state config

🔒 Requires the update:environment permission

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

originDeploymentIdstringRequired

The deployment's ID or environment's 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

Deployment remote state config

400

Failed to get deployment remote state config

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the update:environment 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:environment 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

Deployment remote state

Other propertiesanyOptional

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:environment 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:environment 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

anyOptional

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:environment 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:environment 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

anyOptional

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:environment 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:environment 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

Deployment remote state locked successfully

Other propertiesanyOptional

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:environment 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:environment 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

Deployment remote state locked successfully

Other propertiesanyOptional

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:environment permission. 🔒 Requires the update:environment 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:environment 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

anyOptional

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:environment 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:environment 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

anyOptional

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:environment permission. 🔒 Requires the update:environment 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

PreviousWebhooks NextEnvironments (Deprecated)

Last updated 9 hours ago

Was this helpful?