API ReferenceHelp Center and Knowledge BaseDownload CLIGo to AppBook a Demo

Environments

get

Describe Environment with associated cloud accounts

🔒 Requires the read:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Responses
200

Information about the environment

application/json
get
/api/v1/environment/{idOrSlug}
GET /api/v1/environment/{idOrSlug} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_accounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "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"
    }
  ],
  "associated_items_count": {
    "members": 1,
    "properties": 1,
    "secrets": 1,
    "live_deployments": 1
  }
}
delete

Delete an environment from the organization

🔒 Requires the delete:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Responses
200

Updated information about the environment

application/json
delete
/api/v1/environment/{idOrSlug}
DELETE /api/v1/environment/{idOrSlug} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
post

Create an environment for deploying blueprints

🔒 Requires the create:environment permission

Authorizations
Body
namestringRequired

The environment name e.g. Production Europe

Example: Production Europe
colorstringOptional

The environment color code e.g. #0000ff

Example: #0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
defaultbooleanOptional

Whether the environment is the default for the organization e.g. true

Responses
200

Information about created environment

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

{
  "name": "Production Europe",
  "color": "#0000ff",
  "default": true
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
put

Enable an environment

🔒 Requires the update:environment permission

Authorizations
Body
one ofOptional
or
Responses
200

Updated information about the environment

application/json
put
/api/v1/environment
PUT /api/v1/environment HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "slug": "production-europe"
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
delete

Disable an environment

🔒 Requires the delete:environment permission

Authorizations
Body
one ofOptional
or
Responses
200

Updated information about the environment

application/json
delete
/api/v1/environment
DELETE /api/v1/environment HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "slug": "production-europe"
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
put

Change default environment for the organization

🔒 Requires the update:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Responses
200

Updated information about the environment

application/json
put
/api/v1/environment/{idOrSlug}/default
PUT /api/v1/environment/{idOrSlug}/default HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
put

Update environment properties such as color code, name, pre-release status, or associated users. Note: The slug remains unchanged even if the name is updated.

🔒 Requires the update:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Body
namestringOptional

The environment name e.g. Production Europe

Example: Production Europe
colorstringOptional

The environment color code e.g. #0000ff

Example: #0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
allow_pre_releasebooleanOptional

Whether the environment allows pre-release deployments e.g. false

Example: false
usersstring[]Optional

The user's unique ID e.g. prov0|1234567890

Example: prov0|1234567890
Responses
200

Updated information about the environment

application/json
put
/api/v1/environment/{idOrSlug}/edit
PUT /api/v1/environment/{idOrSlug}/edit HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "users": [
    "prov0|1234567890"
  ]
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
put

Clone an existing environment with properties and policies

🔒 Requires the create:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Body
namestringRequired

The environment name e.g. Production Europe

Example: Production Europe
Responses
200

Information about cloned environment

application/json
put
/api/v1/environment/{idOrSlug}/clone
PUT /api/v1/environment/{idOrSlug}/clone HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "Production Europe"
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": null
}
get

List environment properties

🔒 Requires the read:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Responses
200

List of environment properties

application/json
get
/api/v1/environment/{idOrSlug}/props
GET /api/v1/environment/{idOrSlug}/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "props": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "max_size",
      "content": "10",
      "is_enforced": true
    }
  ]
}
post

Create environment props

🔒 Requires the update:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodyobject[]

List of new environment properties

namestringRequired

The property name e.g. max_size

Example: max_size
contentstringRequired

The property value or content e.g. 10

Example: 10
is_enforcedbooleanOptional

Indicates whether the environment property takes precedence over any provided value e.g. true

Default: falseExample: true
Responses
200

Updated environment properties

application/json
post
/api/v1/environment/{idOrSlug}/props
POST /api/v1/environment/{idOrSlug}/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

[
  {
    "name": "max_size",
    "content": "10",
    "is_enforced": true
  }
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "props": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "max_size",
      "content": "10",
      "is_enforced": true
    }
  ]
}
put

