RESTHeart Cloud is coming soon! Stay tuned!

v8 v7 v6 v5 v4 v3
Edit Page

RESTHeart Cloud - Getting Started

Welcome to RESTHeart Cloud! This guide will help you set up your first API and prepare to use all the examples in our documentation.

Step 1: Sign Up for RESTHeart Cloud

First, create your free account and set up your API instance:

  1. Visit https://cloud.restheart.com and sign up for a free account

  2. Create a new API by clicking "Create API"

  3. Choose the "Dev" tier - it’s completely free and perfect for getting started

  4. Note your API URL - it will look something like https://705560.eu-west-1-test-free-1.restheart.com

Tip
 Keep the RESTHeart Cloud dashboard open in another tab - you’ll need to copy some values from it in the next step.

Step 2: Set Up Root User

Before you can use your API, you need to create a root user with full privileges. This requires the Temporary Admin JWT from your cloud dashboard.

  1. Get your Temporary Admin JWT from the RESTHeart Cloud dashboard

  2. Follow the root user setup guide: Root User Setup

  3. Create your root user with username and password of your choice

Warning
 The Temporary Admin JWT is only valid for a short time and should only be used to create the root user.

Step 3: Configure the Documentation Examples

Now you’re ready to use all the interactive examples in our documentation! Configure the documentation to point to your API:

  1. Set your Instance URL to your API URL (e.g., https://705560.eu-west-1-test-free-1.restheart.com)

  2. Set your Username to the root user you created

  3. Set your Password to the root user password you created

🔧 Configuration

Sets localhost:8080 with admin:secret
Values are saved in your browser

Step 4: Test Your Setup

Let’s verify everything is working by creating your first collection:

cURL

curl -i -X PUT "[INSTANCE-URL]/test-collection" \
  -H "Authorization: Basic [BASIC-AUTH]"

HTTPie

http PUT "[INSTANCE-URL]/test-collection" \
  Authorization:"Basic [BASIC-AUTH]"

JavaScript

fetch('[INSTANCE-URL]/test-collection', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic [BASIC-AUTH]'
  }
})
.then(response => {
  if (response.ok) {
    console.log('Collection created successfully!');
  } else {
    console.error('Failed to create collection:', response.status);
  }
})
.catch(error => console.error('Error:', error));

If this returns a success response, congratulations! Your RESTHeart Cloud API is ready to use.

What’s Next?

Now that your API is set up and configured, you can:

Configuration Persistence

Your configuration settings (Instance URL, Username, Password) are saved in your browser and persist across documentation pages. This means you can browse all our interactive examples and they’ll automatically use your RESTHeart Cloud API.

Troubleshooting

Authentication Issues

  • Make sure you completed the root user setup

  • Verify your username and password are correct

  • Check that your Instance URL doesn’t have a trailing slash

Connection Issues

  • Confirm your API URL is correct (check the RESTHeart Cloud dashboard)

  • Ensure your API instance is running (check the dashboard status)

Need Help?

  • Join our community on Slack

  • Check the FAQ for common questions

  • Contact support through the RESTHeart Cloud dashboard

Free Tier Limits

The Dev tier includes:

  • 120 Requests/Minute Limit

  • 100 Mb storage

  • Community support

Perfect for development, testing, and small projects. You can upgrade anytime as your needs grow.

Ready to build amazing APIs? Let’s dive into the examples! 🚀