Fetches all the items in the list.
/accounts/{account_identifier}/rules/lists/{list_id}/items
get
Lists
lists-get-list-items
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"description": "The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length.",
"example": "zzz",
"type": "string"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"description": "Amount of results to include in each paginated response. A non-negative 32 bit integer.",
"maximum": 500,
"minimum": 1,
"type": "integer"
}
},
{
"in": "query",
"name": "search",
"schema": {
"description": "A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.",
"example": "1.1.1.",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"example": {
"comment": "Private IP address",
"created_on": "2020-01-01T08:00:00Z",
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"ip": "10.0.0.1",
"modified_on": "2020-01-10T14:00:00Z"
},
"oneOf": [
{
"description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.",
"example": "10.0.0.1",
"type": "string"
},
{
"description": "The definition of the redirect.",
"properties": {
"include_subdomains": {
"default": false,
"type": "boolean"
},
"preserve_path_suffix": {
"default": false,
"type": "boolean"
},
"preserve_query_string": {
"default": false,
"type": "boolean"
},
"source_url": {
"example": "example.com/arch",
"type": "string"
},
"status_code": {
"default": 301,
"enum": [
301,
302,
307,
308
],
"type": "integer"
},
"subpath_matching": {
"default": false,
"type": "boolean"
},
"target_url": {
"example": "https://archlinux.org/",
"type": "string"
}
},
"required": [
"source_url",
"target_url"
]
},
{
"description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).",
"properties": {
"url_hostname": {
"example": "example.com",
"type": "string"
}
},
"required": [
"url_hostname"
]
},
{
"description": "A non-negative 32 bit integer",
"example": 5567,
"type": "integer"
}
],
"properties": {
"asn": {
"description": "A non-negative 32 bit integer",
"example": 5567,
"type": "integer"
},
"comment": {
"description": "An informative summary of the list item.",
"example": "Private IP address",
"type": "string"
},
"created_on": {
"description": "The RFC 3339 timestamp of when the item was created.",
"example": "2020-01-01T08:00:00Z",
"readOnly": true,
"type": "string"
},
"hostname": {
"description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).",
"properties": {
"url_hostname": {
"example": "example.com",
"type": "string"
}
},
"required": [
"url_hostname"
]
},
"id": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"ip": {
"description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.",
"example": "10.0.0.1",
"type": "string"
},
"modified_on": {
"description": "The RFC 3339 timestamp of when the item was last modified.",
"example": "2020-01-10T14:00:00Z",
"readOnly": true,
"type": "string"
},
"redirect": {
"description": "The definition of the redirect.",
"properties": {
"include_subdomains": {
"default": false,
"type": "boolean"
},
"preserve_path_suffix": {
"default": false,
"type": "boolean"
},
"preserve_query_string": {
"default": false,
"type": "boolean"
},
"source_url": {
"example": "example.com/arch",
"type": "string"
},
"status_code": {
"default": 301,
"enum": [
301,
302,
307,
308
],
"type": "integer"
},
"subpath_matching": {
"default": false,
"type": "boolean"
},
"target_url": {
"example": "https://archlinux.org/",
"type": "string"
}
},
"required": [
"source_url",
"target_url"
]
}
},
"type": "object"
},
"type": "array"
},
"result_info": {
"properties": {
"cursors": {
"properties": {
"after": {
"example": "yyy",
"type": "string"
},
"before": {
"example": "xxx",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Get list items response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"example": {
"comment": "Private IP address",
"created_on": "2020-01-01T08:00:00Z",
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"ip": "10.0.0.1",
"modified_on": "2020-01-10T14:00:00Z"
},
"oneOf": [
{
"description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.",
"example": "10.0.0.1",
"type": "string"
},
{
"description": "The definition of the redirect.",
"properties": {
"include_subdomains": {
"default": false,
"type": "boolean"
},
"preserve_path_suffix": {
"default": false,
"type": "boolean"
},
"preserve_query_string": {
"default": false,
"type": "boolean"
},
"source_url": {
"example": "example.com/arch",
"type": "string"
},
"status_code": {
"default": 301,
"enum": [
301,
302,
307,
308
],
"type": "integer"
},
"subpath_matching": {
"default": false,
"type": "boolean"
},
"target_url": {
"example": "https://archlinux.org/",
"type": "string"
}
},
"required": [
"source_url",
"target_url"
]
},
{
"description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).",
"properties": {
"url_hostname": {
"example": "example.com",
"type": "string"
}
},
"required": [
"url_hostname"
]
},
{
"description": "A non-negative 32 bit integer",
"example": 5567,
"type": "integer"
}
],
"properties": {
"asn": {
"description": "A non-negative 32 bit integer",
"example": 5567,
"type": "integer"
},
"comment": {
"description": "An informative summary of the list item.",
"example": "Private IP address",
"type": "string"
},
"created_on": {
"description": "The RFC 3339 timestamp of when the item was created.",
"example": "2020-01-01T08:00:00Z",
"readOnly": true,
"type": "string"
},
"hostname": {
"description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).",
"properties": {
"url_hostname": {
"example": "example.com",
"type": "string"
}
},
"required": [
"url_hostname"
]
},
"id": {
"description": "The unique ID of the list.",
"example": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"ip": {
"description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.",
"example": "10.0.0.1",
"type": "string"
},
"modified_on": {
"description": "The RFC 3339 timestamp of when the item was last modified.",
"example": "2020-01-10T14:00:00Z",
"readOnly": true,
"type": "string"
},
"redirect": {
"description": "The definition of the redirect.",
"properties": {
"include_subdomains": {
"default": false,
"type": "boolean"
},
"preserve_path_suffix": {
"default": false,
"type": "boolean"
},
"preserve_query_string": {
"default": false,
"type": "boolean"
},
"source_url": {
"example": "example.com/arch",
"type": "string"
},
"status_code": {
"default": 301,
"enum": [
301,
302,
307,
308
],
"type": "integer"
},
"subpath_matching": {
"default": false,
"type": "boolean"
},
"target_url": {
"example": "https://archlinux.org/",
"type": "string"
}
},
"required": [
"source_url",
"target_url"
]
}
},
"type": "object"
},
"type": "array"
},
"result_info": {
"properties": {
"cursors": {
"properties": {
"after": {
"example": "yyy",
"type": "string"
},
"before": {
"example": "xxx",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get list items response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]