Overview

Programmatic access to the Bluebricks control plane.

Only users with appropriate permissions can create API tokens. See Authentication for details on managing API tokens.

Base URL

All API requests should be made to:

https://api.bluebricks.co/api/v1

Common Use Cases

The Bluebricks API enables you to:

• Manage environments and their properties

• Deploy and manage blueprints across environments

• Retrieve deployment status and logs

• Configure cloud account connections

• Automate infrastructure provisioning workflows

Getting Started

To use the Bluebricks API:

1. Authenticate - Create a long-lived API token or use CLI-generated tokens

2. Explore endpoints - Browse the API Reference for detailed specifications

3. Test requests - Use the interactive API documentation to test endpoints

Authentication Options

Long-lived API Tokens (Recommended for automation) Create persistent tokens for automated workflows. See Authentication for details.

JWT Tokens (For personal authentication) Use your JWT token obtained from the CLI or UI for testing. See Authentication for details on extracting JWT tokens.

Quick Example

List all environments in your organization:

curl -X 'GET' \
  'https://api.bluebricks.co/api/v1/environments' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Next Steps

• Authentication - Learn how to create and manage API tokens

• API Reference - Explore all available endpoints

• Webhooks - Set up event-driven integrations