• Established in 2018
  • Developed in the UK
  • Over 9000 Users Worldwide
  • 194 Million Patches Delivered

LaunchBoost.io

Login
Plans
Priority SupportVIP
Skip the queue on Discord
/Documentation/Developer Dashboard/API Keys

API Keys

Generating at least one API Key should be the first thing you do before anything else on LaunchBoost.io

Before you can interact with your account or a project, you will need at least one API Key.

API Keys can be generated for different usage. For example, if you want your game to interact with your patch system, you could use one API Key. If you wanted an installer to interact with your patch system, you could use a second API Key. This allows you to differentiate which application accessed your patch system in the patch logs.

Generating more than one API Key is optional and you can just use the one API Key wherever you like, if you wish.

Having multiple API Keys gives you the benefit of being able to see which applications are using your API key and you also have the ability to disable or rotate the API key at any time.

Pro accounts are limited to one API Key. Developer accounts can generate up to 10.

Generating an API Key should be the first thing you do before doing anything else with LaunchBoost.io.

Your API Keys are exclusive to your account only. Whilst impossible to keep 100% secure, you should be careful to not expose your API Key where possible, for security and account abuse purposes.

You should encrypt/compress your API Key where possible inside code etc. but send it in the command line as plain text.

How to Use an API Key

You need your API Key to access your LaunchBoost account from various places.

Firstly, when you create a new project with the Patch Builder application, you will need one of your API Keys to do this.

Secondly, in order to run the patch system on a clients machine, you will need to send the API Key as part of the command line, along with your project slug like this…

Plain Text
patch.exe -apiKey=lb_***** -project_slug=my_project_slug

Rotating an API Key

You can “rotate” an API Key by clicking the Rotate button in your API dashboard section.

This will generate a new API Key in place of that. Use this wisely as it will break any static connections you have from systems that launch your patch system.

The best standard of practice is to NOT hard-code your API Key into your game, game launcher or application that launches your patch system. Instead, store your API Key online somewhere (your web server), download it at the start. This way if you ever rotate the key, you can simply update it online in your text file and anything that uses that file, should be just fine to continue loading the patch system. It’s best to use encryption methods when storing it online.

Disabling an API Key

Disabling an API Key will disable it everywhere. This is useful to use if you suspect the key has been compromised or been leaked and is causing problems with your account. You can re-enable at any time.

Deleting an API Key

This will permanently delete your API Key. It is not recommended to do this unless absolutely necessary. You should simply disable or rotate an API Key before deleting.

PreviousDashboard IntroductionNext Projects