cloadyDoku
API-Referenz
Doku4 Min. Lesezeit

API-Tokens

So erstellst du ein Cloady-API-Token (API-Schlüssel), wählst Scope und Ablaufdatum, nutzt es mit API, CLI, SDKs, Terraform und MCP und widerrufst es.

Ein API-Token, auch API-Schlüssel genannt, lässt ein Skript, einen CI-Job, die CLI, ein SDK, Terraform oder einen KI-Agenten in deinem Namen auf Cloady handeln. Jede Anfrage damit läuft mit deinem Konto, in den Workspaces, zu denen du gehörst, und mit deiner jeweiligen Rolle dort, begrenzt durch den Scope des Tokens.

Ein Token sieht so aus: cldy_, gefolgt von 48 Hexadezimalzeichen.

cldy_3f9a1c07d2b84e65a0c9e1f4b7d2a8c6e05f19b3a7d4c2e8

Token im Dashboard erstellen

  1. Klicke oben rechts auf deinen Avatar und dann auf Account settings.
  2. Öffne den Tab API tokens und klicke auf + New token.
  3. Gib dem Token einen Namen, der sagt, wo es eingesetzt wird, etwa GitHub Actions oder CLI · laptop. Den Namen siehst du später in der Liste.
  4. Wähle einen Scope: Read only, Deploy only oder Full access. Was jeder davon erlaubt, steht unter Scopes.
  5. Wähle ein Ablaufdatum: No expiry, 30 days, 90 days oder 1 year.
  6. Klicke auf Create token.
  7. Kopiere das Token sofort. Cloady zeigt es nur einmal an und speichert nur einen Hash davon, deshalb lässt es sich nicht erneut anzeigen. Wenn du es verlierst, widerrufe es und erstelle ein neues.

Bewahre das Token sicher auf, etwa im Secret-Speicher deines CI-Anbieters oder in einem Passwort-Manager. Füge es nie in ein Support-Ticket, einen Chat oder ein öffentliches Repository ein.

Scopes

Jedes Token hat genau einen Scope. Der Scope legt die höchste Workspace-Rolle fest, mit der das Token handeln kann; deine eigene Rolle in jedem Workspace gilt zusätzlich.

ScopeBezeichnung im DashboardHandelt höchstens alsWas er erlaubt
readRead onlyviewerWorkspaces, Anwendungen, Deploys und Logs auflisten und ansehen. Keine Änderungen.
deployDeploy onlydeveloperAlles, was read erlaubt, plus Apps deployen, neu deployen, starten, stoppen und neu starten, Domains und Variablen verwalten und eine Anwendung löschen.
fullFull accessownerAlles, einschließlich Workspaces anlegen, Workspace-Einstellungen, Mitglieder, Integrationen, Abrechnung und weitere Tokens erstellen.

Wähle den engsten Scope, der die Aufgabe erfüllt:

  • Eine CI-Pipeline oder ein KI-Coding-Agent, der deployt: Deploy only.
  • Ein Dashboard, ein Monitoring oder ein Bericht, der nur liest: Read only.
  • Terraform, das Workspaces anlegt, oder alles, was die Abrechnung ändert: Full access.

Eine Anfrage, die mehr braucht, als der Scope des Tokens erlaubt, bekommt 403 forbidden, auch wenn deine eigene Rolle im Workspace höher ist.

Token verwenden

HTTP-API

Sende das Token bei jeder Anfrage an https://cloady.com/api als Bearer-Token:

Terminal
curl https://cloady.com/api/workspaces \
  -H "Authorization: Bearer cldy_…"

CLI

Terminal
cloady login cldy_…

Die CLI speichert das Token in ~/.config/cloady/config.json. Sie liest außerdem CLOADY_TOKEN aus der Umgebung, was sich für CI-Jobs eignet, und nimmt bei jedem Befehl --token cldy_… an. Siehe den CLI-Leitfaden.

SDKs

TypeScript
import { createCloady } from "@cloady/sdk";

const cloady = createCloady({ auth: process.env.CLOADY_TOKEN });
from cloady import Cloady

cloady = Cloady(base_url="https://cloady.com", token="cldy_…")

Terraform

Der Provider liest CLOADY_TOKEN oder ein Argument token im Provider-Block. Siehe den Terraform-Leitfaden.

Terminal
export CLOADY_TOKEN=cldy_…

MCP

Der Server @cloady/mcp liest das Token aus BEARER_TOKEN_CLOADY:

Terminal
claude mcp add cloady -e BEARER_TOKEN_CLOADY=cldy_… -- npx -y @cloady/mcp

Clients, die sich mit dem gehosteten Server unter https://cloady.com/api/mcp verbinden, melden sich stattdessen über deinen Browser an, und Cloady erstellt das Token für sie. Siehe den MCP-Leitfaden.

Tokens, die Cloady für dich erstellt

Manche Anmeldungen erstellen ein Token in deinem Namen, und diese erscheinen in derselben Liste:

  • cloady login ohne Token meldet dich über deinen Browser an und erstellt ein Token namens Cloady CLI.
  • Wenn du einen MCP-Client oder eine KI-App wie Claude oder ChatGPT mit Cloady verbindest, entsteht ein Token, das nach diesem Client benannt ist, mit dem Scope, den du auf der Zustimmungsseite wählst.

Wenn du eines dieser Tokens widerrufst, wird das jeweilige Tool abgemeldet.

Token über die API erstellen

Ein Token mit Full access oder eine angemeldete Browser-Session kann ein weiteres Token erstellen:

Terminal
curl https://cloady.com/api/me/tokens \
  -H "Authorization: Bearer cldy_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "GitHub Actions", "scope": "deploy", "expires": "90d"}'
FeldWerteStandard
name1–80 ZeichenPflichtfeld
scoperead, deploy, fullfull
expiresnever, 30d, 90d, 1ynever

Die Antwort enthält die Details des neuen Tokens und, nur dieses eine Mal, seinen Wert in secret:

JSON
{
  "token": {
    "id": "…",
    "name": "GitHub Actions",
    "scope": "deploy",
    "prefix": "cldy_3f9a1c0",
    "workspaceId": null,
    "lastUsedAt": null,
    "expiresAt": "2027-02-01T12:00:00.000Z",
    "createdAt": "2026-11-03T12:00:00.000Z"
  },
  "secret": "cldy_…"
}

Die vollständige Referenz findest du unter createToken, listTokens und revokeToken.

Tokens ansehen und widerrufen

Account settings → API tokens listet jedes aktive Token mit seinem Namen, seinem Scope, den ersten 12 Zeichen seines Werts (cldy_3f9a1c0), dem Zeitpunkt der letzten Nutzung und dem Ablaufdatum. Klicke auf Revoke, um ein Token abzuschalten; es funktioniert dann sofort nicht mehr.

Über die API listet GET /api/me/tokens deine Tokens auf, und DELETE /api/me/tokens/{id} widerruft eines.

Widerrufe ein Token, wenn die Person, der Rechner oder der Dienst, der es nutzt, es nicht mehr braucht, und sofort, wenn es geleakt sein könnte. Erstelle dann ein neues.

Fehler

StatusCodeBedeutung
401unauthorizedDas Token fehlt, ist fehlerhaft, abgelaufen oder widerrufen.
403forbiddenDer Scope des Tokens oder deine Rolle im Workspace erlaubt die Anfrage nicht.
404not_foundDu bist kein Mitglied dieses Workspaces, oder die Ressource existiert nicht.

Wie Scopes und Workspace-Rollen bei jeder Anfrage zusammenwirken, steht im API-Überblick.

Auf dieser Seite