MultiConnectMultiConnectDocs Website home
MultiConnectCloud › MultiConnectCloud

5. Access keys

An access key lets something other than you, such as the MultiConnect CLI, your backend or your game, talk to MultiConnectCloud. Each key has two parts: the Access Key and the Secret.

A key does nothing until you attach it to a deployment. It then reaches only the deployments it is attached to.

Key kinds

When you create a key, choose its kind under Key type:

Switch What the key can do Keep it secret?
None Look up a Server deployment's servers and connection details from your own backend Yes
Allow deploys (CLI) Upload builds and redeploy, and read status, connection details, usage and your balance. For the MultiConnect CLI and CI pipelines Yes. Store it as a CI secret, never in your code
Manage instances Start and stop on-demand game servers from your own backend. This spends credits Yes
Client-distributable (connection lookup only) Look up connection details, nothing else. Safe to ship inside a game client or app No, it is assumed public

Allow deploys (CLI) and Manage instances can be on together. Client-distributable cannot be combined with either of them; create two keys instead.

A master server that uses MultiConnectSDK does not need a Manage instances key.

Create a key

  1. Open Access Keys and choose Create Access Key.
  2. Enter an Access Key Name: letters and numbers only, at most 10 characters, and not already used by another key.
  3. Choose an Expiry Time: 7, 30, 90 or 180 days, 1, 5 or 10 years, or Never Expires. The default is 90 days.
  4. Set the Key type switches, and choose Submit.
  5. Access Key Details shows the access key and the secret. Copy them now: they are shown only once.

The table marks each key's kind with CLI, Instances or Client.

Attach a key to a deployment

  1. From the dashboard, open your project, then the deployment.
  2. In Access Keys, search for the key and select it.

Attaching and removing take effect at once, with no redeploy. A deployment can have at most 5 keys. Expired or deleted keys cannot be attached.

Deployment type Which keys it accepts
Server Every kind
API Every kind. Requests to your API never need a platform key; a key with Allow deploys (CLI) lets the CLI deploy it
Website Only keys with Allow deploys (CLI)
Database Only keys with Allow deploys (CLI). Your apps reach the database with its own credentials

Regenerate or delete a key

Select a key on Access Keys: