API ReferenceHelp Center and Knowledge BaseDownload CLIGo to AppBook a Demo

Cloud Accounts

post

Create cloud credentials for an organization

🔒 Requires the create:cloud permission

Authorizations
Body
one ofOptional
or
or
Responses
200

Created cloud account information

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

{
  "accountSlug": "text",
  "accountName": "text",
  "environment": "text",
  "provider": "aws",
  "roleArnId": "text",
  "cloudFormationStackId": null,
  "accountId": "123456789012",
  "externalId": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production Europe",
  "provider": "aws",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2025-11-11T11:03:41.851Z",
  "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"
  }
}
get

Get cloud account information by id / slug

🔒 Requires the read:cloud permission

Authorizations
Path parameters
idOrSlugstringRequired

The cloud account's slug or ID e.g. main-cloud | f27d96be-c486-4075-a926-0ee96775119d

Responses
200

Cloud account information

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production Europe",
  "provider": "aws",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2025-11-11T11:03:41.851Z",
  "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"
  }
}
delete

Delete cloud account by id / slug. Deleting a cloud account will disable it and delete it

🔒 Requires the delete:cloud permission

Authorizations
Path parameters
idOrSlugstringRequired

The cloud account's slug or ID e.g. main-cloud | f27d96be-c486-4075-a926-0ee96775119d

Responses
200

Deletion success status

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

{
  "success": true
}
get

Get cloud account information by provider and account ID

🔒 Requires the read:cloud permission

Authorizations
Path parameters
providerstringRequired

The cloud provider e.g. aws, gcp, azure

accountIdstringRequired

The cloud account ID e.g. 123456789012

Responses
200

Cloud account information

application/json
get
/api/v1/cloud/provider/{provider}/account/{accountId}
GET /api/v1/cloud/provider/{provider}/account/{accountId} HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production Europe",
  "provider": "aws",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2025-11-11T11:03:41.851Z",
  "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"
  }
}
post

Rotate static authentication token for self-hosted cloud account

🔒 Requires the create:cloud permission

Authorizations
Path parameters
idOrSlugstringRequired

The cloud account's slug or ID e.g. main-cloud | f27d96be-c486-4075-a926-0ee96775119d

Responses
200

Updated cloud account information

application/json
post
/api/v1/cloud/{idOrSlug}/token/rotate
POST /api/v1/cloud/{idOrSlug}/token/rotate HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production Europe",
  "provider": "aws",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2025-11-11T11:03:41.851Z",
  "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"
  }
}
get

List available cloud accounts

🔒 Requires the read:cloud permission

Authorizations
Query parameters
allbooleanOptional

false to list only active cloud accounts, true to also list inactive or deleted ones

Default: false
offsetnumberOptional

Results offset to allow pagination e.g. 10

Default: 0Example: 10
filterstringOptional

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

limitnumberOptional

Results limit to allow pagination, e.g. 50

Default: 20Example: 10
orderstringOptional

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

sortstring · enumOptional

Specifies the attribute by which the returned list should be sorted. Can include the sort direction as ‘asc’ or ‘desc’. e.g. sort=name&order=asc

Default: createdPossible values:
searchstringOptional

Enables searching within the list for cloud names that match a particular query. e.g. search=name

Responses
200

List of available cloud accounts

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

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Production Europe",
    "provider": "aws",
    "slug": "production-europe",
    "is_active": true,
    "is_deleted": false,
    "created": "2025-11-11T11:03:41.851Z",
    "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"
    }
  }
]
PreviousBlueprintsNextDeployments

Last updated

Was this helpful?