Skip to content

Commit 1e0cba3

Browse files
pedrosousapedrosousa
committed
[WAF] Add back missing tables
1 parent f6c786c commit 1e0cba3

File tree

1 file changed

+211
-39
lines changed

1 file changed

+211
-39
lines changed

‎src/content/docs/waf/tools/lists/lists-api/json-object.mdx‎

Lines changed: 211 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,112 @@ head:
77
- tag: title
88
content: List JSON object
99
description: Reference information on the JSON object used in Lists API calls.
10-
1110
---
1211

12+
import { Type } from "~/components";
13+
1314
## List object structure and properties
1415

1516
A JSON response for the [Lists API](/api/resources/rules/subresources/lists/methods/list/) has this structure:
1617

1718
```json
1819
{
19-
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
20-
"name": "my_list_name",
21-
"description": "List description.",
22-
"kind": "(ip|hostname|asn|redirect)",
23-
"num_items": 10,
24-
"num_referencing_filters": 2,
25-
"created_on": "2021-01-01T08:00:00Z",
26-
"modified_on": "2021-01-10T14:00:00Z"
20+
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
21+
"name": "my_list_name",
22+
"description": "List description.",
23+
"kind": "(ip|hostname|asn|redirect)",
24+
"num_items": 10,
25+
"num_referencing_filters": 2,
26+
"created_on": "2021-01-01T08:00:00Z",
27+
"modified_on": "2021-01-10T14:00:00Z"
2728
}
2829
```
2930

3031
This table summarizes the object properties:
3132

32-
33+
{/* prettier-ignore */}
34+
<table>
35+
<thead>
36+
<tr>
37+
<th>Property</th>
38+
<th>Description</th>
39+
<th>Constraints</th>
40+
</tr>
41+
</thead>
42+
<tbody style="vertical-align:top">
43+
<tr>
44+
<td>
45+
<code>id</code><br />
46+
<Type text="String" />
47+
</td>
48+
<td>A UUIDv4 identifier generated by Cloudflare.</td>
49+
<td>
50+
<p>Unique, read only.</p>
51+
<p>Length: 32 characters.</p>
52+
</td>
53+
</tr>
54+
<tr>
55+
<td>
56+
<code>name</code><br />
57+
<Type text="String" />
58+
</td>
59+
<td>An informative name for the list.</td>
60+
<td>
61+
<p>Maximum length: 50 characters.</p>
62+
<p>Only alphanumeric and underscore (<code>\_</code>) characters are valid.</p>
63+
<p>A valid name satisfies this regular expression: <code>^[a-zA-Z0-9_]+$</code>.</p>
64+
</td>
65+
</tr>
66+
<tr>
67+
<td>
68+
<code>description</code><br />
69+
<Type text="String" />
70+
</td>
71+
<td>An informative summary of the list.</td>
72+
<td>Maximum length: 500 characters.</td>
73+
</tr>
74+
<tr>
75+
<td>
76+
<code>kind</code><br />
77+
<Type text="String" />
78+
</td>
79+
<td>The type of data in the list.</td>
80+
<td>Valid values: <code>ip</code>, <code>hostname</code>, <code>asn</code>, <code>redirect</code>.</td>
81+
</tr>
82+
<tr>
83+
<td>
84+
<code>num_items</code><br />
85+
<Type text="Number" />
86+
</td>
87+
<td>The number of items in the list.</td>
88+
<td>Read only.</td>
89+
</tr>
90+
<tr>
91+
<td>
92+
<code>num_referencing_filters</code><br />
93+
<Type text="Number" />
94+
</td>
95+
<td>The number of filters that reference this list.</td>
96+
<td>Read only.</td>
97+
</tr>
98+
<tr>
99+
<td>
100+
<code>created_on</code><br />
101+
<Type text="String" />
102+
</td>
103+
<td>The <a href='https://datatracker.ietf.org/doc/html/rfc3339'>RFC 3339</a> timestamp the list was created.</td>
104+
<td>Read only.</td>
105+
</tr>
106+
<tr>
107+
<td>
108+
<code>modified_on</code><br />
109+
<Type text="String" />
110+
</td>
111+
<td>The <a href='https://datatracker.ietf.org/doc/html/rfc3339'>RFC 3339</a> timestamp when the list was last modified.</td>
112+
<td>Read only.</td>
113+
</tr>
114+
</tbody>
115+
</table>
33116

34117
## List item object structure and properties
35118

@@ -41,11 +124,11 @@ A fully populated JSON object for an IP address list item has the following stru
41124

42125
```json
43126
{
44-
"id": "7c5dae5552338874e5053f2534d2767a",
45-
"ip": "10.0.0.1/32",
46-
"comment": "CF DNS server",
47-
"created_on": "2021-10-01T05:20:00.12345Z",
48-
"modified_on": "2021-10-01T05:20:00.12345Z"
127+
"id": "7c5dae5552338874e5053f2534d2767a",
128+
"ip": "10.0.0.1/32",
129+
"comment": "CF DNS server",
130+
"created_on": "2021-10-01T05:20:00.12345Z",
131+
"modified_on": "2021-10-01T05:20:00.12345Z"
49132
}
50133
```
51134

@@ -55,12 +138,12 @@ A fully populated JSON object for a hostname list item has the following structu
55138

56139
```json
57140
{
58-
"id": "7c5dae5552338874e5053f2534d2767a",
59-
"hostname": {
60-
"url_hostname": "*.example.com"
61-
},
62-
"created_on": "2021-10-11T12:39:02Z",
63-
"modified_on": "2021-10-11T12:39:02Z"
141+
"id": "7c5dae5552338874e5053f2534d2767a",
142+
"hostname": {
143+
"url_hostname": "*.example.com"
144+
},
145+
"created_on": "2021-10-11T12:39:02Z",
146+
"modified_on": "2021-10-11T12:39:02Z"
64147
}
65148
```
66149

