Cloudgate
Start free trial
MenuClose

Personal keys

A personal key lets a script sign in as you without your password. Create one for CI, a deploy pipeline or a script that calls the Cloudgate API.

Every memberActs with your role

A personal key carries everything your role allows, in your default Organization, or in the one a request names with the x-organization-id header. The CLI uses one in CI as CLOUDGATE_KEY.

What you can do

  • Create keys for scripts, CI and the CLI, each with its own name and expiry.
  • See when each key was last used.
  • Revoke a key; it stops working immediately.

Create a personal key

  1. Open Personal keys

    Open Settings > Account. Under Personal keys, press Create a key.

    cloudgate.octabyte.app/settings/account
    Each key shows how it starts, when it was last used and when it expires.

  2. Name it and choose its expiry

    In Create a personal key, give it a Name after what will use it, such as Deploy pipeline, so you know which one to revoke later. Add an optional Prefix, such as cg_ci, to make it recognisable in a log or a secrets store. Under Expires, choose In 30 days, In 90 days (the default), In a year or Never.

  3. Copy it

    Press Create key. Your new personal key is shown once: copy it into your secrets store, then press I have copied it.

Use it in a request with the x-api-key header. On a self-hosted instance, use your own console’s address:

curl -H "x-api-key: $CLOUDGATE_KEY" https://cloudgate.octabyte.app/backend/users/me/whoami

The API authentication page has the details, and CLI in CI shows how the CLI reads CLOUDGATE_KEY.

Log in the CLI without copying a key

cloudgate login shows a code; approve it in the console at /device. That makes a personal key for the CLI that lasts 90 days.

Revoke a key

On the key’s row, press Revoke, then Revoke key. It stops working immediately.

What you cannot do

Your Account page also holds your Profile, Password, Two-factor sign-in (with 10 backup codes) and Sessions, where you can sign out every other session.

Questions

What can a personal key do?

Everything you can do, in your default Organization or the one a request names. It is not limited to a scope.

Can an AI agent use my personal key?

No. The MCP endpoint and the Gateway refuse personal keys. Create an Agent and use its agent key instead.

How long does a key last?

You choose: in 30 days, in 90 days (the default), in a year, or never. A key made by cloudgate login lasts 90 days.

Something missing or wrong on this page? Email support@octabyte.io, or start a free trial and try it in the console.