Cloud Accounts

post

Create cloud credentials for an organization

🔒 Requires the create:cloud permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

or

or

Responses

200

Created cloud account information

application/json

Created cloud account information

idstring · uuidRequired

The unique identifier of the cloud account e.g. 018fae46-7d2e-78e4-80fb-7b043314d4ca

namestringRequired

The name of the cloud account e.g. Production Europe

Example: Production Europe

providerstring · enumRequired

The cloud provider e.g. aws

Example: awsPossible values:

typestring · enumRequired

The type of the cloud account

Default: executionPossible values:

slugstringRequired

The slug of the cloud account e.g. production-europe

Example: production-europe

is_activebooleanRequired

The status of the cloud account e.g. true

is_deletedbooleanRequired

The deletion status of the cloud account e.g. false

Example: false

createdstring · date-timeRequired

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

cloud_accountstring · nullableRequired

[AWS]: The external cloud account identifier e.g. 123456789012

[GCP]: The project id e.g. project-id-123456789012

Example: 123456789012

assume_role_arnstring · nullableRequired

[AWS only] The role assumed for this cloud account e.g. arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

Example: arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

external_idstring · nullableRequired

[AWS only] The external identifier used to assume the role e.g. abcdef-ghijkl

Example: abcdef-ghijklm

400

Failed to create cloud account

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:cloud permission

application/json

404

Organization not found

application/json

409

Cloud account with provided account id already exists

application/json

429

Too many requests

application/json

500

Internal server error occurred while creating cloud account

application/json

post

/api/v1/cloud

HTTPcURLJavaScriptPython

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

{
  "accountSlug": "text",
  "accountName": "text",
  "type": "execution",
  "collection": "text",
  "provider": "aws",
  "roleArnId": "text",
  "cloudFormationStackId": null,
  "accountId": "123456789012",
  "externalId": "text"
}

{
  "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-03T05:00:20.155Z",
  "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"
  }
}

get

Get cloud account information by id / slug

🔒 Requires the read:cloud permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Cloud account information

idstring · uuidRequired

The unique identifier of the cloud account e.g. 018fae46-7d2e-78e4-80fb-7b043314d4ca

namestringRequired

The name of the cloud account e.g. Production Europe

Example: Production Europe

providerstring · enumRequired

The cloud provider e.g. aws

Example: awsPossible values:

typestring · enumRequired

The type of the cloud account

Default: executionPossible values:

slugstringRequired

The slug of the cloud account e.g. production-europe

Example: production-europe

is_activebooleanRequired

The status of the cloud account e.g. true

is_deletedbooleanRequired

The deletion status of the cloud account e.g. false

Example: false

createdstring · date-timeRequired

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

cloud_accountstring · nullableRequired

[AWS]: The external cloud account identifier e.g. 123456789012

[GCP]: The project id e.g. project-id-123456789012

Example: 123456789012

assume_role_arnstring · nullableRequired

[AWS only] The role assumed for this cloud account e.g. arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

Example: arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

external_idstring · nullableRequired

[AWS only] The external identifier used to assume the role e.g. abcdef-ghijkl

Example: abcdef-ghijklm

400

Failed to retrieve cloud account

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:cloud permission

application/json

404

Cloud account not found

application/json

429

Too many requests

application/json

get

/api/v1/cloud/{idOrSlug}

HTTPcURLJavaScriptPython

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",
  "type": "execution",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2026-03-03T05:00:20.155Z",
  "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"
  }
}

delete

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

🔒 Requires the delete:cloud permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Deletion success status

successbooleanOptional

400

Failed to delete cloud account

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the delete:cloud permission

application/json

429

Too many requests

application/json

delete

/api/v1/cloud/{idOrSlug}

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Cloud account information

idstring · uuidRequired

The unique identifier of the cloud account e.g. 018fae46-7d2e-78e4-80fb-7b043314d4ca

namestringRequired

The name of the cloud account e.g. Production Europe

Example: Production Europe

providerstring · enumRequired

The cloud provider e.g. aws

Example: awsPossible values:

typestring · enumRequired

The type of the cloud account

Default: executionPossible values:

slugstringRequired

The slug of the cloud account e.g. production-europe

Example: production-europe

is_activebooleanRequired

The status of the cloud account e.g. true

