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。 |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
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 | リクエストボディ、パスパラメーター、またはクエリパラメーターが不正です。 |
| 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 | 呼び出し元にはこのリソースへのアクセス権限がありません。 |
| 404 | not_found_error | リソースが存在しないか、参照できません。 |
| 500/502/503 | api_error | Forward または依存サービスでエラーが発生しました。 |