How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Lists API

The Lists API from APIs.io Engineering Platform — 5 operation(s) for lists.

This API exposes 11 operations across 5 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://api.cloudflare.com/client/v4.

11 operations 5 paths 32 schemas 2 DELETE5 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.cloudflare.com/client/v4
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Lists API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Lists 11
GET
/accounts/{account_id}/rules/lists
APIs.io Engineering Platform Get lists
lists-get-lists 1 param → 4XX200
POST
/accounts/{account_id}/rules/lists
APIs.io Engineering Platform Create a list
lists-create-a-list 1 param body → 4XX200
DELETE
/accounts/{account_id}/rules/lists/{list_id}
APIs.io Engineering Platform Delete a list
lists-delete-a-list 2 params body → 4XX200
GET
/accounts/{account_id}/rules/lists/{list_id}
APIs.io Engineering Platform Get a list
lists-get-a-list 2 params → 4XX200
PUT
/accounts/{account_id}/rules/lists/{list_id}
APIs.io Engineering Platform Update a list
lists-update-a-list 2 params body → 4XX200
DELETE
/accounts/{account_id}/rules/lists/{list_id}/items
APIs.io Engineering Platform Delete list items
lists-delete-list-items 2 params body → 4XX200
GET
/accounts/{account_id}/rules/lists/{list_id}/items
APIs.io Engineering Platform Get list items
lists-get-list-items 5 params → 4XX200
POST
/accounts/{account_id}/rules/lists/{list_id}/items
APIs.io Engineering Platform Create list items
lists-create-list-items 2 params body → 4XX200
PUT
/accounts/{account_id}/rules/lists/{list_id}/items
APIs.io Engineering Platform Update all list items
lists-update-all-list-items 2 params body → 4XX200
GET
/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}
APIs.io Engineering Platform Get a list item
lists-get-a-list-item 3 params → 4XX200
GET
/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}
APIs.io Engineering Platform Get bulk operation status
lists-get-bulk-operation-status 2 params → 4XX200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are lists_item (8 properties), lists_list (8 properties), lists_item_redirect (7 properties), lists_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

lists_api-response-collection
object
lists_created_on
string
The RFC 3339 timestamp of when the list was created.
lists_api-response-common
object
4 properties 4 required
lists_name
string
An informative name for the list. Use this name in filter and rule expressions.
lists_modified_on
string
The RFC 3339 timestamp of when the list was last modified.
lists_item
object
8 properties
lists_items
array
lists_lists-response-collection
object
lists_api-response-common-failure
object
4 properties 4 required
lists_list_id
string
The unique ID of the list.
lists_list
object
8 properties
lists_list-delete-response-collection
object
lists_item_asn
integer
A non-negative 32 bit integer
lists_item_id
string
The unique ID of the item in the List.
lists_description
string
An informative summary of the list.
lists_list-response-collection
object
lists_item_ip
string
An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
lists_item_redirect
object
The definition of the redirect.
7 properties 2 required
lists_item_hostname
object
Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (), and the hyphen (-).
1 property 1 required
lists_operation
object
4 properties 2 required
lists_items-update-request-collection
array
lists_items-list-response-collection
lists_item-response-collection
lists_kind
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
lists_messages
array
lists_bulk-operation-response-collection
lists_operation_id
string
The unique operation ID of the asynchronous action.
lists_item_comment
string
An informative summary of the list item.
lists_identifier
string
Identifier
lists_lists-async-response
lists_num_items
number
The number of items in the list.
lists_num_referencing_filters
number
The number of [filters](/operations/filters-list-filters) referencing the list.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-lists-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Lists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.