Update environment props

🔒 Requires the update:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodyobject[]

List of updated environment properties

idstring · uuidOptional

The property ID e.g. 123e4567-e89b-12d3-a456-426614174000

namestringRequired

The property name e.g. max_size

Example: max_size
contentstringRequired

The property value or content e.g. 10

Example: 10
is_enforcedbooleanOptional

Indicates whether the environment property takes precedence over any provided value e.g. true

Default: falseExample: true
Responses
200

Updated environment properties

application/json
put
/api/v1/environment/{idOrSlug}/props
PUT /api/v1/environment/{idOrSlug}/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "max_size",
    "content": "10",
    "is_enforced": true
  }
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "props": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "max_size",
      "content": "10",
      "is_enforced": true
    }
  ]
}
delete

Delete environment props

🔒 Requires the update:environment permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodystring[]
string[]Optional
Responses
200

Updated environment props

application/json
delete
/api/v1/environment/{idOrSlug}/props
DELETE /api/v1/environment/{idOrSlug}/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "props": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "max_size",
      "content": "10",
      "is_enforced": true
    }
  ]
}
get

List environment secrets

🔒 Requires the read:secret permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Responses
200

List of environment secrets

application/json
get
/api/v1/environment/{idOrSlug}/settings/secrets
GET /api/v1/environment/{idOrSlug}/settings/secrets HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "API_TOKEN",
      "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
    }
  ]
}
post

Create environment secrets

🔒 Requires the create:secret permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodyobject[]

List of new environment-scoped secrets

keystringRequired

The secret key e.g. API_TOKEN

Example: API_TOKEN
valuestringRequired

The secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==

Example: ERJZ7ZOJcNpQEAvrb6wPOA==
Responses
200

Updated environment secrets

application/json
post
/api/v1/environment/{idOrSlug}/settings/secrets
POST /api/v1/environment/{idOrSlug}/settings/secrets HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

[
  {
    "key": "API_TOKEN",
    "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
  }
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "API_TOKEN",
      "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
    }
  ]
}
put

Update environment secrets

🔒 Requires the update:secret permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodyobject[]

List of updated environment-scoped secrets

idstring · uuidOptional

The secret ID e.g. 123e4567-e89b-12d3-a456-426614174000

keystringRequired

The secret key e.g. API_TOKEN

Example: API_TOKEN
valuestringRequired

The secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==

Example: ERJZ7ZOJcNpQEAvrb6wPOA==
Responses
200

Updated environment secrets

application/json
put
/api/v1/environment/{idOrSlug}/settings/secrets
PUT /api/v1/environment/{idOrSlug}/settings/secrets HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "key": "API_TOKEN",
    "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
  }
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "API_TOKEN",
      "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
    }
  ]
}
delete

Delete environment secrets

🔒 Requires the delete:secret permission

Authorizations
Path parameters
idOrSlugstringRequired

The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d

Example: production-europe
Bodystring[]
string[]Optional

List of secret keys to delete within the environment

Responses
200

Updated environment secrets

application/json
delete
/api/v1/environment/{idOrSlug}/settings/secrets
DELETE /api/v1/environment/{idOrSlug}/settings/secrets HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
{
  "environment": {
    "guid": "f27d96be-c486-4075-a926-0ee96775119e",
    "slug": "production-europe",
    "cloudAccount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Production Europe",
      "provider": "aws",
      "slug": "production-europe",
      "is_active": true,
      "is_deleted": false,
      "created": "2025-11-11T15:09:51.576Z",
      "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",
        "cluster_name": "text",
        "service_account_namespace": "text",
        "service_account_name": "text",
        "cluster_oidc_url": "https://example.com",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "API_TOKEN",
      "value": "ERJZ7ZOJcNpQEAvrb6wPOA=="
    }
  ]
}
get

List available environment secrets for the user's organization

🔒 Requires the read:environment permission

Authorizations
Query parameters
sortstring · enumOptional

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

Default: created_atPossible values:
orderstringOptional

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

offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10
limitnumberOptional

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 Secret Keys that match a particular query e.g. api_key

Responses
200

List of available environment secrets

application/json
get
/api/v1/environment/settings/secrets
GET /api/v1/environment/settings/secrets HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "API_TOKEN",
      "environment": {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "slug": "production-europe",
        "name": "Production Europe",
        "color": "#0000ff",
        "allow_pre_release": false,
        "is_default": true,
        "is_active": true,
        "is_deleted": true,
        "created": "2025-11-11T15:09:51.576Z",
        "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"
              }
            ]
          }
        ],
        "cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2025-11-11T15:09:51.576Z",
          "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",
            "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"
        }
      },
      "created_at": "2025-11-11T15:09:51.576Z",
      "updated_at": null,
      "created_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg"
      }
    }
  ],
  "filters": {
    "environments": [
      {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "slug": "production-europe",
        "name": "Production Europe",
        "color": "#0000ff",
        "allow_pre_release": false,
        "is_default": true,
        "is_active": true,
        "is_deleted": true,
        "created": "2025-11-11T15:09:51.576Z",
        "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"
              }
            ]
          }
        ],
        "cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2025-11-11T15:09:51.576Z",
          "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",
            "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"
        }
      }
    ],
    "users": [
      {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg"
      }
    ]
  }
}
get

List available environments for the user's organization

🔒 Requires the read:environment permission

Authorizations
Query parameters
allbooleanOptional

If false, return active environments only. If true, return all environments

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

filterstringOptional

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

limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10
sortstring · enumOptional

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

Default: createdPossible values:
searchstringOptional

Enables searching within the list for environment names that match a particular query e.g. prod

Responses
200

List of available deployment environments

application/json
get
/api/v1/environments
GET /api/v1/environments HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "stats": {
    "active": 1,
    "cloud_connected": 1
  },
  "list": [
    {
      "id": "f27d96be-c486-4075-a926-0ee96775119e",
      "slug": "production-europe",
      "name": "Production Europe",
      "color": "#0000ff",
      "allow_pre_release": false,
      "is_default": true,
      "is_active": true,
      "is_deleted": true,
      "created": "2025-11-11T15:09:51.576Z",
      "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"
            }
          ]
        }
      ],
      "cloud_account": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Production Europe",
        "provider": "aws",
        "slug": "production-europe",
        "is_active": true,
        "is_deleted": false,
        "created": "2025-11-11T15:09:51.576Z",
        "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",
          "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"
      },
      "latest_deployment": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "slug": "text",
        "type": "blueprint",
        "name": "text",
        "version": "text",
        "stage": "pending",
        "is_uninstall": true,
        "timestamp": "2025-11-11T15:09:51.576Z",
        "user": {
          "id": "prov0|1234567890",
          "name": "John Doe",
          "nickname": "JD",
          "picture": "https://example.com/profile.jpg"
        }
      }
    }
  ]
}
get

List available Environment properties of an organization

🔒 Requires the read:environment permission

Authorizations
Query parameters
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

filterstringOptional

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

limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10
sortstring · enumOptional

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

Default: created_atPossible values:
searchstringOptional

Enables searching within the list for environment names that match a particular query

packagestringOptional

The package name with version e.g. @bluebricks/[email protected]

Example: @bluebricks/[email protected]
Responses
200

List of available Environment properties of an organization