is_deletedbooleanRequired

The deletion status of the cloud account e.g. false

Example: false

createdstring · date-timeRequired

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

cloud_accountstring · nullableRequired

[AWS]: The external cloud account identifier e.g. 123456789012

[GCP]: The project id e.g. project-id-123456789012

Example: 123456789012

assume_role_arnstring · nullableRequired

[AWS only] The role assumed for this cloud account e.g. arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

Example: arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

external_idstring · nullableRequired

[AWS only] The external identifier used to assume the role e.g. abcdef-ghijkl

Example: abcdef-ghijklm

400

Failed to retrieve cloud account

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:cloud permission

application/json

404

Cloud account not found

application/json

429

Too many requests

application/json

get

/api/v1/cloud/provider/{provider}/account/{accountId}

HTTPcURLJavaScriptPython

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",
  "type": "execution",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2026-03-03T05:00:20.155Z",
  "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"
  }
}

post

Rotate static authentication token for self-hosted cloud account

🔒 Requires the create:cloud permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Updated cloud account information

idstring · uuidRequired

The unique identifier of the cloud account e.g. 018fae46-7d2e-78e4-80fb-7b043314d4ca

namestringRequired

The name of the cloud account e.g. Production Europe

Example: Production Europe

providerstring · enumRequired

The cloud provider e.g. aws

Example: awsPossible values:

typestring · enumRequired

The type of the cloud account

Default: executionPossible values:

slugstringRequired

The slug of the cloud account e.g. production-europe

Example: production-europe

is_activebooleanRequired

The status of the cloud account e.g. true

is_deletedbooleanRequired

The deletion status of the cloud account e.g. false

Example: false

createdstring · date-timeRequired

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

cloud_accountstring · nullableRequired

[AWS]: The external cloud account identifier e.g. 123456789012

[GCP]: The project id e.g. project-id-123456789012

Example: 123456789012

assume_role_arnstring · nullableRequired

[AWS only] The role assumed for this cloud account e.g. arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

Example: arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

external_idstring · nullableRequired

[AWS only] The external identifier used to assume the role e.g. abcdef-ghijkl

Example: abcdef-ghijklm

400

Failed to update cloud account

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the create:cloud permission

application/json

404

Cloud account not found

application/json

429

Too many requests

application/json

post

/api/v1/cloud/{idOrSlug}/token/rotate

HTTPcURLJavaScriptPython

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",
  "type": "execution",
  "slug": "production-europe",
  "is_active": true,
  "is_deleted": false,
  "created": "2026-03-03T05:00:20.155Z",
  "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"
  }
}

get

List available cloud accounts

🔒 Requires the read:cloud permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

List of available cloud accounts

idstring · uuidRequired

The unique identifier of the cloud account e.g. 018fae46-7d2e-78e4-80fb-7b043314d4ca

namestringRequired

The name of the cloud account e.g. Production Europe

Example: Production Europe

providerstring · enumRequired

The cloud provider e.g. aws

Example: awsPossible values:

typestring · enumRequired

The type of the cloud account

Default: executionPossible values:

slugstringRequired

The slug of the cloud account e.g. production-europe

Example: production-europe

is_activebooleanRequired

The status of the cloud account e.g. true

is_deletedbooleanRequired

The deletion status of the cloud account e.g. false

Example: false

createdstring · date-timeRequired

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

cloud_accountstring · nullableRequired

[AWS]: The external cloud account identifier e.g. 123456789012

[GCP]: The project id e.g. project-id-123456789012

Example: 123456789012

assume_role_arnstring · nullableRequired

[AWS only] The role assumed for this cloud account e.g. arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

Example: arn:aws:iam::123456789012:role/Bluebricks-Setup-BluebricksReadOnlyRole-123abc456DEF

external_idstring · nullableRequired

[AWS only] The external identifier used to assume the role e.g. abcdef-ghijkl

Example: abcdef-ghijklm

400

Failed to list available cloud accounts

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:cloud permission

application/json

429

Too many requests

application/json

get

/api/v1/clouds

HTTPcURLJavaScriptPython

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",
    "type": "execution",
    "slug": "production-europe",
    "is_active": true,
    "is_deleted": false,
    "created": "2026-03-03T05:00:20.155Z",
    "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"
    }
  }
]