@@ -70,11 +153,11 @@ A fully populated JSON object for an ASN list item has the following structure:
70153

71154
```json
72155
{
73-
"id": "7c5dae5552338874e5053f2534d2767a",
74-
"asn": 13335,
75-
"comment": "My provider's ASN",
76-
"created_on": "2021-10-11T12:39:02Z",
77-
"modified_on": "2021-10-11T12:39:02Z"
156+
"id": "7c5dae5552338874e5053f2534d2767a",
157+
"asn": 13335,
158+
"comment": "My provider's ASN",
159+
"created_on": "2021-10-11T12:39:02Z",
160+
"modified_on": "2021-10-11T12:39:02Z"
78161
}
79162
```
80163

@@ -84,25 +167,114 @@ A fully populated JSON object for a Bulk Redirect List item has the following st
84167

85168
```json
86169
{
87-
"id": "7c5dae5552338874e5053f2534d2767a",
88-
"redirect": {
89-
"source_url": "https://example.com/blog",
90-
"target_url": "https://example.com/blog/latest",
91-
"status_code": 301,
92-
"include_subdomains": false,
93-
"subpath_matching": false,
94-
"preserve_query_string": false,
95-
"preserve_path_suffix": true
96-
},
97-
"created_on": "2021-10-11T12:39:02Z",
98-
"modified_on": "2021-10-11T12:39:02Z"
170+
"id": "7c5dae5552338874e5053f2534d2767a",
171+
"redirect": {
172+
"source_url": "https://example.com/blog",
173+
"target_url": "https://example.com/blog/latest",
174+
"status_code": 301,
175+
"include_subdomains": false,
176+
"subpath_matching": false,
177+
"preserve_query_string": false,
178+
"preserve_path_suffix": true
179+
},
180+
"created_on": "2021-10-11T12:39:02Z",
181+
"modified_on": "2021-10-11T12:39:02Z"
99182
}
100183
```
101184

102185
### Properties reference
103186

104187
The JSON object properties for a list item are defined as follows:
105188

106-
189+
{/* prettier-ignore */}
190+
<table>
191+
<thead>
192+
<tr>
193+
<th>Property</th>
194+
<th>Description</th>
195+
<th>Constraints</th>
196+
</tr>
197+
</thead>
198+
<tbody style="vertical-align:top">
199+
<tr>
200+
<td>
201+
<code>id</code><br />
202+
<Type text="String" />
203+
</td>
204+
<td>A UUIDv4 identifier generated by Cloudflare.</td>
205+
<td>
206+
<p>Unique, read only.</p>
207+
<p>Length: 32 characters.</p>
208+
</td>
209+
</tr>
210+
<tr>
211+
<td>
212+
<code>ip</code><br />
213+
<Type text="String" />
214+
</td>
215+
<td>An IP address or CIDR range.</td>
216+
<td>
217+
<p>Applies only to custom lists with IP addresses (IP lists).</p>
218+
<p>
219+
Any of these formats can exist in the same custom list with IP addresses:
220+
<ul>
221+
<li>IPv4 address</li>
222+
<li>IPv6 (up to <code>/64</code>) address</li>
223+
<li>IPv4 ranges as <code>/32</code> through <code>/2</code> CIDRs</li>
224+
<li>IPv6 ranges as <code>/64</code> through <code>/4</code> CIDRs</li>
225+
</ul>
226+
</p>
227+
</td>
228+
</tr>
229+
<tr>
230+
<td>
231+
<code>comment</code><br />
232+
<Type text="String" />
233+
</td>
234+
<td>An informative summary of the item.</td>
235+
<td><p>Maximum length: 500 characters.</p></td>
236+
</tr>
237+
<tr>
238+
<td>
239+
<code>redirect</code><br />
240+
<Type text="Object" />
241+
</td>
242+
<td>An object that contains the definition of a URL redirect. Refer to <a href="/rules/url-forwarding/bulk-redirects/reference/parameters/">URL redirect parameters</a> for details.</td>
243+
<td><p>Applies only to Bulk Redirect Lists.</p></td>
244+
</tr>
245+
<tr>
246+
<td>
247+
<code>hostname</code><br />
248+
<Type text="Object" />
249+
</td>
250+
<td>An object containing a <code>url_hostname</code> property with a hostname value. Refer to <a href="/waf/tools/lists/custom-lists/#lists-with-hostnames">Lists with hostnames</a> for details on the supported hostname values.</td>
251+
<td><p>Applies only to custom lists with hostnames.</p></td>
252+
</tr>
253+
<tr>
254+
<td>
255+
<code>asn</code><br />
256+
<Type text="Integer" />
257+
</td>
258+
<td>An ASN value.</td>
259+
<td>Applies only to custom lists with ASNs.</td>
260+
</tr>
261+
<tr>
262+
<td>
263+
<code>created_on</code><br />
264+
<Type text="String" />
265+
</td>
266+
<td>The <a href='https://datatracker.ietf.org/doc/html/rfc3339'>RFC 3339</a> timestamp when the list was created.</td>
267+
<td>Read only.</td>
268+
</tr>
269+
<tr>
270+
<td>
271+
<code>modified_on</code><br />
272+
<Type text="String" />
273+
</td>
274+
<td>The <a href='https://datatracker.ietf.org/doc/html/rfc3339'>RFC 3339</a> timestamp when the item was last modified.</td>
275+
<td>Read only.</td>
276+
</tr>
277+
</tbody>
278+
</table>
107279

108280
For a detailed specification, refer to the [Lists API](/api/resources/rules/subresources/lists/methods/list/) documentation.

0 commit comments

Comments
 (0)