Cisco Secure Firewall Threat Defense REST API ガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco Secure Firewall Threat Defense REST API ガイド

Chapter Title

Firepower Threat Defense REST API について

検索結果

Updated:
2019年3月20日

章のタイトル： Firepower Threat Defense REST API について

Firepower Threat Defense REST API について

HTTPS 経由で Firepower Threat Defense REpresentational State Transfer（REST）アプリケーション プログラミング インターフェイス（API）を使用すると、クライアント プログラムを使用して FTD デバイスと通信できます。REST API は、JavaScript Object Notation（JSON）形式を使用してオブジェクトを表します。

Firepower Device Manager には、プログラムで使用可能なすべてのリソースおよび JSON オブジェクトを説明する API エクスプローラが含まれます。エクスプローラは各オブジェクトの属性と値のペアについて詳細情報を提供するため、さまざまな HTTP メソッドを試して各リソースに必要なコーディングを理解することができます。API エクスプローラでは、各リソースに必要な URL の例も示します。

https://developer.cisco.com/site/ftd-api-reference/ では、参照情報と例をオンラインで検索することもできます。

API には独自のバージョン番号があります。API の 1 つのバージョン用に設計されたクライアントが将来のバージョンでエラーなく動作したり、プログラムへの変更が不要である保証はありません。

このプログラミング ガイドの対象読者

このガイドは、プログラミングの一般的な知識と、REST API および JSON の一定の理解があることを前提に書かれています。これらのテクノロジーになじみがない場合は、最初に REST API の一般的なガイドをお読みください。

サポートされる HTTP メソッド

次の HTTP メソッドのみを使用できます。他のメソッドはサポートされません。

  • GET：システムからデータを読み取ります。

  • POST：新しいオブジェクトを作成します。

  • PUT：既存のオブジェクトを変更します。PUT を使用する場合は、JSON オブジェクト全体を含める必要があります。オブジェクト内の個々の属性を選択的に更新することはできません。

  • DELETE：ユーザ定義オブジェクトを削除します。

API のベース URL

指定した FTD デバイスのベース URL を決定する最も簡単な方法は、API エクスプローラで GET メソッドを試し、結果から URL のオブジェクト部分を削除することです。

たとえば、GET /object/networks を実行して、返される出力の要求 URL の下に、次に示すようなものを見ることができます。 


https://ftd.example.com/api/fdm/v1/object/networks

URL のサーバ名の部分は、FTD デバイスのホスト名または IP アドレスで、「ftd.example.com」の代わりに使用デバイスによって異なります。この例では、パスから /object/networks を削除してベース URL を取得します。 


https://ftd.example.com/api/fdm/v1/

リソースのすべての呼び出しは、要求 URL のベースとしてこの URL を使用します。

URL の要素「v」は API バージョンです。通常、これはソフトウェア バージョンに応じて変化します。たとえば、FTD バージョン 6.3.0 の API バージョンは v2 です。そのため、ベース URL は次のようになります。 


https://ftd.example.com/api/fdm/v2/

API エクスプローラで、ページの一番下にスクロールすると、ベース URL（サーバ名を除く）および API のバージョンに関する情報を見ることができます。

Firepower Threat Defense REST API のバージョン履歴

次の表に、API バージョンと関連付けられている FTD リリースの一覧を示します。

REST API バージョン

FTD バージョン

変更内容

v1

6.2.3

これは FTD REST API の最初のリリースです。

v2

6.3.0

バージョン 2 では、FTD 6.3.0 で利用できるすべての新機能のリソースが追加されています。これで、RADIUS サーバを使用する API アクセス向けに外部認証を設定できるようになりました。また、API の v1 で利用できるモデルへの変更が予想されています。このバージョンでは、API URL の v1 を v2 に変更する必要があります。新しいモデルに対して現在使用しているすべてのリソース コールを評価してください。

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