Skip to main content

Introduction to the Fluence Console API

The Fluence Console API provides programmatic access to the decentralized Fluence compute marketplace, allowing developers to find, rent, and manage compute resources without using the web interface. With this API, you can integrate Fluence's decentralized compute capabilities directly into your applications and workflows.

info

All API endpoints are available at:

https://api.fluence.dev

What You Can Do with the Fluence Console API​

The API enables you to:

  1. Search the Marketplace - Find compute resources that match your specific requirements including CPU, memory, storage, geographic location, and budget
  2. Deploy Virtual Machines - Create and configure VMs with your choice of operating system and network settings
  3. Manage deployments - View your active VMs, change their configuration, and delete them when no longer needed
  4. Manage personal resources - View and edit SSH keys and other personal resources

Authentication​

The Fluence Console API uses API keys for authentication. All requests must include your API key in the Authorization header. You can read more about API keys creation and management in the Fluence Console Settings guide.

Using Your API Key​

Include your API key in the Authorization header with all API requests:

curl -X POST https://api.fluence.dev/vms/v3 \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Request and Response Format​

The Fluence Console API accepts and returns data in JSON format. When making POST requests, set the Content-Type header to application/json:

curl -X POST https://api.fluence.dev/marketplace/offers \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -d '{
    "basicConfiguration": "cpu-4-ram-8gb-storage-25gb"
  }'

Common API Endpoints​

The API is organized around these main resource areas:

EndpointDescription
/marketplace/*Endpoints for searching and discovering available compute offerings
/vms/*Endpoints for deploying and managing virtual machines
info

You can find detailed information about all API endpoints in the Fluence Console API Reference.

Next Steps​

Now that you are familiar with the basics of the Fluence Console API, you can explore the following guides to learn more:

  1. Finding Compute Resources on the Fluence Marketplace - Learn how to search for and compare compute offerings that match your requirements
  2. Deploying Virtual Machines on the Fluence Marketplace - Learn how to deploy and configure VMs
  3. Managing Your Virtual Machines on Fluence - Learn how to view, monitor, and delete your VMs