Forward API リファレンス。
Description
Updates an Environment's configuration and display information with POST.
パス
POST /api/v1/forward/environments/{id}
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または SAT> |
Content-Type | はい | application/json |
パス参数
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | Environment ID。 |
クエリパラメーター
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | No | Identity に属するリソースを操作する場合のみ使用する任意のパラメーターです。PAT では明示的に指定でき、省略時は管理者スコープになります。SAT では Identity スコープのトークンを発行し、このパラメーターを明示的に指定しないでください。指定すると HTTP 400 が返されます。Identity の帰属. |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | いいえ | New name. |
description | string | いいえ | New description. |
config | Environment config | No | New configuration. It must not be null; an explicit null returns 400. See schemas for field details. |
metadata | object | No | Environment metadata to merge. It must not be null; an explicit null returns 400. |
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
The response is an Environment object.
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or query parameters are invalid. SAT が identity_id を明示的に指定した場合も返されます。 |
| 400 | invalid_request_error | If the reserved key created_by is supplied, message is metadata key "created_by" is reserved, identifying the invalid field. |
| 401 | authentication_error | 認証トークンがないか、無効です。 |
| 403 | permission_error | identity_id を指定しない PAT または Admin SAT で Owner mismatch が発生したか、その他の権限が不足しています。 |
| 404 | not_found_error | The resource does not exist or is not visible. identity_id is invalid, disabled, or does not belong to the caller, or the target resource does not belong to the current Identity scope. |
| 500/502/503 | api_error | Forward または依存サービスでエラーが発生しました。 |