エンドポイントを変更する

PUT /groups/{groupId}/apps/{appId}/endpoints/{endpointId}

tokenAuth

既存のエンドポイント構成を変更します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
endpointId string 必須

エンドポイントのユニークな _id 値

application/ JSON

body 必須

エンドポイントの有効な更新された構成オブジェクト。

route string 必須
http_method string 必須

値は、GET、POST、PUT、PATCH、DELETE、または * です。
function_id string 必須

エンドポイント関数のユニークな ID。
validation_method string 必須

値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。
secret_id string

validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレットの _id です。
return_type string 必須

データAPIとカスタムエンドポイントによってサポートされているデータ形式。

値は JSON または EJSON です。
respond_result ブール値必須
fetch_custom_user_data ブール値
create_user_on_auth ブール値
disabled ブール値必須
_id string

エンドポイントのユニークな ID。

応答

200 application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- route string 必須
- http_method string 必須
  
  値は、GET、POST、PUT、PATCH、DELETE、または * です。
- function_id string 必須
  
  エンドポイント関数のユニークな ID。
- validation_method string 必須
  
  値は NO_VALIDATION、SECRET_AS_QUERY_PARAM、または VERIFY_PAYLOAD です。
- secret_id string
  
  validation_method が "SECRET_AS_QUERY_PARAM" または "VERIFY_PAYLOAD" に設定されている場合、これはリクエストを承認するシークレットの _id です。
- return_type string 必須
  
  データAPIとカスタムエンドポイントによってサポートされているデータ形式。
  
  値は JSON または EJSON です。
- respond_result ブール値必須
- fetch_custom_user_data ブール値
- create_user_on_auth ブール値
- disabled ブール値必須
- _id string
  
  エンドポイントのユニークな ID。
- function_name string

PUT /groups/{groupId}/apps/{appId}/endpoints/{endpointId}

curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/endpoints/{endpointId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"route":"string","http_method":"GET","function_id":"string","validation_method":"NO_VALIDATION","secret_id":"string","return_type":"JSON","respond_result":true,"fetch_custom_user_data":true,"create_user_on_auth":true,"disabled":true,"_id":"string"}'

リクエスト例

{
  "route": "string",
  "http_method": "GET",
  "function_id": "string",
  "validation_method": "NO_VALIDATION",
  "secret_id": "string",
  "return_type": "JSON",
  "respond_result": true,
  "fetch_custom_user_data": true,
  "create_user_on_auth": true,
  "disabled": true,
  "_id": "string"
}

応答の例（200）

{
  "route": "string",
  "http_method": "GET",
  "function_id": "string",
  "validation_method": "NO_VALIDATION",
  "secret_id": "string",
  "return_type": "JSON",
  "respond_result": true,
  "fetch_custom_user_data": true,
  "create_user_on_auth": true,
  "disabled": true,
  "_id": "string",
  "function_name": "string"
}