Aktuelle Umgebung abrufen

GET /v1/environment · Berechtigung environment-settings:read

Gibt die Umgebung zurück, zu der das aufrufende Credential gehört: ihre ID, ihren Typ, ihre Region, Cell, ihren Status und ihren Plan. Die Umgebung stammt immer aus dem Credential; dieser Endpunkt kann keine andere Umgebung lesen. Der Endpunkt ist schreibgeschützt und auf jedem Plan verfügbar. Die OpenTofu/Terraform-Datenquelle keenauth_environment liest ihn.

Anfrage

Keine Parameter.

Antwort

200 OK

{
  "id": "env_01h455vb4pex5vsknk084sn02q",
  "type": "production",
  "region": "eu",
  "cell_id": "eu1",
  "state": "active",
  "plan": "business"
}

Feld	Beschreibung
`id`	Umgebungs-ID (`env_…`).
`type`	`development`, `staging` oder `production`. Er ändert sich nie.
`region`	Datenregion (`eu`, `us`). Der Host der Verwaltungs-API ist `api.<region>.keenauth.com`.
`cell_id`	Cell, die die Umgebung bedient, zum Beispiel `eu1`.
`state`	`active`, `suspended_dashboard`, `suspended_nonprod`, `export_only` oder `deleting`.
`plan`	`free`, `startup`, `business`, `enterprise` oder `internal`; `null`, bis der Plan die Cell erreicht hat. Nehmen Sie bei `null` keinen Plan an.

Diese Version gibt weder Anzeigenamen, Erstellungszeitpunkt, Standard-Host noch benutzerdefinierte Domains zurück. GET /v1/custom-domains listet die benutzerdefinierten Domains auf.

Fehler

HTTP	Code	Wann
403	`insufficient_permissions`	Dem Credential fehlt `environment-settings:read`.
503	`service_unavailable`	Die Umgebungsverwaltung konnte nicht gelesen werden; versuchen Sie es später erneut.

Beispiel

curl -i https://api.eu.keenauth.com/v1/environment \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth environment get