KeyAuth
KeyAuth Website
Socials
  • KeyAuth Discord
  • KeyAuth Telegram
  • KeyAuth YouTube
KeyAuth Website
Socials
  • KeyAuth Discord
  • KeyAuth Telegram
  • KeyAuth YouTube
  1. Custom Domain Setup
  • Overview
    • Security Pratices
    • Premade Examples - SDKS
    • QnA
    • Rate Limiting
  • API
    • Getting Started
      • License
        • License Login
        • Redeem License (Upgrade)
      • ⚠️ Initialization ⚠️
      • Login
      • Logout
      • Register
    • Features
      • Chatroom/Messages
        • Retrieve Messages
        • Send Message
      • User Variables
        • Retrieve User Variables
        • Set User Variable
      • Ban User
      • Check Blacklist
      • Check Session
      • Disable 2FA
      • Change Username
      • Download File
      • Enable 2FA
      • Fetch Online Users
      • Forgot Password
      • ⚠️ Fetch Stats ⚠️
      • Log
      • Webhook
      • Retrieve Global Variable
    • Displaying Data
      • Displaying Data
  • Seller API
    • Application Settings
      • Add Application Hash
      • Edit Application Settings
      • Retrieve Application Details
      • Retrieve Current Application Settings
      • Retrieve Stats
      • Pause Application
      • Reset Application hash
      • Unpause Application
    • Blacklists
      • Create New Blacklist
      • Delete An Existing Blacklist
      • Delete All Blacklists
      • Retrieve All Blacklists
    • Chats
      • Create A New Chat Channel
      • Delete Channel Messages
      • Delete Existing Chat Channel
      • Edit Existing Chat Channel
      • Retrieve All Mutes
      • Retrieve All Chat Channels
      • Mute A User
      • Unmute A User
    • Files
      • Delete Existing File
      • Delete All Files
      • Retrieve All Existing Files
      • Retrieve An Existing File
      • Edit An Existing File
      • Upload A New File
    • Global Variables
      • Create A New Global Variable
      • Delete Global Variable
      • Delete All Global Variables
      • Edit Existing Global Variable
      • Retrieve All Global Variables
      • Retrieve An Existing Global Variable
    • Licenses
      • Add Time To All Unused Licenses
      • Assign A License To A User
      • Ban License
      • Create A New License
      • Create A New User Using A License
      • Delete All Licenses
      • Delete An Existing License
      • Delete Multiple Licenses
      • Delete All Used Licenses
      • Delete All Unused Licenses
      • Retrieve All Licenses
      • Retrieve License Information
      • Set Note On Existing License
      • Unban A License
      • Verify License Exists
    • Logs
      • Retrieve All Logs
      • Delete All Logs
    • Sessions
      • End Selected Session
      • End All Sessions
      • Retrieve All Sessions
    • Subscriptions
      • Create A New Subscription
      • Delete An Existing Subscription
      • Edit An Existing Subscription
      • Retrieve All Subscriptions
      • Pause An Existing Subscription
      • Unpause An Existing Subscription
    • Users
      • Add An HWID To An Existing User
      • Ban User
      • Create A New User
      • Change Users Password
      • Change Users Email
      • Change User's Username
      • Delete An Existing User
      • Delete All Expired Users
      • Delete A Users Variable
      • Delete All User Variables Using The Variable Name
      • Delete A Users Subscription
      • Delete All Users
      • Extend Users Expiration
      • Pause A User
      • Retrieve All Users
      • Retrieve All User's Variables
      • Retrieve All Usernames
      • Retrieve All Users Subscriptions
      • Retrieve License From User
      • Retrieve User Variable Data
      • Reset A Users HWID
      • Reset All Users HWID
      • Retrieve User Data
      • Set A User Variable
      • Subtract Time From A Users Expiration
      • Set Users HWID Reset Cooldown Duration
      • Unban A User
      • Unpause A User
      • Verify A User Exists
    • Webhooks
      • Create A New Webhook
      • Delete All Webhooks
      • Delete Webhook
      • Retrieve All Webhooks
    • Web Loader
      • Create A New Web Loader Button
      • Delete A Web Loader Button
      • Delete All Web Loader Buttons
      • Retrieve All Web Loader Buttons
    • Whitelists
      • Add IP To Whitelist
      • Delete All Whitelists
      • Delete Existing IP Whitelist
    • Reseller/Manager Accounts
      • Add Balance To Reseller
      • Create A New Reseller/Manager Account
      • Delete A Reseller or Manager Account
      • Retrieve All Resellers and Managers
      • Retrieve Balance From Reseller
  • Custom Domain Setup
    • Custom Domain (API)
  1. Custom Domain Setup

Custom Domain (API)

💡
Having issues understanding the documentation? Watch our tutorial

Overview#

Some internet service providers (ISP) block requests to our API. One way to get around this is to use a vpn, of course this may not be the ideal for a lot of users, this is where custom domains come into place. A custom domain will allow you to point your own URL to our API and make requests that way.

Getting Started#

1
Step 1
Head over to your application settings
2
Step 2
Click on the "Add Custom domain" button
3
Step 3
Enter your custom domain.
Do not include "https://" in your domain.
4
Step 4
Click on the Add Domain button.
5
Step 5
Click on the Setup Automatically button.
Cloudflare will then open up. Make sure you're signed into the account that has your domain. Then click the "authorize" button.
6
Step 6
After the Cloudflare popup closes, click on the "Check Domain" button.
This process can take up to 1 minute!To prevent caching issues, do not visit your domain during this setup.
7
Step 7
After the 1 minute has passed, click on the "Check Domain" button again and you should get a success response. If not, press the button again, it may take a few more seconds depending on location, speed, domain, etc.

Test It Out#

Open up command prompt on your device and type in,
curl https://yourwebsite.ext/1.0/ -H "user-agent:"
or if you put "api" in the root name, it would be
curl https://yourwebsite.ext/api/1.0/ -H "user-agent:"
If you set it up correctly, you should see:
{"success":false, "message":"Unhandled Type"}

Changing The Url In Your Application#

Lastly, head over to our API class in your application, and search for "https://keyauth.win/api/", you will want to replace this with your new URL.
Modified at 2025-04-06 18:40:58
Previous
Retrieve Balance From Reseller
Built with