プロキシ API の設定を取得する
プロキシ API の設定を取得する
プロキシ API の設定(
クラウド版
)を取得します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/system/api/admin/proxies/code/プロキシコード
パッケージ版
- Windows 環境
- http://
サーバーの IP アドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/system/api/admin/proxies/code/プロキシコード
- Linux 環境
- http://
サーバーの IP アドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/system/api/admin/proxies/code/プロキシコード
パスパラメーター
パラメーター名 | 説明 |
---|---|
プロキシコード | 設定を取得するプロキシ API のプロキシコード |
HTTP メソッド
GET
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 5.15 以降
必要なアクセス権
- API に関する基本システムの管理者権限(
クラウド版
)
リクエスト
パラメーター
なし
リクエストの例
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 を使ったリクエスト
|
|