TriportRPC
DashboardDocs

Create an API key

Mint a new API key for your account and receive its secret value — returned exactly once, at creation time.

— (account-level; the key itself can be scoped to any network)— (any authenticated session may manage its own keys)— (console management endpoint)

Creates a new API key bound to the currently signed-in account and returns it. The response contains both the key's metadata object and a raw field holding the full secret value (e.g. nl_live_…). This is the only time the full key is ever returned — every later call (list, rotate metadata, endpoint catalogue) exposes only the short key_prefix. Capture and store raw immediately; if you lose it, you must rotate or create a new key.

This endpoint is part of the console surface and is authenticated with your session cookie, not with a Bearer key. (The key you create here is what you then use as Authorization: Bearer … against the RPC endpoints.)

A key carries a set of scopes that decide which networks and capabilities it can reach. Scopes are submitted as public alias strings (for example stream.grpc.solana or provider.gateway_c.eth). If you omit scopes, the key defaults to the * wildcard — one key, every network. Internal brand-bearing identifiers are not accepted on this surface and are rejected as invalid_scope.

Parameters

Request body (application/json)

namestringrequired
Human-readable label. Trimmed; must be 1–80 characters after trimming.
scopesstring[]optional
Public scope aliases granted to the key. Max 32 entries. Defaults to ["*"] (all networks) when omitted or empty.
rate_limitintegeroptional
Per-key request rate limit. Negative values are clamped to 0 (no per-key override). Omit to inherit the account/tier default.
Scope aliasesobject

Response

200 OK

rawstring
The full secret key. Shown only here, only once. Store it now.
key.idstring (uuid)
Stable identifier for the key (used in revoke/rotate paths).
key.namestring
The label you supplied.
key.key_prefixstring
Short, non-secret prefix (nl_live_ + 8 hex) for identifying the key in lists and logs.
key.scopesstring[]
Granted scopes, returned as public aliases.
key.rate_limitinteger
Effective per-key rate limit (0 = no per-key override).
key.statusstring
Lifecycle status; active on creation.
key.created_atstring (RFC 3339)
Creation timestamp.
key.last_used_atstring (RFC 3339)
Last use; omitted until the key is first used.
key.is_defaultboolean
Whether this is the account's default key (always false for keys created here).

Errors

CodeHTTPWhen it happens
invalid_json400Body is not valid JSON or exceeds the 4 KB limit.
invalid_name400name is empty (after trimming) or longer than 80 characters.
too_many_scopes400More than 32 scopes supplied.
invalid_scope400A scope is not a recognized public alias (includes passing an internal/vendor identifier).
unauthenticated401No valid session cookie.
method_not_allowed405A method other than POST was used.
internal500Key generation or persistence failed.

See the shared errors reference for the full error envelope.

Examples

JavaScript (fetch)

// Runs in the authenticated console (session cookie sent automatically).
const res = await fetch("https://api.triport.io/v1/keys", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "prod-backend",
    scopes: ["eth:rpc", "solana:rpc", "stream.grpc.solana"],
    rate_limit: 200,
  }),
});


if (!res.ok) {
  const { error } = await res.json();
  throw new Error(`create key failed: ${error}`);
}


const { key, raw } = await res.json();
// Persist `raw` now — it is never returned again.
console.log("store this secret:", raw, "prefix:", key.key_prefix);

TypeScript SDK (@triport/sdk)

import { ConsoleClient } from "@triport/sdk";


// ConsoleClient operates on the active dashboard session.
const console = new ConsoleClient();


const { key, raw } = await console.keys.create({
  name: "prod-backend",
  scopes: ["eth:rpc", "solana:rpc", "stream.grpc.solana"],
  rateLimit: 200,
});


// `raw` is your only chance to read the full key — save it immediately.
saveSecret(raw);

Python (triport-sdk)

from triport import ConsoleClient


console = ConsoleClient()  # uses the active session


result = console.keys.create(
    name="prod-backend",
    scopes=["eth:rpc", "solana:rpc", "stream.grpc.solana"],
    rate_limit=200,
)


# result["raw"] is shown exactly once — store it now.
save_secret(result["raw"])
print("prefix:", result["key"]["key_prefix"])

Notes

  • Store raw immediately. It is unrecoverable after this response. If lost, use rotate to mint a fresh secret, or create a new key.
  • The default scope (["*"]) grants every network. Supply an explicit scope list to follow least-privilege.
  • key_prefix is safe to log and display; the full raw value must never be logged or placed in a URL.
  • Related: list keys, revoke a key, rotate a key, per-key endpoint catalogue, usage aggregates.