Get key endpoints

GET /v1/keys/{id}/endpoints lists the connection endpoints that a given API key can reach, one entry per chain and protocol. Use it when your application needs to discover, at runtime, which chains a key is good for and what URL to dial for each — without hard-coding hostnames.

This is a dashboard endpoint: it is authenticated with your logged-in session cookie, not with the key itself. It is intended to be called from the Triport console (or a first-party integration acting on the user's session), typically once after sign-in to populate a client-side endpoint map.

Anti-leak guarantee. The response never contains the raw API key. For https and wss endpoints the url_template field carries a literal {key} placeholder; your client substitutes its locally held raw key into that placeholder to form the final URL. For grpc endpoints there is no placeholder at all — the url field is a bare host:port, and the key is sent out of band as an x-token metadata header on the gRPC connection. Because the key is only ever held client-side, the same call can be made repeatedly and safely logged without exposing the secret.

Path parameters

Empty fields (url_template, url, note) are omitted from the JSON rather than sent as empty strings.

Errors use the platform envelope — a JSON body of the shape { "error": "<tag>" }. When the body is not JSON, clients fall back to an http_<status> tag.

There is no 403: a key you do not own is reported as 404, not "forbidden". See errors.md for the full error envelope shape.

JavaScript (fetch)

// Called from the console — the session cookie is sent automatically.
const res = await fetch(
  `https://api.triport.io/v1/keys/${keyId}/endpoints`,
  { credentials: "include" }
);
if (!res.ok) throw new Error(`endpoints lookup failed: ${res.status}`);


const { key_id, endpoints } = await res.json();


// rawKey is held only on the client and never came from this response.
function resolveUrl(ep, rawKey) {
  if (ep.status === "revoked") {
    cache.evict(key_id); // drop the local raw-key cache
    throw new Error(`key ${key_id} revoked on ${ep.chain_id}`);
  }
  if (ep.status === "scope_missing") {
    throw new Error(`missing scope for ${ep.chain_id}: ${ep.note}`);
  }
  if (ep.protocol === "grpc") {
    // Dial ep.url and attach the key as x-token metadata, not in the URL.
    return { target: ep.url, metadata: { "x-token": rawKey } };
  }
  return ep.url_template.replace("{key}", rawKey);
}

TypeScript SDK (@triport/sdk)

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


const console = new TriportConsole(); // uses the active browser session


const { keyId, endpoints } = await console.keys.endpoints("k_8f3c12ab");


for (const ep of endpoints) {
  if (ep.status === "revoked") {
    console.keys.evictCachedSecret(keyId); // clear the local raw-key cache
    continue;
  }
  if (ep.status !== "enabled") continue;


  const url =
    ep.protocol === "grpc"
      ? ep.url // dial with x-token metadata
      : ep.urlTemplate.replace("{key}", myRawKey);
}

Python (triport-sdk)

from triport import Console


console = Console()  # authenticates with the dashboard session


result = console.keys.endpoints("k_8f3c12ab")


for ep in result["endpoints"]:
    if ep["status"] == "revoked":
        console.keys.evict_cached_secret(result["key_id"])  # drop cached secret
        continue
    if ep["status"] != "enabled":
        continue


    if ep["protocol"] == "grpc":
        target = ep["url"]            # dial with x-token metadata header
    else:
        url = ep["url_template"].replace("{key}", my_raw_key)

• Substitution happens client-side, always. Treat url_template as a template, not a URL. Replacing {key} is your responsibility; the platform deliberately omits the secret so the response is safe to cache and log.
• gRPC auth differs. gRPC endpoints expose only host:port in url. The key travels as the x-token metadata header on the connection — never as part of the URL or in a url_template.
• React to revoked immediately. A revoked status is the signal to purge the raw key from local storage / in-memory caches so it can never be folded into a future request.
• Filtering. Endpoints with status: "scope_missing" are still listed so you can show the user what the key could reach after a scope change; filter on status === "enabled" before connecting.
• Stable ordering. Rows follow the catalogue's chain order, and within a chain follow that chain's declared protocol order, so the list renders consistently between calls.
• Do not persist the resolved URL. Because the raw key is substituted only in memory, treat resolved URLs as ephemeral. The console re-fetches templates rather than caching substituted URLs to disk, and polls roughly once a minute so a revoke performed elsewhere is reflected promptly.
• Related: GET /v1/chains and GET /v1/chains/{id} describe the chains a chain_id refers to.