Setup

get

Return preflight details for customer to setup cloud credentials

🔒 Requires the read:vendor permission

Authorizations

bearerAuth

Query parameters

vendorstring · uuidOptional

The vendor ID e.g. 33c38d5b-0a1e-4ea0-9c61-e0f7b00868d2

Responses

200

Preflight details of a customer

application/json

400

Failed to get preflight script

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:vendor permission

application/json

404

Preflight vendor not found

application/json

429

Too many requests

application/json

get

/api/v1/setup/preflight

HTTPcURLJavaScriptPython

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

{
  "cloud_provider": "aws",
  "arn": "text",
  "template_url": "text",
  "external_id": "text",
  "organization": "text",
  "stack_name": "text"
}

post

Create cloud account for a vendor from a preflight data

Body

application/json

Responses

200

Created cloud account information

application/json

400

Failed to create cloud account

application/json

409

Cloud account with provided account id already exists

application/json

429

Too many requests

application/json

post

/api/v1/vendor/setup

HTTPcURLJavaScriptPython

POST /api/v1/vendor/setup HTTP/1.1
Host: api.bluebricks.co
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "cloud": {
    "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-10T12:17:43.628Z",
  "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"
  }
}