application/json
get
/api/v1/environments/props
GET /api/v1/environments/props HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "max_size",
      "environment": {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "slug": "production-europe",
        "name": "Production Europe",
        "color": "#0000ff",
        "allow_pre_release": false,
        "is_default": true,
        "is_active": true,
        "is_deleted": true,
        "created": "2025-11-11T15:09:51.576Z",
        "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"
              }
            ]
          }
        ],
        "cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2025-11-11T15:09:51.576Z",
          "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",
            "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"
        }
      },
      "content": "10",
      "is_enforced": true,
      "created_at": "2025-11-11T15:09:51.576Z",
      "updated_at": null,
      "created_by": {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg"
      }
    }
  ],
  "filters": {
    "environments": [
      {
        "id": "f27d96be-c486-4075-a926-0ee96775119e",
        "slug": "production-europe",
        "name": "Production Europe",
        "color": "#0000ff",
        "allow_pre_release": false,
        "is_default": true,
        "is_active": true,
        "is_deleted": true,
        "created": "2025-11-11T15:09:51.576Z",
        "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"
              }
            ]
          }
        ],
        "cloud_account": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Production Europe",
          "provider": "aws",
          "slug": "production-europe",
          "is_active": true,
          "is_deleted": false,
          "created": "2025-11-11T15:09:51.576Z",
          "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",
            "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"
        }
      }
    ],
    "users": [
      {
        "id": "prov0|1234567890",
        "name": "John Doe",
        "nickname": "JD",
        "picture": "https://example.com/profile.jpg"
      }
    ]
  }
}
post

Assign a cloud account to an environment

🔒 Requires the update:environment permission

Authorizations
Path parameters
envIdstring · uuidRequired

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

Example: f27d96be-c486-4075-a926-0ee96775119e
cloudIdstring · uuidRequired

The cloud ID to associate with the environment e.g. 86a6e0b9-65e4-49cc-8d40-ce5dcfbf4eb6

Example: f27d96be-c486-4075-a926-0ee96775119f
Body
is_primarybooleanOptional

Indicate if the cloud is going to be the one used for provisioning in the associated environment

Default: false
profilestringOptional

Profile is a named configuration of a specific cloud account

Example: secrets-manager
Responses
200

Updated environment

application/json
post
/api/v1/environments/{envId}/cloud/{cloudId}
POST /api/v1/environments/{envId}/cloud/{cloudId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "is_primary": false,
  "profile": "secrets-manager"
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Production Europe",
    "provider": "aws",
    "slug": "production-europe",
    "is_active": true,
    "is_deleted": false,
    "created": "2025-11-11T15:09:51.576Z",
    "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",
      "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"
  }
}
delete

Dissociate cloud id from environment

🔒 Requires the update:environment permission

Authorizations
Path parameters
envIdstring · uuidRequired

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

Example: f27d96be-c486-4075-a926-0ee96775119e
cloudIdstring · uuidRequired
Responses
200

Updated environment

application/json
delete
/api/v1/environments/{envId}/cloud/{cloudId}
DELETE /api/v1/environments/{envId}/cloud/{cloudId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "cloud_account": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}
post

Assign a secondary cloud account to an environment

🔒 Requires the update:environment permission

Authorizations
Path parameters
envIdstring · uuidRequired

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

Example: f27d96be-c486-4075-a926-0ee96775119e
cloudIdstring · uuidRequired

The cloud ID to associate with the environment e.g. 86a6e0b9-65e4-49cc-8d40-ce5dcfbf4eb6

Example: f27d96be-c486-4075-a926-0ee96775119f
Body
profilestringRequired

Profile is a named configuration of a specific cloud account

Example: secrets-manager
Responses
200

Updated environment

application/json
post
/api/v1/environments/{envId}/cloud/secondary/{cloudId}
POST /api/v1/environments/{envId}/cloud/secondary/{cloudId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "profile": "secrets-manager"
}
{
  "id": "f27d96be-c486-4075-a926-0ee96775119e",
  "slug": "production-europe",
  "name": "Production Europe",
  "color": "#0000ff",
  "allow_pre_release": false,
  "is_default": true,
  "is_active": true,
  "is_deleted": true,
  "created": "2025-11-11T15:09:51.576Z",
  "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"
        }
      ]
    }
  ],
  "cloud_account": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Production Europe",
    "provider": "aws",
    "slug": "production-europe",
    "is_active": true,
    "is_deleted": false,
    "created": "2025-11-11T15:09:51.576Z",
    "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",
      "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"
  }
}
PreviousDeploymentsNextOrganization

Last updated

Was this helpful?