APIの書式
注意
このマニュアルでは、REST APIを呼び出す方法について、Linuxでcurlコマンドを使用した例を用いて説明します。WindowsでREST APIを呼び出す場合は、Windowの仕様に従ってください。curlコマンドについては、以下のURLを参照してください。
curlコマンドでREST APIを呼び出す場合の書式は次のとおりです。
なお、書式中で可変文字列となる部分については、以下の例のように斜体を用いて表しています。
例： http://ホスト名:ポート番号/api/v1/agents/agentId |
- REST APIを呼び出すcurlコマンドの書式
|
- リクエストヘッダー
リクエストヘッダーの種類は次のとおりです。
| 種類 | 意味 | 値 |
|---|---|---|
|
Content-Type: |
リクエストのMIMEタイプを指定するヘッダーです。 POSTメソッドまたはPUTメソッドのときに指定します。 |
application/json |
|
Accept: |
レスポンスを受け取るために、許容するMIMEタイプを指定するヘッダーです。 |
application/json |
|
X-API-KEY: |
APIキーを指定するヘッダーです。 APIキー取得APIとAPIキー再取得APIを除く、すべてのAPIで指定します。 |
APIキー取得APIで取得したキーを指定します。 |