Skip to content
RoyaleHosting Documentation

API Authentication

Secure authentication is essential when using the RoyaleHosting API. This guide will walk you through the process of obtaining and using API keys to authenticate your requests.

Overview

RoyaleHosting uses API keys for authentication. Each key is:

  • Associated with a specific user account
  • Equipped with its own set of permissions

Creating an API Key

Follow these steps to generate a new API key:

  1. Log in to your RoyaleHosting account
  2. Navigate to the Account Details page
  3. Locate the “API Keys” section
  4. Click on the “Create API Key” button

API Key List

  1. In the modal that appears:
    • Enter a descriptive name for your API key
    • Configure the desired permissions
    • Click “Create”

API Key Creation Process

  1. You can view the API key by clicking on the eye icon.

Important: Treat your API key like a password. Never share it or commit it to version control.

Using Your API Key

To authenticate your API requests:

  1. Include your API key in the token header of your HTTP request

Example using cURL:

Terminal window
curl -H "token: YOUR_API_KEY" https://shield.royalehosting.net/api/v2/rules