Obtenir l'environnement actuel

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

Renvoie l'environnement auquel appartient l'identifiant appelant : son ID, son type, sa région, sa cellule, son état et son plan. L'environnement provient toujours de l'identifiant ; ce point de terminaison ne peut pas lire un autre environnement. Le point de terminaison est en lecture seule et disponible sur chaque plan. La source de données OpenTofu/Terraform keenauth_environment le lit.

Demande

Aucun paramètre.

Réponse

200 OK

{
  "id": "env_01h455vb4pex5vsknk084sn02q",
  "type": "production",
  "region": "eu",
  "cell_id": "eu1",
  "state": "active",
  "plan": "business"
}
Champ Description
id ID de l'environnement (env_…).
type development, staging ou production. Il ne change jamais.
region Région des données (eu, us). L'hôte de l'API de gestion est api.<region>.keenauth.com.
cell_id Cellule qui sert l'environnement, par exemple eu1.
state active, suspended_dashboard, suspended_nonprod, export_only ou deleting.
plan free, startup, business, enterprise ou internal ; null tant que le plan n'a pas atteint la cellule. Ne supposez pas de plan lorsque la valeur est null.

Cette version ne renvoie ni le nom d'affichage, ni la date de création, ni l'hôte par défaut, ni les domaines personnalisés. GET /v1/custom-domains liste les domaines personnalisés.

Erreurs

HTTP code Quand
403 insufficient_permissions L'identifiant ne dispose pas de environment-settings:read.
503 service_unavailable Le registre des environnements n'a pas pu être lu ; réessayez plus tard.

Exemple

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

CLI : keenauth environment get