現在の環境を取得する
GET /v1/environment · 権限 environment-settings:read
呼び出し元の資格情報が属する環境を返します。ID、種類、リージョン、セル、状態、プランが含まれます。環境は常に資格情報から決まり、このエンドポイントで別の環境を読むことはできません。このエンドポイントは読み取り専用で、すべてのプランで利用できます。OpenTofu/Terraform のデータソース keenauth_environment がこれを読み取ります。
リクエスト
パラメータはありません。
レスポンス
200 OK
{
"id": "env_01h455vb4pex5vsknk084sn02q",
"type": "production",
"region": "eu",
"cell_id": "eu1",
"state": "active",
"plan": "business"
}
| フィールド | 説明 |
|---|---|
id |
環境のID(env_…)。 |
type |
development、staging、production のいずれか。変わることはありません。 |
region |
データのリージョン(eu、us)。管理APIのホストは api.<region>.keenauth.com です。 |
cell_id |
環境を提供するセル(例: eu1)。 |
state |
active、suspended_dashboard、suspended_nonprod、export_only、deleting のいずれか。 |
plan |
free、startup、business、enterprise、internal のいずれか。プランがセルに反映されるまでは null です。null の場合はプランを推測しないでください。 |
このバージョンでは、表示名、作成日時、既定のホスト、カスタムドメインは返されません。カスタムドメインは GET /v1/custom-domains で一覧できます。
エラー
| HTTP | code | 情況 |
|---|---|---|
| 403 | insufficient_permissions |
資格情報に environment-settings:read がありません。 |
| 503 | service_unavailable |
環境のレジストリを読み取れませんでした。後で再試行してください。 |
例
curl -i https://api.eu.keenauth.com/v1/environment \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth environment get