Fireboost.io API Documentation

Fireboost is a RESTful service that lets you push structured JSON data — such as CMS content — to a globally distributed cache, making it available to users with millisecond response times and minimal setup.

Overview

Fireboost allows you to:

• Push JSON data and store it under cache keys.
• Organize data into projects, each with its own unique subdomain.
• Instantly serve data from the edge—public or private access with JWT authentication.

Getting Started

To begin, create an account and generate an API key in your Fireboost dashboard. Then follow the guides to authenticate, push data, and retrieve cached responses using our HTTP API or SDKs.

Step 1: Create an account and generate an API key in the Fireboost Dashboard.
Step 2: Authenticate using your API key to get a JWT access token.
Step 3: Push some JSON data to a cache key using your JWT access token.
Step 4: Retrieve it instantly from your project's unique edge URL.

Understanding Projects and Cache Keys

Each account can have multiple projects, and every project has its own unique subdomain:

https://{your-project-name}.api.fireboost.io
https://{your-other-project-name}.api.fireboost.io

Cache Keys

• Each project can store many cache entries, identified by a cache key.
• A project can store both public and private cache keys.
• Public cache keys are accessible without an JWT.

Use cache keys to organize and retrieve JSON content, such as site data, settings, or custom resources.

Public cache keys

available at:

 https://{your-project-name}.api.fireboost.io/v1/public-cache/get/{your-cache-key}
 https://{your-project-name}.api.fireboost.io/v1/public-cache/get/{your-other-cache-key}

Private cache keys

available at:

 https://{your-project-name}.api.fireboost.io/v1/cache/get/{your-private-cache-key}
 https://{your-project-name}.api.fireboost.io/v1/cache/get/{your-private-cache-key-2}

Supported Operations

Fireboost supports four core operations:

Authentication: Get a JWT from an API key.
Write: Push or update JSON data.
Public Read: Retrieve public cache data.
Private Read: Retrieve protected cache data (requires a JWT).
Delete: Remove a cache entry.