カテゴリー内の他の記事

プロキシ API 設定の更新(PATCH)

Index

プロキシ API 設定の更新

プロキシコードを指定してプロキシ API の設定を更新できます。

HTTP メソッド

PATCH

URI

https://(サブドメイン名).cybozu.com/g/api/v1/system/api/proxies/code/{proxyCode}

使用可能なガルーンのバージョン

  • クラウド版 Garoon

必要なアクセス権

なし

リクエストパラメータ

パラメータ名 指定する値 必須 説明
proxyCode 文字列 必須

設定を更新するプロキシ API のプロキシコードを指定します。

リクエストの例 

PATCH /g/api/v1/system/api/proxies/code/sample HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

パラメータ 指定する値 必須 説明
status 文字列 省略可

プロキシ API 設定のステータス

  • ACTIVE:有効
  • INACTIVE:無効
method 文字列 省略可

HTTP メソッド

GET, POST, PUT, DELETE, PATCH*1 のいずれかを指定します。

url 文字列 省略可

「http://」または「https://」で始まる URL

parameters[].key 文字列 省略可

パラメーターのキー

parameters[].value 文字列 省略可

パラメーターの値

headers[].key 文字列 省略可

ヘッダーのキー

headers[].value 文字列 省略可

ヘッダーの値

body[].key 文字列 省略可

ボディのキー

body[].value 文字列 省略可

ボディの値

*1 PATCH はクラウド版のみ

レスポンスの例

処理が成功すると、プロキシ API の設定が JSON 形式で返されます。

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。