JSONオブジェクト

リストオブジェクトの構造とプロパティ

Lists APIのJSONレスポンスは次の構造を持っています：

{
  "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
  "name": "my_list_name",
  "description": "リストの説明。",
  "kind": "(ip|hostname|asn|redirect)",
  "num_items": 10,
  "num_referencing_filters": 2,
  "created_on": "2021-01-01T08:00:00Z",
  "modified_on": "2021-01-10T14:00:00Z"
}

この表はオブジェクトのプロパティを要約しています：

リストアイテムオブジェクトの構造とプロパティ

各リストタイプ（IPアドレス、ホスト名、ASN、リダイレクト）は、同じタイプのアイテムのみを含むことができます。

IPアドレス

IPアドレスリストアイテムの完全に populated JSONオブジェクトは次の構造を持っています：

{
  "id": "7c5dae5552338874e5053f2534d2767a",
  "ip": "10.0.0.1/32",
  "comment": "CF DNSサーバー",
  "created_on": "2021-10-01T05:20:00.12345Z",
  "modified_on": "2021-10-01T05:20:00.12345Z"
}

ホスト名

ホスト名リストアイテムの完全に populated JSONオブジェクトは次の構造を持っています：

{
  "id": "7c5dae5552338874e5053f2534d2767a",
  "hostname": {
    "url_hostname": "*.example.com"
  },
  "created_on": "2021-10-11T12:39:02Z",
  "modified_on": "2021-10-11T12:39:02Z"
}

ASN

ASNリストアイテムの完全に populated JSONオブジェクトは次の構造を持っています：

{
  "id": "7c5dae5552338874e5053f2534d2767a",
  "asn": 13335,
  "comment": "私のプロバイダーのASN",
  "created_on": "2021-10-11T12:39:02Z",
  "modified_on": "2021-10-11T12:39:02Z"
}

URLリダイレクト

バルクリダイレクトリストアイテムの完全に populated JSONオブジェクトは次の構造を持っています：

{
  "id": "7c5dae5552338874e5053f2534d2767a",
  "redirect": {
    "source_url": "https://example.com/blog",
    "target_url": "https://example.com/blog/latest",
    "status_code": 301,
    "include_subdomains": false,
    "subpath_matching": false,
    "preserve_query_string": false,
    "preserve_path_suffix": true
  },
  "created_on": "2021-10-11T12:39:02Z",
  "modified_on": "2021-10-11T12:39:02Z"
}

プロパティの参照

リストアイテムのJSONオブジェクトプロパティは次のように定義されています：

詳細な仕様については、Lists APIのドキュメントを参照してください。