List web and API operations
api_gateway.operations.list(OperationListParams**kwargs) -> SyncV4PagePaginationArray[OperationListResponse]
GET/zones/{zone_id}/api_gateway/operations
Lists web and API operations tracked for the zone, including each operation’s method, path, and feature configuration.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Parameters
List web and API operations
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
page = client.api_gateway.operations.list(
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.operation_id){
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": [
{
"endpoint": "/api/v1/users/{var1}",
"host": "www.example.com",
"last_updated": "2014-01-01T05:20:00.12345Z",
"method": "GET",
"operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"features": {
"api_routing": {
"last_updated": "2014-01-01T05:20:00.12345Z",
"route": "https://api.example.com/api/service"
}
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": [
{
"endpoint": "/api/v1/users/{var1}",
"host": "www.example.com",
"last_updated": "2014-01-01T05:20:00.12345Z",
"method": "GET",
"operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"features": {
"api_routing": {
"last_updated": "2014-01-01T05:20:00.12345Z",
"route": "https://api.example.com/api/service"
}
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}