Index
プロキシ API 設定の取得
プロキシコードを指定してプロキシ API の設定を取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/system/api/admin/proxies/code/{proxyCode}
パッケージ版（Windows環境）
以下は、ヘルプに記載している Windows のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/system/api/admin/proxies/code/{proxyCode}
パッケージ版（Linux環境）
以下は、ヘルプに記載している Linux のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/system/api/admin/proxies/code/{proxyCode}
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 5.15.0 以降
必要なアクセス権
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| proxyCode | 文字列 | 必須 |
設定を取得するプロキシ API のプロキシコードを指定します。 |
リクエストの例
GET /g/api/v1/system/api/admin/proxies/code/sample HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Type ヘッダは不要です。
レスポンスの例
処理が成功すると、プロキシ API の設定が JSON 形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| status | 文字列 |
プロキシ API 設定のステータス
|
| proxyCode | 文字列 |
プロキシコード |
| method | 文字列 |
HTTP メソッド |
| url | 文字列 |
URL |
| parameters[].key | 文字列 |
パラメーターのキー |
| parameters[].value | 文字列 |
パラメーターの値 |
| headers[].key | 文字列 |
ヘッダーのキー |
| headers[].value | 文字列 |
ヘッダーの値 |
| body[].key | 文字列 |
ボディのキー |
| body[].value | 文字列 |
ボディの値 |
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。