プロキシAPIの設定を更新する
プロキシAPIの設定を更新する
プロキシAPIの設定( クラウド版 )を更新します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/system/api/admin/proxies/code/PROXY_CODE
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
IP_ADDRESS_OR_HOST_NAME
:Garoonのインストール先のIPアドレスまたはホスト名INSTALL_IDENTIFER
:Garoonのインストール識別子
- Windows環境
- http://
IP_ADDRESS_OR_HOST_NAME
/scripts/INSTALL_IDENTIFER
/grn.exe/api/v1/system/api/admin/proxies/code/PROXY_CODE
- Linux環境
- http://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/system/api/admin/proxies/code/PROXY_CODE
パスパラメーター
パラメーター名 | 説明 |
---|---|
PROXY_CODE | 設定を更新するプロキシAPIのプロキシコード |
HTTPメソッド
PATCH
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 5.15以降
必要なアクセス権
- APIに関する基本システムの管理者権限( クラウド版 )
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
status | 文字列 | 省略可 | プロキシAPI設定のステータス 次のいずれかの値を指定します。
|
method | 文字列 | 必須 | HTTPメソッド 次のいずれかの値を指定します。
|
url | 文字列 | 必須 | 「http://」または「https://」で始まるURL |
parameters[].key | 文字列 | 省略可 | パラメーターのキー |
parameters[].value | 文字列 | 省略可 | パラメーターの値 |
headers[].key | 文字列 | 省略可 | ヘッダーのキー |
headers[].value | 文字列 | 省略可 | ヘッダーの値 |
body[].key | 文字列 | 省略可 | ボディのキー |
body[].value | 文字列 | 省略可 | ボディの値 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/system/api/admin/proxies/code/sample
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
status | 文字列 | プロキシAPI設定のステータス
|
proxyCode | 文字列 | プロキシコード |
method | 文字列 | HTTPメソッド |
url | 文字列 | URL |
parameters[].key | 文字列 | パラメーターのキー |
parameters[].value | 文字列 | パラメーターの値 |
headers[].key | 文字列 | ヘッダーのキー |
headers[].value | 文字列 | ヘッダーの値 |
body[].key | 文字列 | ボディのキー |
body[].value | 文字列 | ボディの値 |
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|