{ "opencollection": "1.0.0", "info": { "name": "Cloudflare / Accounts API", "version": "4.0.0" }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Cloudflare Account Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get information about a specific account that you are a member of." }, { "info": { "name": "Cloudflare Update Account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing account." }, { "info": { "name": "Cloudflare List Address Maps", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List all address maps owned by the account." }, { "info": { "name": "Cloudflare Create Address Map", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new address map under the account." }, { "info": { "name": "Cloudflare Address Map Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id", "params": [ { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Show a particular address map owned by the account." }, { "info": { "name": "Cloudflare Update Address Map", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id", "params": [ { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify properties of an address map owned by the account." }, { "info": { "name": "Cloudflare Delete Address Map", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id", "params": [ { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted." }, { "info": { "name": "Cloudflare Add an account membership to an Address Map", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an account as a member of a particular address map." }, { "info": { "name": "Cloudflare Remove an account membership from an Address Map", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an account as a member of a particular address map." }, { "info": { "name": "Cloudflare Add an IP to an Address Map", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/ips/:ip_address", "params": [ { "name": "ip_address", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an IP from a prefix owned by the account to a particular address map." }, { "info": { "name": "Cloudflare Remove an IP from an Address Map", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/ips/:ip_address", "params": [ { "name": "ip_address", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an IP from a particular address map." }, { "info": { "name": "Cloudflare Add a zone membership to an Address Map", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/zones/:zone_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a zone as a member of a particular address map." }, { "info": { "name": "Cloudflare Remove a zone membership from an Address Map", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/address_maps/:address_map_id/zones/:zone_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "address_map_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a zone as a member of a particular address map." }, { "info": { "name": "Cloudflare Upload LOA Document", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/loa_documents", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "loa_document", "type": "text", "value": "" } ] } }, "docs": "Submit LOA document (pdf format) under the account." }, { "info": { "name": "Cloudflare Download LOA Document", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/loa_documents/:loa_document_id/download", "params": [ { "name": "loa_document_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Download specified LOA document under the account." }, { "info": { "name": "Cloudflare List Prefixes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List all prefixes owned by the account." }, { "info": { "name": "Cloudflare Add Prefix", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new prefix under the account." }, { "info": { "name": "Cloudflare Prefix Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List a particular prefix owned by the account." }, { "info": { "name": "Cloudflare Update Prefix Description", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the description for a prefix owned by the account." }, { "info": { "name": "Cloudflare Delete Prefix", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an unapproved prefix owned by the account." }, { "info": { "name": "Cloudflare List BGP Prefixes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bgp/prefixes", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" } ] }, "docs": "List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes." }, { "info": { "name": "Cloudflare Fetch BGP Prefix", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bgp/prefixes/:bgp_prefix_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" }, { "name": "bgp_prefix_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single BGP Prefix according to its identifier" }, { "info": { "name": "Cloudflare Update BGP Prefix", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bgp/prefixes/:bgp_prefix_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" }, { "name": "bgp_prefix_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn)." }, { "info": { "name": "Cloudflare Get Advertisement Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bgp/status", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List the current advertisement state for a prefix." }, { "info": { "name": "Cloudflare Update Prefix Dynamic Advertisement Status", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bgp/status", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Advertise or withdraw BGP route for a prefix." }, { "info": { "name": "Cloudflare List Service Bindings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bindings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" } ] }, "docs": "List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address.\n**Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.\n" }, { "info": { "name": "Cloudflare Create Service Binding", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bindings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network.\n**Note:** This API may only be used on prefixes currently configured with a Magic Transit service binding, and only allows creating service bindings for the Cloudflare CDN or Cloudflare Spectrum.\n" }, { "info": { "name": "Cloudflare Get Service Binding", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bindings/:binding_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" }, { "name": "binding_id", "value": "", "type": "path" } ] }, "docs": "Fetch a single Service Binding" }, { "info": { "name": "Cloudflare Delete Service Binding", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/bindings/:binding_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" }, { "name": "binding_id", "value": "", "type": "path" } ] }, "docs": "Delete a Service Binding" }, { "info": { "name": "Cloudflare List Prefix Delegations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/delegations", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List all delegations for a given account IP prefix." }, { "info": { "name": "Cloudflare Create Prefix Delegation", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/delegations", "params": [ { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new account delegation for a given IP prefix." }, { "info": { "name": "Cloudflare Delete Prefix Delegation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/prefixes/:prefix_id/delegations/:delegation_id", "params": [ { "name": "delegation_id", "value": "", "type": "path" }, { "name": "prefix_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an account delegation for a given IP prefix." }, { "info": { "name": "Cloudflare List Services", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/addressing/services", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.\n" }, { "info": { "name": "Cloudflare Execute @cf/baai/bge-base-en-v1.5 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/baai/bge-base-en-v1.5", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/baai/bge-base-en-v1.5 model." }, { "info": { "name": "Cloudflare Execute @cf/baai/bge-large-en-v1.5 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/baai/bge-large-en-v1.5", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/baai/bge-large-en-v1.5 model." }, { "info": { "name": "Cloudflare Execute @cf/baai/bge-small-en-v1.5 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/baai/bge-small-en-v1.5", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/baai/bge-small-en-v1.5 model." }, { "info": { "name": "Cloudflare Execute @cf/bytedance/stable-diffusion-xl-lightning model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/bytedance/stable-diffusion-xl-lightning", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/bytedance/stable-diffusion-xl-lightning model." }, { "info": { "name": "Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-base model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/deepseek-ai/deepseek-math-7b-base", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-base model." }, { "info": { "name": "Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-instruct model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-instruct model." }, { "info": { "name": "Cloudflare Execute @cf/defog/sqlcoder-7b-2 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/defog/sqlcoder-7b-2", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/defog/sqlcoder-7b-2 model." }, { "info": { "name": "Cloudflare Execute @cf/facebook/bart-large-cnn model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/facebook/bart-large-cnn", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/facebook/bart-large-cnn model." }, { "info": { "name": "Cloudflare Execute @cf/facebook/detr-resnet-50 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/facebook/detr-resnet-50", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Execute @cf/facebook/detr-resnet-50 model." }, { "info": { "name": "Cloudflare Execute @cf/huggingface/distilbert-sst-2-int8 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/huggingface/distilbert-sst-2-int8", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/huggingface/distilbert-sst-2-int8 model." }, { "info": { "name": "Cloudflare Execute @cf/jpmorganchase/roberta-spam model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/jpmorganchase/roberta-spam", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/jpmorganchase/roberta-spam model." }, { "info": { "name": "Cloudflare Execute @cf/lykon/dreamshaper-8-lcm model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/lykon/dreamshaper-8-lcm", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/lykon/dreamshaper-8-lcm model." }, { "info": { "name": "Cloudflare Execute @cf/meta/llama-2-7b-chat-fp16 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/meta/llama-2-7b-chat-fp16", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/meta/llama-2-7b-chat-fp16 model." }, { "info": { "name": "Cloudflare Execute @cf/meta/llama-2-7b-chat-int8 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/meta/llama-2-7b-chat-int8", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/meta/llama-2-7b-chat-int8 model." }, { "info": { "name": "Cloudflare Execute @cf/meta/m2m100-1.2b model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/meta/m2m100-1.2b", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/meta/m2m100-1.2b model." }, { "info": { "name": "Cloudflare Execute @cf/microsoft/phi-2 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/microsoft/phi-2", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/microsoft/phi-2 model." }, { "info": { "name": "Cloudflare Execute @cf/microsoft/resnet-50 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/microsoft/resnet-50", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Execute @cf/microsoft/resnet-50 model." }, { "info": { "name": "Cloudflare Execute @cf/mistral/mistral-7b-instruct-v0.1 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/mistral/mistral-7b-instruct-v0.1", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/mistral/mistral-7b-instruct-v0.1 model." }, { "info": { "name": "Cloudflare Execute @cf/openai/whisper model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/openai/whisper", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Execute @cf/openai/whisper model." }, { "info": { "name": "Cloudflare Execute @cf/openchat/openchat-3.5-0106 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/openchat/openchat-3.5-0106", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/openchat/openchat-3.5-0106 model." }, { "info": { "name": "Cloudflare Execute @cf/qwen/qwen1.5-0.5b-chat model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/qwen/qwen1.5-0.5b-chat", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/qwen/qwen1.5-0.5b-chat model." }, { "info": { "name": "Cloudflare Execute @cf/qwen/qwen1.5-1.8b-chat model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/qwen/qwen1.5-1.8b-chat", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/qwen/qwen1.5-1.8b-chat model." }, { "info": { "name": "Cloudflare Execute @cf/qwen/qwen1.5-7b-chat-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/qwen/qwen1.5-7b-chat-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/qwen/qwen1.5-7b-chat-awq model." }, { "info": { "name": "Cloudflare Execute @cf/qwen/qwen1.5-14b-chat-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/qwen/qwen1.5-14b-chat-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/qwen/qwen1.5-14b-chat-awq model." }, { "info": { "name": "Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-img2img model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-img2img model." }, { "info": { "name": "Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model." }, { "info": { "name": "Cloudflare Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model." }, { "info": { "name": "Cloudflare Execute @cf/thebloke/discolm-german-7b-v1-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/thebloke/discolm-german-7b-v1-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/thebloke/discolm-german-7b-v1-awq model." }, { "info": { "name": "Cloudflare Execute @cf/thebloke/yarn-mistral-7b-64k-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/thebloke/yarn-mistral-7b-64k-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/thebloke/yarn-mistral-7b-64k-awq model." }, { "info": { "name": "Cloudflare Execute @cf/tiiuae/falcon-7b-instruct model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/tiiuae/falcon-7b-instruct", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/tiiuae/falcon-7b-instruct model." }, { "info": { "name": "Cloudflare Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model." }, { "info": { "name": "Cloudflare Execute @hf/baai/bge-base-en-v1.5 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/baai/bge-base-en-v1.5", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/baai/bge-base-en-v1.5 model." }, { "info": { "name": "Cloudflare Execute @hf/sentence-transformers/all-minilm-l6-v2 model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/sentence-transformers/all-minilm-l6-v2", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/sentence-transformers/all-minilm-l6-v2 model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/codellama-7b-instruct-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/codellama-7b-instruct-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/codellama-7b-instruct-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/llama-2-13b-chat-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/llama-2-13b-chat-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/llama-2-13b-chat-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/llamaguard-7b-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/llamaguard-7b-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/llamaguard-7b-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/neural-chat-7b-v3-1-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/neural-chat-7b-v3-1-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/openchat_3.5-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/openchat_3.5-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/openchat_3.5-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/orca-2-13b-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/orca-2-13b-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/orca-2-13b-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/starling-lm-7b-alpha-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/starling-lm-7b-alpha-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/starling-lm-7b-alpha-awq model." }, { "info": { "name": "Cloudflare Execute @hf/thebloke/zephyr-7b-beta-awq model.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/@hf/thebloke/zephyr-7b-beta-awq", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Execute @hf/thebloke/zephyr-7b-beta-awq model." }, { "info": { "name": "Cloudflare Execute AI model", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/ai/run/:model_name", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "model_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint provides users with the capability to run specific AI models on-demand.\n\nBy submitting the required input data, users can receive real-time predictions or results generated by the chosen AI\nmodel. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.\n\nModel specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/)." }, { "info": { "name": "Cloudflare Get Alert Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/available_alerts", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets a list of all alert types for which an account is eligible." }, { "info": { "name": "Cloudflare Get delivery mechanism eligibility", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/eligible", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all delivery mechanism types for which an account is eligible." }, { "info": { "name": "Cloudflare List PagerDuty services", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/pagerduty", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all configured PagerDuty services." }, { "info": { "name": "Cloudflare Delete PagerDuty Services", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/pagerduty", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes all the PagerDuty Services connected to the account." }, { "info": { "name": "Cloudflare Create PagerDuty integration token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/pagerduty/connect", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Creates a new token for integrating with PagerDuty." }, { "info": { "name": "Cloudflare Connect PagerDuty", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/pagerduty/connect/:token_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Links PagerDuty with the account using the integration token." }, { "info": { "name": "Cloudflare List webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/webhooks", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets a list of all configured webhook destinations." }, { "info": { "name": "Cloudflare Create a webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/webhooks", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new webhook destination." }, { "info": { "name": "Cloudflare Get a webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/webhooks/:webhook_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Get details for a single webhooks destination." }, { "info": { "name": "Cloudflare Update a webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a webhook destination." }, { "info": { "name": "Cloudflare Delete a webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/destinations/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete a configured webhook destination." }, { "info": { "name": "Cloudflare List History", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/history", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" } ] }, "docs": "Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90)." }, { "info": { "name": "Cloudflare List Notification policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/policies", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all Notification policies." }, { "info": { "name": "Cloudflare Create a Notification policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/policies", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Notification policy." }, { "info": { "name": "Cloudflare Get a Notification policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/policies/:policy_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ] }, "docs": "Get details for a single policy." }, { "info": { "name": "Cloudflare Update a Notification policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/policies/:policy_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Notification policy." }, { "info": { "name": "Cloudflare Delete a Notification policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/alerting/v3/policies/:policy_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ] }, "docs": "Delete a Notification policy." }, { "info": { "name": "Cloudflare Get account audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/audit_logs", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" }, { "name": "export", "value": "", "type": "query" }, { "name": "action.type", "value": "", "type": "query" }, { "name": "actor.ip", "value": "", "type": "query" }, { "name": "actor.email", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query" }, { "name": "zone.name", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "hide_user_logs", "value": "", "type": "query" } ] }, "docs": "Gets a list of audit logs for an account. Can be filtered by who made the change, on which zone, and the timeframe of the change." }, { "info": { "name": "Cloudflare Submit suspicious URL for scanning", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/brand-protection/submit", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Submit suspicious URL for scanning" }, { "info": { "name": "Cloudflare Get results for a URL scan", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/brand-protection/url-info", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "url_id_param", "value": "", "type": "query" }, { "name": "url", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get results for a URL scan" }, { "info": { "name": "Cloudflare List apps", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/calls/apps", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all apps in the Cloudflare account" }, { "info": { "name": "Cloudflare Create a new app", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/calls/apps", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app." }, { "info": { "name": "Cloudflare Retrieve app details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/calls/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches details for a single Calls app." }, { "info": { "name": "Cloudflare Edit app details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/calls/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit details for a single app." }, { "info": { "name": "Cloudflare Delete app", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/calls/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes an app from Cloudflare Calls" }, { "info": { "name": "List Cloudflare Tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "is_deleted", "value": "", "type": "query" }, { "name": "existed_at", "value": "", "type": "query" }, { "name": "uuid", "value": "", "type": "query" }, { "name": "was_active_at", "value": "", "type": "query" }, { "name": "was_inactive_at", "value": "", "type": "query" }, { "name": "include_prefix", "value": "", "type": "query" }, { "name": "exclude_prefix", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Lists and filters Cloudflare Tunnels in an account." }, { "info": { "name": "Create a Cloudflare Tunnel", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Cloudflare Tunnel in an account." }, { "info": { "name": "Get a Cloudflare Tunnel", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Cloudflare Tunnel." }, { "info": { "name": "Update a Cloudflare Tunnel", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Cloudflare Tunnel." }, { "info": { "name": "Delete a Cloudflare Tunnel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Cloudflare Tunnel from an account." }, { "info": { "name": "Cloudflare Get configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/configurations", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the configuration for a remotely-managed tunnel" }, { "info": { "name": "Cloudflare Put configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/configurations", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds or updates the configuration for a remotely-managed tunnel." }, { "info": { "name": "List Cloudflare Tunnel connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/connections", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "tunnel_id", "value": "", "type": "path" } ] }, "docs": "Fetches connection details for a Cloudflare Tunnel." }, { "info": { "name": "Clean up Cloudflare Tunnel connections", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/connections", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "client_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens." }, { "info": { "name": "Get Cloudflare Tunnel connector", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/connectors/:connector_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "connector_id", "value": "", "type": "path" } ] }, "docs": "Fetches connector and connection details for a Cloudflare Tunnel." }, { "info": { "name": "Get a Cloudflare Tunnel management token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/management", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel." }, { "info": { "name": "Get a Cloudflare Tunnel token", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/cfd_tunnel/:tunnel_id/token", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the token used to associate cloudflared with a specific tunnel." }, { "info": { "name": "Cloudflare List Turnstile Widgets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Lists all turnstile widgets of an account." }, { "info": { "name": "Cloudflare Create a Turnstile Widget", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists challenge widgets." }, { "info": { "name": "Cloudflare Turnstile Widget Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets/:sitekey", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "sitekey", "value": "", "type": "path" } ] }, "docs": "Show a single challenge widget configuration." }, { "info": { "name": "Cloudflare Update a Turnstile Widget", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets/:sitekey", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "sitekey", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the configuration of a widget." }, { "info": { "name": "Cloudflare Delete a Turnstile Widget", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets/:sitekey", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "sitekey", "value": "", "type": "path" } ] }, "docs": "Destroy a Turnstile Widget." }, { "info": { "name": "Cloudflare Rotate Secret for a Turnstile Widget", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/challenges/widgets/:sitekey/rotate_secret", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "sitekey", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate a new secret key for this widget. If `invalidate_immediately`\nis set to `false`, the previous secret remains valid for 2 hours.\n\nNote that secrets cannot be rotated again during the grace period.\n" }, { "info": { "name": "Cloudflare List Account Custom Nameservers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/custom_ns", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List an account's custom nameservers." }, { "info": { "name": "Cloudflare Add Account Custom Nameserver", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/custom_ns", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Add Account Custom Nameserver" }, { "info": { "name": "Cloudflare Delete Account Custom Nameserver", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/custom_ns/:custom_ns_id", "params": [ { "name": "custom_ns_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Account Custom Nameserver" }, { "info": { "name": "Cloudflare Get Eligible Zones for Account Custom Nameservers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/custom_ns/availability", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Eligible Zones for Account Custom Nameservers" }, { "info": { "name": "Cloudflare Verify Account Custom Nameserver Glue Records", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/custom_ns/verify", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Verify Account Custom Nameserver Glue Records" }, { "info": { "name": "Cloudflare List D1 Databases", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/d1/database", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Returns a list of D1 databases." }, { "info": { "name": "Cloudflare Create D1 Database", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/d1/database", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the created D1 database." }, { "info": { "name": "Cloudflare List devices", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of enrolled devices." }, { "info": { "name": "Cloudflare Get device details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches details for a single device." }, { "info": { "name": "Cloudflare Get an admin override code for a device", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/:device_id/override_codes", "params": [ { "name": "device_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration." }, { "info": { "name": "Cloudflare List Device DEX tests", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/dex_tests", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch all DEX tests." }, { "info": { "name": "Cloudflare Create Device DEX test", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/dex_tests", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a DEX test." }, { "info": { "name": "Cloudflare Get Device DEX test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/dex_tests/:dex_test_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dex_test_id", "value": "", "type": "path" } ] }, "docs": "Fetch a single DEX test." }, { "info": { "name": "Cloudflare Update Device DEX test", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/dex_tests/:dex_test_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dex_test_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a DEX test." }, { "info": { "name": "Cloudflare Delete Device DEX test", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/dex_tests/:dex_test_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dex_test_id", "value": "", "type": "path" } ] }, "docs": "Delete a Device DEX test. Returns the remaining device dex tests for the account." }, { "info": { "name": "Cloudflare List your device managed networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/networks", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of managed networks for an account." }, { "info": { "name": "Cloudflare Create a device managed network", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/networks", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new device managed network." }, { "info": { "name": "Cloudflare Get device managed network details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/networks/:network_id", "params": [ { "name": "network_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches details for a single managed network." }, { "info": { "name": "Cloudflare Update a device managed network", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/networks/:network_id", "params": [ { "name": "network_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured device managed network." }, { "info": { "name": "Cloudflare Delete a device managed network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/networks/:network_id", "params": [ { "name": "network_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a device managed network and fetches a list of the remaining device managed networks for an account." }, { "info": { "name": "Cloudflare List device settings profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policies", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of the device settings profiles for an account." }, { "info": { "name": "Cloudflare Get the default device settings profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the default device settings profile for an account." }, { "info": { "name": "Cloudflare Create a device settings profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a device settings profile to be applied to certain devices matching the criteria." }, { "info": { "name": "Cloudflare Update the default device settings profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the default device settings profile for an account." }, { "info": { "name": "Cloudflare Get device settings profile by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a device settings profile by ID." }, { "info": { "name": "Cloudflare Update a device settings profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured device settings profile." }, { "info": { "name": "Cloudflare Delete a device settings profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a device settings profile and fetches a list of the remaining profiles for an account." }, { "info": { "name": "Cloudflare Get the Split Tunnel exclude list for a device settings profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/exclude", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile." }, { "info": { "name": "Cloudflare Set the Split Tunnel exclude list for a device settings profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/exclude", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile." }, { "info": { "name": "Cloudflare Get the Local Domain Fallback list for a device settings profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/fallback_domains", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead." }, { "info": { "name": "Cloudflare Set the Local Domain Fallback list for a device settings profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/fallback_domains", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile." }, { "info": { "name": "Cloudflare Get the Split Tunnel include list for a device settings profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/include", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile." }, { "info": { "name": "Cloudflare Set the Split Tunnel include list for a device settings profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/:policy_id/include", "params": [ { "name": "policy_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of routes included in the WARP client's tunnel for a specific device settings profile." }, { "info": { "name": "Cloudflare Get the Split Tunnel exclude list", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/exclude", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of routes excluded from the WARP client's tunnel." }, { "info": { "name": "Cloudflare Set the Split Tunnel exclude list", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/exclude", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of routes excluded from the WARP client's tunnel." }, { "info": { "name": "Cloudflare Get your Local Domain Fallback list", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/fallback_domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead." }, { "info": { "name": "Cloudflare Set your Local Domain Fallback list", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/fallback_domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead." }, { "info": { "name": "Cloudflare Get the Split Tunnel include list", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/include", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of routes included in the WARP client's tunnel." }, { "info": { "name": "Cloudflare Set the Split Tunnel include list", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/policy/include", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the list of routes included in the WARP client's tunnel." }, { "info": { "name": "Cloudflare List device posture rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches device posture rules for a Zero Trust account." }, { "info": { "name": "Cloudflare Create a device posture rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new device posture rule." }, { "info": { "name": "Cloudflare Get device posture rule details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single device posture rule." }, { "info": { "name": "Cloudflare Update a device posture rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a device posture rule." }, { "info": { "name": "Cloudflare Delete a device posture rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a device posture rule." }, { "info": { "name": "Cloudflare List your device posture integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/integration", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the list of device posture integrations for an account." }, { "info": { "name": "Cloudflare Create a device posture integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/integration", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new device posture integration." }, { "info": { "name": "Cloudflare Get device posture integration details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/integration/:integration_id", "params": [ { "name": "integration_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches details for a single device posture integration." }, { "info": { "name": "Cloudflare Update a device posture integration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/integration/:integration_id", "params": [ { "name": "integration_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured device posture integration." }, { "info": { "name": "Cloudflare Delete a device posture integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/posture/integration/:integration_id", "params": [ { "name": "integration_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a configured device posture integration." }, { "info": { "name": "Cloudflare Revoke devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/revoke", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revokes a list of devices." }, { "info": { "name": "Cloudflare Get device settings for a Zero Trust account", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Describes the current device settings for a Zero Trust account." }, { "info": { "name": "Cloudflare Update device settings for a Zero Trust account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the current device settings for a Zero Trust account." }, { "info": { "name": "Cloudflare Unrevoke devices", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/devices/unrevoke", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unrevokes a list of devices." }, { "info": { "name": "List Cloudflare colos", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/colos", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for connection period in RFC3339 (ISO 8601) format." }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for connection period in RFC3339 (ISO 8601) format." }, { "name": "sortBy", "value": "", "type": "query", "description": "Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically." } ] }, "docs": "List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically." }, { "info": { "name": "Cloudflare List fleet status devices", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/fleet-status/devices", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_end", "value": "", "type": "query" }, { "name": "time_start", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query" }, { "name": "colo", "value": "", "type": "query" }, { "name": "device_id", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "platform", "value": "", "type": "query" }, { "name": "version", "value": "", "type": "query" } ] }, "docs": "List details for devices using WARP" }, { "info": { "name": "Cloudflare List fleet status details by dimension", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/fleet-status/live", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "since_minutes", "value": "", "type": "query" } ] }, "docs": "List details for live (up to 60 minutes) devices using WARP" }, { "info": { "name": "Cloudflare List fleet status aggregate details by dimension", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/fleet-status/over-time", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_end", "value": "", "type": "query" }, { "name": "time_start", "value": "", "type": "query" }, { "name": "colo", "value": "", "type": "query" }, { "name": "device_id", "value": "", "type": "query" } ] }, "docs": "List details for devices using WARP, up to 7 days" }, { "info": { "name": "Cloudflare Get details and aggregate metrics for an http test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/http-tests/:test_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days." }, { "info": { "name": "Cloudflare Get percentiles for an http test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/http-tests/:test_id/percentiles", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO format" }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO format" }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get percentiles for an http test for a given time period between 1 hour and 7 days." }, { "info": { "name": "Cloudflare List DEX test analytics", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/tests", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." }, { "name": "testName", "value": "", "type": "query", "description": "Optionally filter results by test name" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List DEX tests" }, { "info": { "name": "Cloudflare Get count of devices targeted", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/tests/unique-devices", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "testName", "value": "", "type": "query", "description": "Optionally filter results by test name" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." } ] }, "docs": "Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days." }, { "info": { "name": "Cloudflare Get details for a specific traceroute test run", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/traceroute-test-results/:test_result_id/network-path", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account" }, { "name": "test_result_id", "value": "", "type": "path", "description": "unique identifier for a specific traceroute test" } ] }, "docs": "Get a breakdown of hops and performance metrics for a specific traceroute test run" }, { "info": { "name": "Cloudflare Get details and aggregate metrics for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/traceroute-tests/:test_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Unique identifier linked to an account" }, { "name": "test_id", "value": "", "type": "path", "description": "Unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days." }, { "info": { "name": "Cloudflare Get network path breakdown for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/traceroute-tests/:test_id/network-path", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account" }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Device to filter tracroute result runs to" }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO ms" }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO ms" }, { "name": "interval", "value": "", "type": "query", "description": "Time interval for aggregate time slots." } ] }, "docs": "Get a breakdown of metrics by hop for individual traceroute test runs" }, { "info": { "name": "Cloudflare Get percentiles for a traceroute test", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dex/traceroute-tests/:test_id/percentiles", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "unique identifier linked to an account in the API request path." }, { "name": "test_id", "value": "", "type": "path", "description": "unique identifier for a specific test" }, { "name": "deviceId", "value": "", "type": "query", "description": "Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param." }, { "name": "timeStart", "value": "", "type": "query", "description": "Start time for aggregate metrics in ISO format" }, { "name": "timeEnd", "value": "", "type": "query", "description": "End time for aggregate metrics in ISO format" }, { "name": "colo", "value": "", "type": "query", "description": "Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param." } ] }, "docs": "Get percentiles for a traceroute test for a given time period between 1 hour and 7 days." }, { "info": { "name": "Cloudflare Traceroute", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/diagnostics/traceroute", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run traceroutes from Cloudflare colos." }, { "info": { "name": "Cloudflare Fetch all datasets with information about available versions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch all datasets with information about available versions." }, { "info": { "name": "Cloudflare Create a new dataset.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new dataset." }, { "info": { "name": "Cloudflare Fetch a specific dataset with information about available versions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets/:dataset_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific dataset with information about available versions." }, { "info": { "name": "Cloudflare Update details about a dataset.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets/:dataset_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update details about a dataset." }, { "info": { "name": "Cloudflare Delete a dataset.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets/:dataset_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path" } ] }, "docs": "Delete a dataset.\n\nThis deletes all versions of the dataset." }, { "info": { "name": "Cloudflare Prepare to upload a new version of a dataset.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets/:dataset_id/upload", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path" } ] }, "docs": "Prepare to upload a new version of a dataset." }, { "info": { "name": "Cloudflare Upload a new version of a dataset.", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/datasets/:dataset_id/upload/:version", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dataset_id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ] }, "docs": "Upload a new version of a dataset." }, { "info": { "name": "Cloudflare Validate pattern", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/patterns/validate", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched." }, { "info": { "name": "Cloudflare Get settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/payload_log", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the current DLP payload log settings for this account." }, { "info": { "name": "Cloudflare Update settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/payload_log", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the DLP payload log settings for this account." }, { "info": { "name": "Cloudflare List all profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all DLP profiles in an account." }, { "info": { "name": "Cloudflare Get DLP Profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a DLP profile by ID. Supports both predefined and custom profiles" }, { "info": { "name": "Cloudflare Create custom profiles", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/custom", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a set of DLP custom profiles." }, { "info": { "name": "Cloudflare Get custom profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/custom/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a custom DLP profile." }, { "info": { "name": "Cloudflare Update custom profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/custom/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a DLP custom profile." }, { "info": { "name": "Cloudflare Delete custom profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/custom/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a DLP custom profile." }, { "info": { "name": "Cloudflare Get predefined profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/predefined/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a predefined DLP profile." }, { "info": { "name": "Cloudflare Update predefined profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dlp/profiles/predefined/:profile_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a DLP predefined profile. Only supports enabling/disabling entries." }, { "info": { "name": "Cloudflare List DNS Firewall Clusters", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dns_firewall", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "List configured DNS Firewall clusters for an account." }, { "info": { "name": "Cloudflare Create DNS Firewall Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dns_firewall", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a configured DNS Firewall Cluster." }, { "info": { "name": "Cloudflare DNS Firewall Cluster Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dns_firewall/:dns_firewall_id", "params": [ { "name": "dns_firewall_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Show a single configured DNS Firewall cluster for an account." }, { "info": { "name": "Cloudflare Update DNS Firewall Cluster", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dns_firewall/:dns_firewall_id", "params": [ { "name": "dns_firewall_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a DNS Firewall Cluster configuration." }, { "info": { "name": "Cloudflare Delete DNS Firewall Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/dns_firewall/:dns_firewall_id", "params": [ { "name": "dns_firewall_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a configured DNS Firewall Cluster." }, { "info": { "name": "Cloudflare Get Zero Trust account information", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets information about the current Zero Trust account." }, { "info": { "name": "Cloudflare Create Zero Trust account", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Creates a Zero Trust account with an existing Cloudflare account." }, { "info": { "name": "Cloudflare List application and application type mappings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/app_types", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all application and application type mappings." }, { "info": { "name": "Cloudflare Get Zero Trust Audit SSH settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/audit_ssh_settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get all Zero Trust Audit SSH settings for an account." }, { "info": { "name": "Cloudflare Update Zero Trust Audit SSH settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/audit_ssh_settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Zero Trust Audit SSH settings." }, { "info": { "name": "Cloudflare List categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/categories", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of all categories." }, { "info": { "name": "Cloudflare Get Zero Trust account configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/configuration", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the current Zero Trust account configuration." }, { "info": { "name": "Cloudflare Update Zero Trust account configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/configuration", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the current Zero Trust account configuration." }, { "info": { "name": "Cloudflare Patch Zero Trust account configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/configuration", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches the current Zero Trust account configuration. This endpoint can update a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `custom_certificate`, without updating the entire configuration object. Returns an error if any collection of settings is not properly configured." }, { "info": { "name": "Cloudflare List Zero Trust lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all Zero Trust lists for an account." }, { "info": { "name": "Cloudflare Create Zero Trust list", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Zero Trust list." }, { "info": { "name": "Cloudflare Get Zero Trust list details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Zero Trust list." }, { "info": { "name": "Cloudflare Update Zero Trust list", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Zero Trust list." }, { "info": { "name": "Cloudflare Patch Zero Trust list", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Appends or removes an item from a configured Zero Trust list." }, { "info": { "name": "Cloudflare Delete Zero Trust list", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Zero Trust list." }, { "info": { "name": "Cloudflare Get Zero Trust list items", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/lists/:list_id/items", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all items in a single Zero Trust list." }, { "info": { "name": "Cloudflare List Zero Trust Gateway locations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/locations", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches Zero Trust Gateway locations for an account." }, { "info": { "name": "Cloudflare Create a Zero Trust Gateway location", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/locations", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Zero Trust Gateway location." }, { "info": { "name": "Cloudflare Get Zero Trust Gateway location details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Zero Trust Gateway location." }, { "info": { "name": "Cloudflare Update a Zero Trust Gateway location", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Zero Trust Gateway location." }, { "info": { "name": "Cloudflare Delete a Zero Trust Gateway location", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a configured Zero Trust Gateway location." }, { "info": { "name": "Cloudflare Get logging settings for the Zero Trust account", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/logging", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the current logging settings for Zero Trust account." }, { "info": { "name": "Cloudflare Update Zero Trust account logging settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/logging", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates logging settings for the current Zero Trust account." }, { "info": { "name": "Cloudflare Get a proxy endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/proxy_endpoints", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Zero Trust Gateway proxy endpoint." }, { "info": { "name": "Cloudflare Create a proxy endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/proxy_endpoints", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Zero Trust Gateway proxy endpoint." }, { "info": { "name": "Cloudflare List proxy endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/proxy_endpoints/:proxy_endpoint_id", "params": [ { "name": "proxy_endpoint_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all Zero Trust Gateway proxy endpoints for an account." }, { "info": { "name": "Cloudflare Update a proxy endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/proxy_endpoints/:proxy_endpoint_id", "params": [ { "name": "proxy_endpoint_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Zero Trust Gateway proxy endpoint." }, { "info": { "name": "Cloudflare Delete a proxy endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/proxy_endpoints/:proxy_endpoint_id", "params": [ { "name": "proxy_endpoint_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a configured Zero Trust Gateway proxy endpoint." }, { "info": { "name": "Cloudflare List Zero Trust Gateway rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/rules", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the Zero Trust Gateway rules for an account." }, { "info": { "name": "Cloudflare Create a Zero Trust Gateway rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/rules", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Zero Trust Gateway rule." }, { "info": { "name": "Cloudflare Get Zero Trust Gateway rule details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Zero Trust Gateway rule." }, { "info": { "name": "Cloudflare Update a Zero Trust Gateway rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Zero Trust Gateway rule." }, { "info": { "name": "Cloudflare Delete a Zero Trust Gateway rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/gateway/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Zero Trust Gateway rule." }, { "info": { "name": "Cloudflare List Hyperdrives", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns a list of Hyperdrives" }, { "info": { "name": "Cloudflare Create Hyperdrive", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and returns a new Hyperdrive configuration." }, { "info": { "name": "Cloudflare Get Hyperdrive", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs/:hyperdrive_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "hyperdrive_id", "value": "", "type": "path" } ] }, "docs": "Returns the specified Hyperdrive configuration." }, { "info": { "name": "Cloudflare Update Hyperdrive", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs/:hyperdrive_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "hyperdrive_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates and returns the specified Hyperdrive configuration." }, { "info": { "name": "Cloudflare Patch Hyperdrive", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs/:hyperdrive_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "hyperdrive_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches and returns the specified Hyperdrive configuration. Updates to the origin and caching settings are applied with an all-or-nothing approach." }, { "info": { "name": "Cloudflare Delete Hyperdrive", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/hyperdrive/configs/:hyperdrive_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "hyperdrive_id", "value": "", "type": "path" } ] }, "docs": "Deletes the specified Hyperdrive." }, { "info": { "name": "Cloudflare List images", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "List up to 100 images with one request. Use the optional parameters below to get a specific range of images." }, { "info": { "name": "Cloudflare Upload an image", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.\nAn image can be uploaded by sending an image file or passing an accessible to an API url.\n" }, { "info": { "name": "Cloudflare Image details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/:image_id", "params": [ { "name": "image_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch details for a single image." }, { "info": { "name": "Cloudflare Update image", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/:image_id", "params": [ { "name": "image_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update image access control. On access control change, all copies of the image are purged from cache." }, { "info": { "name": "Cloudflare Delete image", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/:image_id", "params": [ { "name": "image_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache." }, { "info": { "name": "Cloudflare Base image", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/:image_id/blob", "params": [ { "name": "image_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original." }, { "info": { "name": "Cloudflare List Signing Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/keys", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists your signing keys. These can be found on your Cloudflare Images dashboard." }, { "info": { "name": "Cloudflare Create a new Signing Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/keys/:signing_key_name", "params": [ { "name": "signing_key_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Create a new signing key with specified name. Returns all keys available." }, { "info": { "name": "Cloudflare Delete Signing Key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/keys/:signing_key_name", "params": [ { "name": "signing_key_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete signing key with specified name. Returns all keys available.\nWhen last key is removed, a new default signing key will be generated.\n" }, { "info": { "name": "Cloudflare Images usage statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/stats", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch usage statistics details for Cloudflare Images." }, { "info": { "name": "Cloudflare List variants", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/variants", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists existing variants." }, { "info": { "name": "Cloudflare Create a variant", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/variants", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Specify variants that allow you to resize images for different use cases." }, { "info": { "name": "Cloudflare Variant details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/variants/:variant_id", "params": [ { "name": "variant_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch details for a single variant." }, { "info": { "name": "Cloudflare Update a variant", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/variants/:variant_id", "params": [ { "name": "variant_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updating a variant purges the cache for all images associated with the variant." }, { "info": { "name": "Cloudflare Delete a variant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v1/variants/:variant_id", "params": [ { "name": "variant_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deleting a variant purges the cache for all images associated with the variant." }, { "info": { "name": "Cloudflare List images V2", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v2", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "continuation_token", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "sort_order", "value": "", "type": "query" } ] }, "docs": "List up to 10000 images with one request. Use the optional parameters below to get a specific range of images.\nEndpoint returns continuation_token if more images are present.\n" }, { "info": { "name": "Cloudflare Create authenticated direct upload URL V2", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/images/v2/direct_upload", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present." }, { "info": { "name": "Cloudflare Get ASN Overview", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/asn/:asn", "params": [ { "name": "asn", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get ASN Overview" }, { "info": { "name": "Cloudflare Get ASN Subnets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/asn/:asn/subnets", "params": [ { "name": "asn", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get ASN Subnets" }, { "info": { "name": "Cloudflare Archive Security Center Insight", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/:issue_id/dismiss", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "issue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Archive Security Center Insight" }, { "info": { "name": "Cloudflare Get Security Center Issues Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/issue-types", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Security Center Issues Types" }, { "info": { "name": "Cloudflare Get Security Center Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/issues", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dismissed", "value": "", "type": "query" }, { "name": "issue_class", "value": "", "type": "query" }, { "name": "issue_type", "value": "", "type": "query" }, { "name": "product", "value": "", "type": "query" }, { "name": "severity", "value": "", "type": "query" }, { "name": "subject", "value": "", "type": "query" }, { "name": "issue_class~neq", "value": "", "type": "query" }, { "name": "issue_type~neq", "value": "", "type": "query" }, { "name": "product~neq", "value": "", "type": "query" }, { "name": "severity~neq", "value": "", "type": "query" }, { "name": "subject~neq", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Security Center Issues" }, { "info": { "name": "Cloudflare Get Security Center Issue Counts by Class", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/issues/class", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dismissed", "value": "", "type": "query" }, { "name": "issue_class", "value": "", "type": "query" }, { "name": "issue_type", "value": "", "type": "query" }, { "name": "product", "value": "", "type": "query" }, { "name": "severity", "value": "", "type": "query" }, { "name": "subject", "value": "", "type": "query" }, { "name": "issue_class~neq", "value": "", "type": "query" }, { "name": "issue_type~neq", "value": "", "type": "query" }, { "name": "product~neq", "value": "", "type": "query" }, { "name": "severity~neq", "value": "", "type": "query" }, { "name": "subject~neq", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Security Center Issue Counts by Class" }, { "info": { "name": "Cloudflare Get Security Center Issue Counts by Severity", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/issues/severity", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dismissed", "value": "", "type": "query" }, { "name": "issue_class", "value": "", "type": "query" }, { "name": "issue_type", "value": "", "type": "query" }, { "name": "product", "value": "", "type": "query" }, { "name": "severity", "value": "", "type": "query" }, { "name": "subject", "value": "", "type": "query" }, { "name": "issue_class~neq", "value": "", "type": "query" }, { "name": "issue_type~neq", "value": "", "type": "query" }, { "name": "product~neq", "value": "", "type": "query" }, { "name": "severity~neq", "value": "", "type": "query" }, { "name": "subject~neq", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Security Center Issue Counts by Severity" }, { "info": { "name": "Cloudflare Get Security Center Issue Counts by Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/attack-surface-report/issues/type", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dismissed", "value": "", "type": "query" }, { "name": "issue_class", "value": "", "type": "query" }, { "name": "issue_type", "value": "", "type": "query" }, { "name": "product", "value": "", "type": "query" }, { "name": "severity", "value": "", "type": "query" }, { "name": "subject", "value": "", "type": "query" }, { "name": "issue_class~neq", "value": "", "type": "query" }, { "name": "issue_type~neq", "value": "", "type": "query" }, { "name": "product~neq", "value": "", "type": "query" }, { "name": "severity~neq", "value": "", "type": "query" }, { "name": "subject~neq", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Security Center Issue Counts by Type" }, { "info": { "name": "Cloudflare Get Passive DNS by IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/dns", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "start_end_params", "value": "", "type": "query" }, { "name": "ipv4", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Passive DNS by IP" }, { "info": { "name": "Cloudflare Get Domain Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/domain", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Domain Details" }, { "info": { "name": "Cloudflare Get Domain History", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/domain-history", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Domain History" }, { "info": { "name": "Cloudflare Get Multiple Domain Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/domain/bulk", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get Multiple Domain Details" }, { "info": { "name": "Cloudflare Get indicator feeds owned by this account", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get indicator feeds owned by this account" }, { "info": { "name": "Cloudflare Create new indicator feed", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create new indicator feed" }, { "info": { "name": "Cloudflare Get indicator feed metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/:feed_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "feed_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get indicator feed metadata" }, { "info": { "name": "Cloudflare Get indicator feed data", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/:feed_id/data", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "feed_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get indicator feed data" }, { "info": { "name": "Cloudflare Update indicator feed data", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/:feed_id/snapshot", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "feed_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "source", "type": "text", "value": "" } ] } }, "docs": "Cloudflare Update indicator feed data" }, { "info": { "name": "Cloudflare Grant permission to indicator feed", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/permissions/add", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Grant permission to indicator feed" }, { "info": { "name": "Cloudflare Revoke permission to indicator feed", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/permissions/remove", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Revoke permission to indicator feed" }, { "info": { "name": "Cloudflare List indicator feed permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/indicator-feeds/permissions/view", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List indicator feed permissions" }, { "info": { "name": "Cloudflare Get IP Overview", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/ip", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ipv4", "value": "", "type": "query" }, { "name": "ipv6", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get IP Overview" }, { "info": { "name": "Cloudflare Get IP Lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/ip-list", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get IP Lists" }, { "info": { "name": "Cloudflare Create Miscategorization", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/miscategorization", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create Miscategorization" }, { "info": { "name": "Cloudflare List sinkholes owned by this account", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/sinkholes", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List sinkholes owned by this account" }, { "info": { "name": "Cloudflare Get WHOIS Record", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/intel/whois", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "query" } ] }, "docs": "Cloudflare Get WHOIS Record" }, { "info": { "name": "Cloudflare List Monitors", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List configured monitors for an account." }, { "info": { "name": "Cloudflare Create Monitor", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a configured monitor." }, { "info": { "name": "Cloudflare Monitor Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List a single configured monitor for an account." }, { "info": { "name": "Cloudflare Update Monitor", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a configured monitor." }, { "info": { "name": "Cloudflare Patch Monitor", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply changes to an existing monitor, overwriting the supplied properties." }, { "info": { "name": "Cloudflare Delete Monitor", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a configured monitor." }, { "info": { "name": "Cloudflare Preview Monitor", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id/preview", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results." }, { "info": { "name": "Cloudflare List Monitor References", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/monitors/:monitor_id/references", "params": [ { "name": "monitor_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get the list of resources that reference the provided monitor." }, { "info": { "name": "Cloudflare List Pools", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "monitor", "value": "", "type": "query" } ] }, "docs": "List configured pools." }, { "info": { "name": "Cloudflare Create Pool", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pool." }, { "info": { "name": "Cloudflare Patch Pools", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`." }, { "info": { "name": "Cloudflare Pool Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a single configured pool." }, { "info": { "name": "Cloudflare Update Pool", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a configured pool." }, { "info": { "name": "Cloudflare Patch Pool", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply changes to an existing pool, overwriting the supplied properties." }, { "info": { "name": "Cloudflare Delete Pool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a configured pool." }, { "info": { "name": "Cloudflare Pool Health Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id/health", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch the latest pool health status for a single pool." }, { "info": { "name": "Cloudflare Preview Pool", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id/preview", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results." }, { "info": { "name": "Cloudflare List Pool References", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/pools/:pool_id/references", "params": [ { "name": "pool_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get the list of resources that reference the provided pool." }, { "info": { "name": "Cloudflare Preview Result", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/preview/:preview_id", "params": [ { "name": "preview_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get the result of a previous preview operation using the provided preview_id." }, { "info": { "name": "Cloudflare List Regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/regions", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "subdivision_code", "value": "", "type": "query" }, { "name": "subdivision_code_a2", "value": "", "type": "query" }, { "name": "country_code_a2", "value": "", "type": "query" } ] }, "docs": "List all region mappings." }, { "info": { "name": "Cloudflare Get Region", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/regions/:region_id", "params": [ { "name": "region_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get a single region mapping." }, { "info": { "name": "Cloudflare Search Resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/load_balancers/search", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "search_params", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Search for Load Balancing resources." }, { "info": { "name": "Cloudflare List fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/datasets/:dataset_id/fields", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions." }, { "info": { "name": "Cloudflare List Logpush jobs for a dataset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/datasets/:dataset_id/jobs", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists Logpush jobs for an account for a dataset." }, { "info": { "name": "Cloudflare List Logpush jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/jobs", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists Logpush jobs for an account." }, { "info": { "name": "Cloudflare Create Logpush job", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/jobs", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Logpush job for an account." }, { "info": { "name": "Cloudflare Get Logpush job details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the details of a Logpush job." }, { "info": { "name": "Cloudflare Update Logpush job", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Logpush job." }, { "info": { "name": "Cloudflare Delete Logpush job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Logpush job." }, { "info": { "name": "Cloudflare Get ownership challenge", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/ownership", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets a new ownership challenge sent to your destination." }, { "info": { "name": "Cloudflare Validate ownership challenge", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/ownership/validate", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates ownership challenge of the destination." }, { "info": { "name": "Cloudflare Check destination exists", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/validate/destination/exists", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Checks if there is an existing job with a destination." }, { "info": { "name": "Cloudflare Validate origin", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logpush/validate/origin", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates logpull origin with logpull_options." }, { "info": { "name": "Cloudflare Get CMB config", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logs/control/cmb/config", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets CMB config." }, { "info": { "name": "Cloudflare Update CMB config", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logs/control/cmb/config", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates CMB config." }, { "info": { "name": "Cloudflare Delete CMB config", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/logs/control/cmb/config", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes CMB config." }, { "info": { "name": "Cloudflare List Members", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/members", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "order", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List all members of an account." }, { "info": { "name": "Cloudflare Add Member", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/members", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to the list of members for this account." }, { "info": { "name": "Cloudflare Member Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/members/:member_id", "params": [ { "name": "member_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get information about a specific member of an account." }, { "info": { "name": "Cloudflare Update Member", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/members/:member_id", "params": [ { "name": "member_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an account member." }, { "info": { "name": "Cloudflare Remove Member", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/members/:member_id", "params": [ { "name": "member_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a member from an account." }, { "info": { "name": "Cloudflare List mTLS certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/mtls_certificates", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all mTLS certificates." }, { "info": { "name": "Cloudflare Upload mTLS certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/mtls_certificates", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a certificate that you want to use with mTLS-enabled Cloudflare services." }, { "info": { "name": "Cloudflare Get mTLS certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/mtls_certificates/:mtls_certificate_id", "params": [ { "name": "mtls_certificate_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single mTLS certificate." }, { "info": { "name": "Cloudflare Delete mTLS certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/mtls_certificates/:mtls_certificate_id", "params": [ { "name": "mtls_certificate_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services." }, { "info": { "name": "Cloudflare List mTLS certificate associations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/mtls_certificates/:mtls_certificate_id/associations", "params": [ { "name": "mtls_certificate_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all active associations between the certificate and Cloudflare services." }, { "info": { "name": "Cloudflare Get projects", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a list of all user projects." }, { "info": { "name": "Cloudflare Create project", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new project." }, { "info": { "name": "Cloudflare Get project", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a project by name." }, { "info": { "name": "Cloudflare Update project", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null." }, { "info": { "name": "Cloudflare Delete project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a project by name." }, { "info": { "name": "Cloudflare Get deployments", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a list of project deployments." }, { "info": { "name": "Cloudflare Create deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "branch", "type": "text", "value": "" } ] } }, "docs": "Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard." }, { "info": { "name": "Cloudflare Get deployment info", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch information about a deployment." }, { "info": { "name": "Cloudflare Delete deployment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a deployment." }, { "info": { "name": "Cloudflare Get deployment logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/history/logs", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch deployment logs for a project." }, { "info": { "name": "Cloudflare Retry deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/retry", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry a previous deployment." }, { "info": { "name": "Cloudflare Rollback deployment", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/rollback", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production." }, { "info": { "name": "Cloudflare Get domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a list of all domains associated with a Pages project." }, { "info": { "name": "Cloudflare Add domain", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new domain for the Pages project." }, { "info": { "name": "Cloudflare Get domain", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a single domain." }, { "info": { "name": "Cloudflare Patch domain", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retry the validation status of a single domain." }, { "info": { "name": "Cloudflare Delete domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" }, { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a Pages project's domain." }, { "info": { "name": "Cloudflare Purge build cache", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/purge_build_cache", "params": [ { "name": "project_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Purge all cached build artifacts for a Pages project" }, { "info": { "name": "Cloudflare List packet capture requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all packet capture requests for an account." }, { "info": { "name": "Cloudflare Create PCAP request", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new PCAP request for account." }, { "info": { "name": "Cloudflare Get PCAP request", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/:pcap_id", "params": [ { "name": "pcap_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get information for a PCAP request by id." }, { "info": { "name": "Cloudflare Download Simple PCAP", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/:pcap_id/download", "params": [ { "name": "pcap_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Download PCAP information into a file. Response is a binary PCAP file." }, { "info": { "name": "Cloudflare List PCAPs Bucket Ownership", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/ownership", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List all buckets configured for use with PCAPs API." }, { "info": { "name": "Cloudflare Add buckets for full packet captures", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/ownership", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an AWS or GCP bucket to use with full packet captures." }, { "info": { "name": "Cloudflare Delete buckets for full packet captures", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/ownership/:ownership_id", "params": [ { "name": "ownership_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes buckets added to the packet captures API." }, { "info": { "name": "Cloudflare Validate buckets for full packet captures", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/pcaps/ownership/validate", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates buckets added to the packet captures API." }, { "info": { "name": "Cloudflare List Buckets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name_contains", "value": "", "type": "query" }, { "name": "start_after", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "Lists all R2 buckets on your account" }, { "info": { "name": "Cloudflare Create Bucket", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new R2 bucket." }, { "info": { "name": "Cloudflare Get Bucket", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets/:bucket_name", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "bucket_name", "value": "", "type": "path" } ] }, "docs": "Gets metadata for an existing R2 bucket." }, { "info": { "name": "Cloudflare Delete Bucket", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets/:bucket_name", "params": [ { "name": "bucket_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing R2 bucket." }, { "info": { "name": "Cloudflare Get Sippy Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets/:bucket_name/sippy", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "bucket_name", "value": "", "type": "path" } ] }, "docs": "Gets configuration for Sippy for an existing R2 bucket." }, { "info": { "name": "Cloudflare Enable Sippy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets/:bucket_name/sippy", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "bucket_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets configuration for Sippy for an existing R2 bucket." }, { "info": { "name": "Cloudflare Disable Sippy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/r2/buckets/:bucket_name/sippy", "params": [ { "name": "bucket_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Disables Sippy on this bucket" }, { "info": { "name": "Cloudflare List domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/registrar/domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List domains handled by Registrar." }, { "info": { "name": "Cloudflare Get domain", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/registrar/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Show individual domain." }, { "info": { "name": "Cloudflare Update domain", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/registrar/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update individual domain." }, { "info": { "name": "Cloudflare List Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/roles", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get all available roles for an account." }, { "info": { "name": "Cloudflare Role Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get information about a specific role for an account." }, { "info": { "name": "Cloudflare Get lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all lists in the account." }, { "info": { "name": "Cloudflare Create a list", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new list of the specified type." }, { "info": { "name": "Cloudflare Get a list", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a list." }, { "info": { "name": "Cloudflare Update a list", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the description of a list." }, { "info": { "name": "Cloudflare Delete a list", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a specific list and all its items." }, { "info": { "name": "Cloudflare Get list items", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id/items", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Fetches all the items in the list." }, { "info": { "name": "Cloudflare Create list items", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id/items", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`." }, { "info": { "name": "Cloudflare Update all list items", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id/items", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`." }, { "info": { "name": "Cloudflare Delete list items", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rules/lists/:list_id/items", "params": [ { "name": "list_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`." }, { "info": { "name": "Cloudflare List account rulesets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches all rulesets at the account level." }, { "info": { "name": "Cloudflare Create an account ruleset", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a ruleset at the account level." }, { "info": { "name": "Cloudflare Get an account ruleset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the latest version of an account ruleset." }, { "info": { "name": "Cloudflare Update an account ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an account ruleset, creating a new version." }, { "info": { "name": "Cloudflare Delete an account ruleset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes all versions of an existing account ruleset." }, { "info": { "name": "Cloudflare Create an account ruleset rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/rules", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default." }, { "info": { "name": "Cloudflare Update an account ruleset rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing rule in an account ruleset." }, { "info": { "name": "Cloudflare Delete an account ruleset rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing rule from an account ruleset." }, { "info": { "name": "Cloudflare List an account ruleset's versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/versions", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the versions of an account ruleset." }, { "info": { "name": "Cloudflare Get an account ruleset version", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a specific version of an account ruleset." }, { "info": { "name": "Cloudflare Delete an account ruleset version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing version of an account ruleset." }, { "info": { "name": "Cloudflare List an account ruleset version's rules by tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/:ruleset_id/versions/:ruleset_version/by_tag/:rule_tag", "params": [ { "name": "rule_tag", "value": "", "type": "path" }, { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the rules of a managed account ruleset version for a given tag." }, { "info": { "name": "Cloudflare Get an account entry point ruleset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the latest version of the account entry point ruleset for a given phase." }, { "info": { "name": "Cloudflare Update an account entry point ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an account entry point ruleset, creating a new version." }, { "info": { "name": "Cloudflare List an account entry point ruleset's versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint/versions", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the versions of an account entry point ruleset." }, { "info": { "name": "Cloudflare Get an account entry point ruleset version", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a specific version of an account entry point ruleset." }, { "info": { "name": "Cloudflare Create a Web Analytics site", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/site_info", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Web Analytics site." }, { "info": { "name": "Cloudflare Get a Web Analytics site", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/site_info/:site_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a Web Analytics site." }, { "info": { "name": "Cloudflare Update a Web Analytics site", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/site_info/:site_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Web Analytics site." }, { "info": { "name": "Cloudflare Delete a Web Analytics site", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/site_info/:site_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing Web Analytics site." }, { "info": { "name": "Cloudflare List Web Analytics sites", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/site_info/list", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" } ] }, "docs": "Lists all Web Analytics sites of an account." }, { "info": { "name": "Cloudflare Create a Web Analytics rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/v2/:ruleset_id/rule", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rule in a Web Analytics ruleset." }, { "info": { "name": "Cloudflare Update a Web Analytics rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/v2/:ruleset_id/rule/:rule_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a rule in a Web Analytics ruleset." }, { "info": { "name": "Cloudflare Delete a Web Analytics rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/v2/:ruleset_id/rule/:rule_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "rule_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing rule from a Web Analytics ruleset." }, { "info": { "name": "Cloudflare List rules in Web Analytics ruleset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/v2/:ruleset_id/rules", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" } ] }, "docs": "Lists all the rules in a Web Analytics ruleset." }, { "info": { "name": "Cloudflare Update Web Analytics rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/rum/v2/:ruleset_id/rules", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies one or more rules in a Web Analytics ruleset with a single request." }, { "info": { "name": "Cloudflare List ACLs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/acls", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List ACLs." }, { "info": { "name": "Cloudflare Create ACL", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/acls", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create ACL." }, { "info": { "name": "Cloudflare ACL Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/acls/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get ACL." }, { "info": { "name": "Cloudflare Update ACL", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/acls/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify ACL." }, { "info": { "name": "Cloudflare Delete ACL", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/acls/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete ACL." }, { "info": { "name": "Cloudflare List Peers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/peers", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List Peers." }, { "info": { "name": "Cloudflare Create Peer", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/peers", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Peer." }, { "info": { "name": "Cloudflare Peer Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/peers/:peer_id", "params": [ { "name": "peer_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get Peer." }, { "info": { "name": "Cloudflare Update Peer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/peers/:peer_id", "params": [ { "name": "peer_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Peer." }, { "info": { "name": "Cloudflare Delete Peer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/peers/:peer_id", "params": [ { "name": "peer_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Peer." }, { "info": { "name": "Cloudflare List TSIGs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/tsigs", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "List TSIGs." }, { "info": { "name": "Cloudflare Create TSIG", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/tsigs", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create TSIG." }, { "info": { "name": "Cloudflare TSIG Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/tsigs/:tsig_id", "params": [ { "name": "tsig_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get TSIG." }, { "info": { "name": "Cloudflare Update TSIG", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/tsigs/:tsig_id", "params": [ { "name": "tsig_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify TSIG." }, { "info": { "name": "Cloudflare Delete TSIG", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/secondary_dns/tsigs/:tsig_id", "params": [ { "name": "tsig_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete TSIG." }, { "info": { "name": "Cloudflare Query Request Analytics", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/analytics", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" } ] }, "docs": "Retrieves Workers KV request metrics for the given account." }, { "info": { "name": "Cloudflare Query Stored Data Analytics", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/analytics/stored", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" } ] }, "docs": "Retrieves Workers KV stored data metrics for the given account." }, { "info": { "name": "Cloudflare List Namespaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Returns the namespaces owned by an account." }, { "info": { "name": "Cloudflare Create a Namespace", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced." }, { "info": { "name": "Cloudflare Rename a Namespace", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a namespace's title." }, { "info": { "name": "Cloudflare Remove a Namespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the namespace corresponding to the given ID." }, { "info": { "name": "Cloudflare Write multiple key-value pairs", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less." }, { "info": { "name": "Cloudflare Delete multiple key-value pairs", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/bulk", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed." }, { "info": { "name": "Cloudflare List a Namespace's Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/keys", "params": [ { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "prefix", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "Lists a namespace's keys." }, { "info": { "name": "Cloudflare Read the metadata for a key", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/metadata/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name." }, { "info": { "name": "Cloudflare Read key-value pair", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header." }, { "info": { "name": "Cloudflare Write key-value pair with metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "metadata", "type": "text", "value": "" }, { "name": "value", "type": "text", "value": "" } ] } }, "docs": "Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored along with JSON metadata to be associated with the key/value pair. Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored." }, { "info": { "name": "Cloudflare Delete key-value pair", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/storage/kv/namespaces/:namespace_id/values/:key_name", "params": [ { "name": "key_name", "value": "", "type": "path" }, { "name": "namespace_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name." }, { "info": { "name": "Cloudflare List videos", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" }, { "name": "creator", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "asc", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "include_counts", "value": "", "type": "query" } ] }, "docs": "Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters." }, { "info": { "name": "Cloudflare Initiate video uploads using TUS", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream", "headers": [ { "name": "Tus-Resumable", "value": "" }, { "name": "Upload-Creator", "value": "" }, { "name": "Upload-Length", "value": "" }, { "name": "Upload-Metadata", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details." }, { "info": { "name": "Cloudflare Retrieve video details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches details for a single video." }, { "info": { "name": "Cloudflare Edit video details", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit details for a single video." }, { "info": { "name": "Cloudflare Delete video", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a video and its copies from Cloudflare Stream." }, { "info": { "name": "Cloudflare List additional audio tracks on a video", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/audio", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload." }, { "info": { "name": "Cloudflare Edit additional audio tracks on a video", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/audio/:audio_identifier", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "audio_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`." }, { "info": { "name": "Cloudflare Delete additional audio tracks on a video", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/audio/:audio_identifier", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "audio_identifier", "value": "", "type": "path" } ] }, "docs": "Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion." }, { "info": { "name": "Cloudflare Add audio tracks to a video", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/audio/copy", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an additional audio track to a video using the provided audio track URL." }, { "info": { "name": "Cloudflare List captions or subtitles", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/captions", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists the available captions or subtitles for a specific video." }, { "info": { "name": "Cloudflare Upload captions or subtitles", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/captions/:language", "params": [ { "name": "language", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed." }, { "info": { "name": "Cloudflare Delete captions or subtitles", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/captions/:language", "params": [ { "name": "language", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the captions or subtitles from a video." }, { "info": { "name": "Cloudflare List downloads", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/downloads", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists the downloads created for a video." }, { "info": { "name": "Cloudflare Create downloads", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/downloads", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a download for a video when a video is ready to view." }, { "info": { "name": "Cloudflare Delete downloads", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/downloads", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Delete the downloads for a video." }, { "info": { "name": "Cloudflare Retrieve embed Code HTML", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/embed", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body." }, { "info": { "name": "Cloudflare Create signed URL tokens for videos", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/:identifier/token", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values." }, { "info": { "name": "Cloudflare Clip videos given a start and end time", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/clip", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clips a video based on the specified start and end times provided in seconds." }, { "info": { "name": "Cloudflare Upload videos from a URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/copy", "headers": [ { "name": "Upload-Creator", "value": "" }, { "name": "Upload-Metadata", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a video to Stream from a provided URL." }, { "info": { "name": "Cloudflare Upload videos via direct upload URLs", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/direct_upload", "headers": [ { "name": "Upload-Creator", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a direct upload that allows video uploads without an API key." }, { "info": { "name": "Cloudflare List signing keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/keys", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists the video ID and creation date and time when a signing key was created." }, { "info": { "name": "Cloudflare Create signing keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/keys", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video." }, { "info": { "name": "Cloudflare Delete signing keys", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/keys/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes signing keys and revokes all signed URLs generated with the key." }, { "info": { "name": "Cloudflare List live inputs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "include_counts", "value": "", "type": "query" } ] }, "docs": "Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input." }, { "info": { "name": "Cloudflare Create a live input", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream." }, { "info": { "name": "Cloudflare Retrieve a live input", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier", "params": [ { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of an existing live input." }, { "info": { "name": "Cloudflare Update a live input", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier", "params": [ { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specified live input." }, { "info": { "name": "Cloudflare Delete a live input", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier", "params": [ { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls." }, { "info": { "name": "Cloudflare List all outputs associated with a specified live input", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier/outputs", "params": [ { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Retrieves all outputs associated with a specified live input." }, { "info": { "name": "Cloudflare Create a new output, connected to a live input", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier/outputs", "params": [ { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs." }, { "info": { "name": "Cloudflare Update an output", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier/outputs/:output_identifier", "params": [ { "name": "output_identifier", "value": "", "type": "path" }, { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the state of an output." }, { "info": { "name": "Cloudflare Delete an output", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/live_inputs/:live_input_identifier/outputs/:output_identifier", "params": [ { "name": "output_identifier", "value": "", "type": "path" }, { "name": "live_input_identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an output and removes it from the associated live input." }, { "info": { "name": "Cloudflare Storage use", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/storage-usage", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "creator", "value": "", "type": "query" } ] }, "docs": "Returns information about an account's storage use." }, { "info": { "name": "Cloudflare List watermark profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/watermarks", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Lists all watermark profiles for an account." }, { "info": { "name": "Cloudflare Create watermark profiles via basic upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/watermarks", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Creates watermark profiles using a single `HTTP POST multipart/form-data` request." }, { "info": { "name": "Cloudflare Watermark profile details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/watermarks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details for a single watermark profile." }, { "info": { "name": "Cloudflare Delete watermark profiles", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/watermarks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a watermark profile." }, { "info": { "name": "Cloudflare View webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/webhook", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a list of webhooks." }, { "info": { "name": "Cloudflare Create webhooks", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/webhook", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a webhook notification." }, { "info": { "name": "Cloudflare Delete webhooks", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/stream/webhook", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a webhook." }, { "info": { "name": "Cloudflare List tunnel routes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "comment", "value": "", "type": "query" }, { "name": "is_deleted", "value": "", "type": "query" }, { "name": "network_subset", "value": "", "type": "query" }, { "name": "network_superset", "value": "", "type": "query" }, { "name": "existed_at", "value": "", "type": "query" }, { "name": "tunnel_id", "value": "", "type": "query" }, { "name": "route_id", "value": "", "type": "query" }, { "name": "tun_types", "value": "", "type": "query" }, { "name": "virtual_network_id", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Lists and filters private network routes in an account." }, { "info": { "name": "Cloudflare Create a tunnel route", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Routes a private network through a Cloudflare Tunnel." }, { "info": { "name": "Cloudflare Update a tunnel route", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/:route_id", "params": [ { "name": "route_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request." }, { "info": { "name": "Cloudflare Delete a tunnel route", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/:route_id", "params": [ { "name": "route_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Deletes a private network route from an account.\n" }, { "info": { "name": "Cloudflare Get tunnel route by IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/ip/:ip", "params": [ { "name": "ip", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "virtual_network_id", "value": "", "type": "query" } ] }, "docs": "Fetches routes that contain the given IP address." }, { "info": { "name": "Cloudflare Create a tunnel route (CIDR Endpoint)", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/network/:ip_network_encoded", "params": [ { "name": "ip_network_encoded", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format." }, { "info": { "name": "Cloudflare Update a tunnel route (CIDR Endpoint)", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/network/:ip_network_encoded", "params": [ { "name": "ip_network_encoded", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format." }, { "info": { "name": "Cloudflare Delete a tunnel route (CIDR Endpoint)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/routes/network/:ip_network_encoded", "params": [ { "name": "ip_network_encoded", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "virtual_network_id", "value": "", "type": "query" }, { "name": "tun_type", "value": "", "type": "query" }, { "name": "tunnel_id", "value": "", "type": "query" } ] }, "docs": "Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.\n" }, { "info": { "name": "Cloudflare List virtual networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/virtual_networks", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "is_default", "value": "", "type": "query" }, { "name": "is_deleted", "value": "", "type": "query" }, { "name": "vnet_name", "value": "", "type": "query" }, { "name": "vnet_id", "value": "", "type": "query" } ] }, "docs": "Lists and filters virtual networks in an account." }, { "info": { "name": "Cloudflare Create a virtual network", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/virtual_networks", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new virtual network to an account." }, { "info": { "name": "Cloudflare Update a virtual network", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/virtual_networks/:virtual_network_id", "params": [ { "name": "virtual_network_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing virtual network." }, { "info": { "name": "Cloudflare Delete a virtual network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/teamnet/virtual_networks/:virtual_network_id", "params": [ { "name": "virtual_network_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing virtual network." }, { "info": { "name": "Cloudflare List All Tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/tunnels", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "is_deleted", "value": "", "type": "query" }, { "name": "existed_at", "value": "", "type": "query" }, { "name": "uuid", "value": "", "type": "query" }, { "name": "was_active_at", "value": "", "type": "query" }, { "name": "was_inactive_at", "value": "", "type": "query" }, { "name": "include_prefix", "value": "", "type": "query" }, { "name": "exclude_prefix", "value": "", "type": "query" }, { "name": "tun_types", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Lists and filters all types of Tunnels in an account." }, { "info": { "name": "Cloudflare Create an Argo Tunnel", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/tunnels", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Argo Tunnel in an account." }, { "info": { "name": "Cloudflare Get an Argo Tunnel", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/tunnels/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Argo Tunnel." }, { "info": { "name": "Cloudflare Delete an Argo Tunnel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/tunnels/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an Argo Tunnel from an account." }, { "info": { "name": "Cloudflare Clean up Argo Tunnel connections", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/tunnels/:tunnel_id/connections", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel." }, { "info": { "name": "Cloudflare List Warp Connector Tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "is_deleted", "value": "", "type": "query" }, { "name": "existed_at", "value": "", "type": "query" }, { "name": "uuid", "value": "", "type": "query" }, { "name": "was_active_at", "value": "", "type": "query" }, { "name": "was_inactive_at", "value": "", "type": "query" }, { "name": "include_prefix", "value": "", "type": "query" }, { "name": "exclude_prefix", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Lists and filters Warp Connector Tunnels in an account." }, { "info": { "name": "Cloudflare Create a Warp Connector Tunnel", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Warp Connector Tunnel in an account." }, { "info": { "name": "Cloudflare Get a Warp Connector Tunnel", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches a single Warp Connector Tunnel." }, { "info": { "name": "Cloudflare Update a Warp Connector Tunnel", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Warp Connector Tunnel." }, { "info": { "name": "Cloudflare Delete a Warp Connector Tunnel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector/:tunnel_id", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Warp Connector Tunnel from an account." }, { "info": { "name": "Cloudflare Get a Warp Connector Tunnel token", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/warp_connector/:tunnel_id/token", "params": [ { "name": "tunnel_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the token used to associate warp device with a specific Warp Connector tunnel." }, { "info": { "name": "Cloudflare Fetch Worker Account Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/account-settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches Worker account settings for an account." }, { "info": { "name": "Cloudflare Create Worker Account Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/account-settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates Worker account settings for an account." }, { "info": { "name": "Cloudflare List Deployments", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/deployments/by-script/:script_id", "params": [ { "name": "script_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List Deployments" }, { "info": { "name": "Cloudflare Get Deployment Detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/deployments/by-script/:script_id/detail/:deployment_id", "params": [ { "name": "deployment_id", "value": "", "type": "path" }, { "name": "script_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Deployment Detail" }, { "info": { "name": "Cloudflare List dispatch namespaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a list of Workers for Platforms namespaces." }, { "info": { "name": "Cloudflare Create dispatch namespace", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Fetch dispatch namespace", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" } ] }, "docs": "Fetch a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Delete dispatch namespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" } ] }, "docs": "Delete a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Worker Details (Workers for Platforms)", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Fetch information about a script uploaded to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Upload Worker Module (Workers for Platforms)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload a worker module to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Delete Worker (Workers for Platforms)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" }, { "name": "force", "value": "", "type": "query", "description": "If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete." }, { "info": { "name": "Cloudflare Get Script Bindings (Workers for Platforms)", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name/bindings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Fetch script bindings from a script uploaded to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Get Script Content (Workers for Platforms)", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name/content", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Fetch script content from a script uploaded to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Put Script Content (Workers for Platforms)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name/content", "headers": [ { "name": "CF-WORKER-BODY-PART", "value": "" }, { "name": "CF-WORKER-MAIN-MODULE-PART", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "", "type": "text", "value": "" }, { "name": "metadata", "type": "text", "value": "" } ] } }, "docs": "Put script content for a script uploaded to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Get Script Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Get script settings from a script uploaded to a Workers for Platforms namespace." }, { "info": { "name": "Cloudflare Patch Script Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/dispatch/namespaces/:dispatch_namespace/scripts/:script_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "dispatch_namespace", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch script metadata, such as bindings" }, { "info": { "name": "Cloudflare List Domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/domains", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "zone_name", "value": "", "type": "query" }, { "name": "service", "value": "", "type": "query" }, { "name": "zone_id", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query" }, { "name": "environment", "value": "", "type": "query" } ] }, "docs": "Lists all Worker Domains for an account." }, { "info": { "name": "Cloudflare Attach to Domain", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/domains", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches a Worker to a zone and hostname." }, { "info": { "name": "Cloudflare Get a Domain", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/domains/:domain_id", "params": [ { "name": "domain_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets a Worker domain." }, { "info": { "name": "Cloudflare Detach from Domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/domains/:domain_id", "params": [ { "name": "domain_id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches a Worker from a zone and hostname." }, { "info": { "name": "Cloudflare List Namespaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/durable_objects/namespaces", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the Durable Object namespaces owned by an account." }, { "info": { "name": "Cloudflare List Objects", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/durable_objects/namespaces/:id/objects", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "Returns the Durable Objects in a given namespace." }, { "info": { "name": "Cloudflare List Queues", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the queues owned by an account." }, { "info": { "name": "Cloudflare Create Queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new queue." }, { "info": { "name": "Cloudflare Queue Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get information about a specific queue." }, { "info": { "name": "Cloudflare Update Queue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a queue." }, { "info": { "name": "Cloudflare Delete Queue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a queue." }, { "info": { "name": "Cloudflare List Queue Consumers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name/consumers", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns the consumers for a queue." }, { "info": { "name": "Cloudflare Create Queue Consumer", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name/consumers", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new consumer for a queue." }, { "info": { "name": "Cloudflare Update Queue Consumer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name/consumers/:consumer_name", "params": [ { "name": "consumer_name", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the consumer for a queue, or creates one if it does not exist." }, { "info": { "name": "Cloudflare Delete Queue Consumer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/queues/:name/consumers/:consumer_name", "params": [ { "name": "consumer_name", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the consumer for a queue." }, { "info": { "name": "Cloudflare List Workers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch a list of uploaded workers." }, { "info": { "name": "Cloudflare Download Worker", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetch raw script content for your worker. Note this is the original script content, not JSON encoded." }, { "info": { "name": "Cloudflare Upload Worker Module", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "rollback_to", "value": "", "type": "query", "description": "Rollback to provided deployment based on deployment ID. Request body will only parse a \"message\" part. You can learn more about deployments [here](https://developers.cloudflare.com/workers/platform/deployments/)." } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload a worker module." }, { "info": { "name": "Cloudflare Delete Worker", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" }, { "name": "force", "value": "", "type": "query", "description": "If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete your worker. This call has no response body on a successful delete." }, { "info": { "name": "Cloudflare Put script content", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/content", "headers": [ { "name": "CF-WORKER-BODY-PART", "value": "" }, { "name": "CF-WORKER-MAIN-MODULE-PART", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "", "type": "text", "value": "" }, { "name": "metadata", "type": "text", "value": "" } ] } }, "docs": "Put script content without touching config or metadata" }, { "info": { "name": "Cloudflare Get script content", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/content/v2", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Fetch script content only" }, { "info": { "name": "Cloudflare Get Cron Triggers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/schedules", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches Cron Triggers for a Worker." }, { "info": { "name": "Cloudflare Update Cron Triggers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/schedules", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Cron Triggers for a Worker." }, { "info": { "name": "Cloudflare Get Script Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ] }, "docs": "Get script metadata and config, such as bindings or usage model" }, { "info": { "name": "Cloudflare Patch Script Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "settings", "type": "text", "value": "" } ] } }, "docs": "Patch script metadata or config, such as bindings or usage model" }, { "info": { "name": "Cloudflare List Tails", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/tails", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Get list of tails currently deployed on a Worker." }, { "info": { "name": "Cloudflare Start Tail", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/tails", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a tail that receives logs and exception from a Worker." }, { "info": { "name": "Cloudflare Delete Tail", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/tails/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a tail from a Worker." }, { "info": { "name": "Cloudflare Fetch Usage Model", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/usage-model", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Fetches the Usage Model for a given Worker." }, { "info": { "name": "Cloudflare Update Usage Model", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/scripts/:script_name/usage-model", "params": [ { "name": "script_name", "value": "", "type": "path" }, { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Usage Model for a given Worker. Requires a Workers Paid subscription." }, { "info": { "name": "Cloudflare Get script content", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/services/:service_name/environments/:environment_name/content", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "environment_name", "value": "", "type": "path" } ] }, "docs": "Get script content from a worker with an environment" }, { "info": { "name": "Cloudflare Put script content", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/services/:service_name/environments/:environment_name/content", "headers": [ { "name": "CF-WORKER-BODY-PART", "value": "" }, { "name": "CF-WORKER-MAIN-MODULE-PART", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "environment_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "", "type": "text", "value": "" }, { "name": "metadata", "type": "text", "value": "" } ] } }, "docs": "Put script content from a worker with an environment" }, { "info": { "name": "Cloudflare Get Script Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/services/:service_name/environments/:environment_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "environment_name", "value": "", "type": "path" } ] }, "docs": "Get script settings from a worker with an environment" }, { "info": { "name": "Cloudflare Patch Script Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/services/:service_name/environments/:environment_name/settings", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "environment_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch script metadata, such as bindings" }, { "info": { "name": "Cloudflare Get Subdomain", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/subdomain", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Returns a Workers subdomain for an account." }, { "info": { "name": "Cloudflare Create Subdomain", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/workers/subdomain", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Workers subdomain for an account." }, { "info": { "name": "Cloudflare Get Zero Trust Connectivity Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/zerotrust/connectivity_settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ] }, "docs": "Gets the Zero Trust Connectivity Settings for the given account." }, { "info": { "name": "Cloudflare Updates the Zero Trust Connectivity Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_id/zerotrust/connectivity_settings", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Zero Trust Connectivity Settings for the given account." }, { "info": { "name": "Cloudflare Billing Profile Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/billing/profile", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Gets the current billing profile for the account." }, { "info": { "name": "Cloudflare List Requests", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare List Requests" }, { "info": { "name": "Cloudflare Get a Request", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get a Request" }, { "info": { "name": "Cloudflare Update a Request", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body" }, { "info": { "name": "Cloudflare Delete a Request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Delete a Request" }, { "info": { "name": "Cloudflare List Request Messages", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier/message", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare List Request Messages" }, { "info": { "name": "Cloudflare Update a Request Message", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier/message/:message_identifer", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" }, { "name": "message_identifer", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update a Request Message" }, { "info": { "name": "Cloudflare Delete a Request Message", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier/message/:message_identifer", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" }, { "name": "message_identifer", "value": "", "type": "path" } ] }, "docs": "Cloudflare Delete a Request Message" }, { "info": { "name": "Cloudflare Create a New Request Message", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/:request_identifier/message/new", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "request_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided a default will be assigned." }, { "info": { "name": "Cloudflare Get Request Priority, Status, and TLP constants", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/constants", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Request Priority, Status, and TLP constants" }, { "info": { "name": "Cloudflare Create a New Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/new", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided a default will be assigned." }, { "info": { "name": "Cloudflare List Priority Intelligence Requirements", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare List Priority Intelligence Requirements" }, { "info": { "name": "Cloudflare Get a Priority Intelligence Requirement", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority/:priority_identifer", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "priority_identifer", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get a Priority Intelligence Requirement" }, { "info": { "name": "Cloudflare Update a Priority Intelligence Requirement", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority/:priority_identifer", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "priority_identifer", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update a Priority Intelligence Requirement" }, { "info": { "name": "Cloudflare Delete a Priority Intelligence Report", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority/:priority_identifer", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "priority_identifer", "value": "", "type": "path" } ] }, "docs": "Cloudflare Delete a Priority Intelligence Report" }, { "info": { "name": "Cloudflare Create a New Priority Requirement", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority/new", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create a New Priority Requirement" }, { "info": { "name": "Cloudflare Get Priority Intelligence Requirement Quota", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/priority/quota", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Priority Intelligence Requirement Quota" }, { "info": { "name": "Cloudflare Get Request Quota", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/quota", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Request Quota" }, { "info": { "name": "Cloudflare Get Request Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/cloudforce-one/requests/types", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Request Types" }, { "info": { "name": "Cloudflare List custom pages", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/custom_pages", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches all the custom pages at the account level." }, { "info": { "name": "Cloudflare Get a custom page", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/custom_pages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a custom page." }, { "info": { "name": "Cloudflare Update a custom page", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/custom_pages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing custom page." }, { "info": { "name": "Cloudflare Get D1 Database", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/d1/database/:database_identifier", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "database_identifier", "value": "", "type": "path" } ] }, "docs": "Returns the specified D1 database." }, { "info": { "name": "Cloudflare Delete D1 Database", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/d1/database/:database_identifier", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "database_identifier", "value": "", "type": "path" } ] }, "docs": "Deletes the specified D1 database." }, { "info": { "name": "Cloudflare Query D1 Database", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/d1/database/:database_identifier/query", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "database_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the query result." }, { "info": { "name": "Cloudflare Table", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/dns_firewall/:identifier/dns_analytics/report", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters." }, { "info": { "name": "Cloudflare By Time", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/dns_firewall/:identifier/dns_analytics/report/bytime", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "time_delta", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters." }, { "info": { "name": "Cloudflare List destination addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/email/routing/addresses", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "verified", "value": "", "type": "query" } ] }, "docs": "Lists existing destination addresses." }, { "info": { "name": "Cloudflare Create a destination address", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/email/routing/addresses", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used." }, { "info": { "name": "Cloudflare Get a destination address", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/email/routing/addresses/:destination_address_identifier", "params": [ { "name": "destination_address_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Gets information for a specific destination email already created." }, { "info": { "name": "Cloudflare Delete destination address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/email/routing/addresses/:destination_address_identifier", "params": [ { "name": "destination_address_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Deletes a specific destination address." }, { "info": { "name": "Cloudflare List IP Access rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/firewall/access_rules/rules", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "filters", "value": "", "type": "query" }, { "name": "egs-pagination.json", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create an IP Access rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/firewall/access_rules/rules", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IP Access rule for an account. The rule will apply to all zones in the account.\n\nNote: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints." }, { "info": { "name": "Cloudflare Get an IP Access rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of an IP Access rule defined at the account level." }, { "info": { "name": "Cloudflare Update an IP Access rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account." }, { "info": { "name": "Cloudflare Delete an IP Access rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account." }, { "info": { "name": "Cloudflare List interconnects", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/cf_interconnects", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists interconnects associated with an account." }, { "info": { "name": "Cloudflare Update multiple interconnects", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/cf_interconnects", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare List interconnect Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/cf_interconnects/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists details for a specific interconnect." }, { "info": { "name": "Cloudflare Update interconnect", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/cf_interconnects/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare List GRE tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists GRE tunnels associated with an account." }, { "info": { "name": "Cloudflare Create GRE tunnels", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare Update multiple GRE tunnels", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare List GRE Tunnel Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists informtion for a specific GRE tunnel." }, { "info": { "name": "Cloudflare Update GRE Tunnel", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare Delete GRE Tunnel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare List IPsec tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists IPsec tunnels associated with an account." }, { "info": { "name": "Cloudflare Create IPsec tunnels", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare Update multiple IPsec tunnels", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare List IPsec tunnel details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists details for a specific IPsec tunnel." }, { "info": { "name": "Cloudflare Update IPsec Tunnel", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare Delete IPsec Tunnel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels/:tunnel_identifier", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes." }, { "info": { "name": "Cloudflare Generate Pre Shared Key (PSK) for IPsec tunnels", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/ipsec_tunnels/:tunnel_identifier/psk_generate", "params": [ { "name": "tunnel_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place." }, { "info": { "name": "Cloudflare List Routes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "List all Magic static routes." }, { "info": { "name": "Cloudflare Create Routes", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes." }, { "info": { "name": "Cloudflare Update Many Routes", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided." }, { "info": { "name": "Cloudflare Delete Many Routes", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete multiple Magic static routes." }, { "info": { "name": "Cloudflare Route Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes/:route_identifier", "params": [ { "name": "route_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Get a specific Magic static route." }, { "info": { "name": "Cloudflare Update Route", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes/:route_identifier", "params": [ { "name": "route_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes." }, { "info": { "name": "Cloudflare Delete Route", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/routes/:route_identifier", "params": [ { "name": "route_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable and remove a specific Magic static route." }, { "info": { "name": "Cloudflare List Sites", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "connector_identifier", "value": "", "type": "query" } ] }, "docs": "Lists Sites associated with an account. Use connector_identifier query param to return sites where connector_identifier matches either site.ConnectorID or site.SecondaryConnectorID." }, { "info": { "name": "Cloudflare Create a new Site", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Site" }, { "info": { "name": "Cloudflare Site Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Get a specific Site." }, { "info": { "name": "Cloudflare Update Site", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Site." }, { "info": { "name": "Cloudflare Delete Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a specific Site." }, { "info": { "name": "Cloudflare List Site ACLs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/acls", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ] }, "docs": "Lists Site ACLs associated with an account." }, { "info": { "name": "Cloudflare Create a new Site ACL", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/acls", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Site ACL." }, { "info": { "name": "Cloudflare Site ACL Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/acls/:acl_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "acl_identifier", "value": "", "type": "path" } ] }, "docs": "Get a specific Site ACL." }, { "info": { "name": "Cloudflare Update Site ACL", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/acls/:acl_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "acl_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Site ACL." }, { "info": { "name": "Cloudflare Delete Site ACL", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/acls/:acl_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "acl_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a specific Site ACL." }, { "info": { "name": "Cloudflare List LANs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/lans", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ] }, "docs": "Lists LANs associated with an account and site." }, { "info": { "name": "Cloudflare Create a new LAN", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/lans", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address." }, { "info": { "name": "Cloudflare LAN Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/lans/:lan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "lan_identifier", "value": "", "type": "path" } ] }, "docs": "Get a specific LAN." }, { "info": { "name": "Cloudflare Update LAN", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/lans/:lan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "lan_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific LAN." }, { "info": { "name": "Cloudflare Delete LAN", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/lans/:lan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "lan_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a specific LAN." }, { "info": { "name": "Cloudflare List WANs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/wans", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ] }, "docs": "Lists WANs associated with an account and site." }, { "info": { "name": "Cloudflare Create a new WAN", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/wans", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "site_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new WAN." }, { "info": { "name": "Cloudflare WAN Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/wans/:wan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "wan_identifier", "value": "", "type": "path" } ] }, "docs": "Get a specific WAN." }, { "info": { "name": "Cloudflare Update WAN", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/wans/:wan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "wan_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific WAN." }, { "info": { "name": "Cloudflare Delete WAN", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/magic/sites/:site_identifier/wans/:wan_identifier", "params": [ { "name": "site_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" }, { "name": "wan_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a specific WAN." }, { "info": { "name": "Cloudflare List account configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists default sampling and router IPs for account." }, { "info": { "name": "Cloudflare Create account configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new network monitoring configuration." }, { "info": { "name": "Cloudflare Update an entire account configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing network monitoring configuration, requires the entire configuration to be updated at once." }, { "info": { "name": "Cloudflare Update account configuration fields", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update fields in an existing network monitoring configuration." }, { "info": { "name": "Cloudflare Delete account configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an existing network monitoring configuration." }, { "info": { "name": "Cloudflare List rules and account configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/config/full", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists default sampling, router IPs, and rules for account." }, { "info": { "name": "Cloudflare List rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists network monitoring rules for account." }, { "info": { "name": "Cloudflare Create rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create network monitoring rules for account. Currently only supports creating a single rule per API request." }, { "info": { "name": "Cloudflare Update rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update network monitoring rules for account." }, { "info": { "name": "Cloudflare Get rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "List a single network monitoring rule for account." }, { "info": { "name": "Cloudflare Update rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a network monitoring rule for account." }, { "info": { "name": "Cloudflare Delete rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a network monitoring rule for account." }, { "info": { "name": "Cloudflare Update advertisement for rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/mnm/rules/:rule_identifier/advertisement", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update advertisement for rule." }, { "info": { "name": "Cloudflare Request Trace", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/request-tracer/trace", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Request Trace" }, { "info": { "name": "Cloudflare Get a list item", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/rules/lists/:list_id/items/:item_id", "params": [ { "name": "item_id", "value": "", "type": "path" }, { "name": "list_id", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a list item in the list." }, { "info": { "name": "Cloudflare Get bulk operation status", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/rules/lists/bulk_operations/:operation_id", "params": [ { "name": "operation_id", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Gets the current status of an asynchronous operation on a list.\n\nThe `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error." }, { "info": { "name": "Cloudflare List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/subscriptions", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Lists all of an account's subscriptions." }, { "info": { "name": "Cloudflare Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/subscriptions", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an account subscription." }, { "info": { "name": "Cloudflare Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/subscriptions/:subscription_identifier", "params": [ { "name": "subscription_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an account subscription." }, { "info": { "name": "Cloudflare Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/subscriptions/:subscription_identifier", "params": [ { "name": "subscription_identifier", "value": "", "type": "path" }, { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an account's subscription." }, { "info": { "name": "Cloudflare List Vectorize Indexes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ] }, "docs": "Returns a list of Vectorize Indexes" }, { "info": { "name": "Cloudflare Create Vectorize Index", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes", "params": [ { "name": "account_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and returns a new Vectorize Index." }, { "info": { "name": "Cloudflare Get Vectorize Index", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ] }, "docs": "Returns the specified Vectorize Index." }, { "info": { "name": "Cloudflare Update Vectorize Index", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates and returns the specified Vectorize Index." }, { "info": { "name": "Cloudflare Delete Vectorize Index", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ] }, "docs": "Deletes the specified Vectorize Index." }, { "info": { "name": "Cloudflare Delete Vectors By Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name/delete-by-ids", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a set of vectors from an index by their vector identifiers." }, { "info": { "name": "Cloudflare Get Vectors By Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name/get-by-ids", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a set of vectors from an index by their vector identifiers." }, { "info": { "name": "Cloudflare Insert Vectors", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name/insert", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Inserts vectors into the specified index and returns the count of the vectors successfully inserted." }, { "info": { "name": "Cloudflare Query Vectors", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name/query", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Finds vectors closest to a given vector in an index." }, { "info": { "name": "Cloudflare Upsert Vectors", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:account_identifier/vectorize/indexes/:index_name/upsert", "params": [ { "name": "account_identifier", "value": "", "type": "path" }, { "name": "index_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted." }, { "info": { "name": "Cloudflare Search URL scans", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:accountId/urlscanner/scan", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "scanId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "next_cursor", "value": "", "type": "query" }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "url", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query" }, { "name": "path", "value": "", "type": "query" }, { "name": "ip", "value": "", "type": "query" }, { "name": "asn", "value": "", "type": "query" }, { "name": "page_url", "value": "", "type": "query" }, { "name": "page_hostname", "value": "", "type": "query" }, { "name": "page_path", "value": "", "type": "query" }, { "name": "page_asn", "value": "", "type": "query" }, { "name": "page_ip", "value": "", "type": "query" }, { "name": "account_scans", "value": "", "type": "query" }, { "name": "is_malicious", "value": "", "type": "query" } ] }, "docs": "Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path.
A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time." }, { "info": { "name": "Cloudflare Create URL Scan", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:accountId/urlscanner/scan", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Accounts are limited to 1 new scan every 10 seconds and 8000 per month. If you need more, please reach out." }, { "info": { "name": "Cloudflare Get URL scan", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:accountId/urlscanner/scan/:scanId", "params": [ { "name": "scanId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "Get URL scan by uuid" }, { "info": { "name": "Cloudflare Get URL scan's HAR", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:accountId/urlscanner/scan/:scanId/har", "params": [ { "name": "scanId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/." }, { "info": { "name": "Cloudflare Get screenshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:accountId/urlscanner/scan/:scanId/screenshot", "params": [ { "name": "scanId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" }, { "name": "resolution", "value": "", "type": "query" } ] }, "docs": "Get scan's screenshot by resolution (desktop/mobile/tablet)." }, { "info": { "name": "Cloudflare List Access applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all Access applications in an account." }, { "info": { "name": "Cloudflare Add an Access Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new application to Access." }, { "info": { "name": "Cloudflare Get an Access application", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches information about an Access application." }, { "info": { "name": "Cloudflare Update an Access application", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an Access application." }, { "info": { "name": "Cloudflare Delete an Access application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an application from Access." }, { "info": { "name": "Cloudflare Revoke application tokens", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:app_id/revoke_tokens", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Revokes all tokens issued for an application." }, { "info": { "name": "Cloudflare Test Access policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:app_id/user_policy_checks", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Tests if a specific user has permission to access an application." }, { "info": { "name": "Cloudflare Get a short-lived certificate CA", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a short-lived certificate CA and its public key." }, { "info": { "name": "Cloudflare Create a short-lived certificate CA", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Generates a new short-lived certificate CA and public key." }, { "info": { "name": "Cloudflare Delete a short-lived certificate CA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes a short-lived certificate CA." }, { "info": { "name": "Cloudflare List Access policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid/policies", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists Access policies configured for an application." }, { "info": { "name": "Cloudflare Create an Access policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid/policies", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Access policy for an application." }, { "info": { "name": "Cloudflare Get an Access policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single Access policy." }, { "info": { "name": "Cloudflare Update an Access policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a configured Access policy." }, { "info": { "name": "Cloudflare Delete an Access policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Delete an Access policy." }, { "info": { "name": "Cloudflare List short-lived certificate CAs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/apps/ca", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists short-lived certificate CAs and their public keys." }, { "info": { "name": "Cloudflare List Bookmark applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/bookmarks", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists Bookmark applications." }, { "info": { "name": "Cloudflare Get a Bookmark application", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/bookmarks/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single Bookmark application." }, { "info": { "name": "Cloudflare Create a Bookmark application", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/bookmarks/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Bookmark application." }, { "info": { "name": "Cloudflare Update a Bookmark application", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/bookmarks/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Bookmark application." }, { "info": { "name": "Cloudflare Delete a Bookmark application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/bookmarks/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Bookmark application." }, { "info": { "name": "Cloudflare List mTLS certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all mTLS root certificates." }, { "info": { "name": "Cloudflare Add an mTLS certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new mTLS root certificate to Access." }, { "info": { "name": "Cloudflare Get an mTLS certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single mTLS certificate." }, { "info": { "name": "Cloudflare Update an mTLS certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured mTLS certificate." }, { "info": { "name": "Cloudflare Delete an mTLS certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an mTLS certificate." }, { "info": { "name": "Cloudflare List all mTLS hostname settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates/settings", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "List all mTLS hostname settings for this account." }, { "info": { "name": "Cloudflare Update an mTLS certificate's hostname settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/certificates/settings", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an mTLS certificate's hostname settings." }, { "info": { "name": "Cloudflare List custom pages", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/custom_pages", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "List custom pages" }, { "info": { "name": "Cloudflare Create a custom page", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/custom_pages", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom page" }, { "info": { "name": "Cloudflare Get a custom page", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/custom_pages/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a custom page and also returns its HTML." }, { "info": { "name": "Cloudflare Update a custom page", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/custom_pages/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a custom page" }, { "info": { "name": "Cloudflare Delete a custom page", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/custom_pages/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Delete a custom page" }, { "info": { "name": "Cloudflare List Access groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/groups", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all Access groups." }, { "info": { "name": "Cloudflare Create an Access group", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/groups", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Access group." }, { "info": { "name": "Cloudflare Get an Access group", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single Access group." }, { "info": { "name": "Cloudflare Update an Access group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Access group." }, { "info": { "name": "Cloudflare Delete an Access group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an Access group." }, { "info": { "name": "Cloudflare List Access identity providers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/identity_providers", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all configured identity providers." }, { "info": { "name": "Cloudflare Add an Access identity provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/identity_providers", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new identity provider to Access." }, { "info": { "name": "Cloudflare Get an Access identity provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a configured identity provider." }, { "info": { "name": "Cloudflare Update an Access identity provider", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured identity provider." }, { "info": { "name": "Cloudflare Delete an Access identity provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an identity provider from Access." }, { "info": { "name": "Cloudflare Get the Access key configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/keys", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Gets the Access key rotation settings for an account." }, { "info": { "name": "Cloudflare Update the Access key configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/keys", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Access key rotation settings for an account." }, { "info": { "name": "Cloudflare Rotate Access keys", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/keys/rotate", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Perfoms a key rotation for an account." }, { "info": { "name": "Cloudflare Get Access authentication logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/logs/access_requests", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Gets a list of Access authentication audit logs for an account." }, { "info": { "name": "Cloudflare Get your Zero Trust organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Returns the configuration for your Zero Trust organization." }, { "info": { "name": "Cloudflare Create your Zero Trust organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up a Zero Trust organization for your account." }, { "info": { "name": "Cloudflare Update your Zero Trust organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for your Zero Trust organization." }, { "info": { "name": "Cloudflare Revoke all Access tokens for a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/organizations/revoke_user", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revokes a user's access across all applications." }, { "info": { "name": "Cloudflare Update a user seat", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/seats", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false." }, { "info": { "name": "Cloudflare List service tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all service tokens." }, { "info": { "name": "Cloudflare Create a service token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token." }, { "info": { "name": "Cloudflare Update a service token", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured service token." }, { "info": { "name": "Cloudflare Delete a service token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes a service token." }, { "info": { "name": "Cloudflare Refresh a service token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens/:uuid/refresh", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Refreshes the expiration of a service token." }, { "info": { "name": "Cloudflare Rotate a service token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/service_tokens/:uuid/rotate", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Generates a new Client Secret for a service token and revokes the old one." }, { "info": { "name": "Cloudflare List tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/tags", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "List tags" }, { "info": { "name": "Cloudflare Create a tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/tags", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a tag" }, { "info": { "name": "Cloudflare Get a tag", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/tags/:name", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get a tag" }, { "info": { "name": "Cloudflare Update a tag", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/tags/:name", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a tag" }, { "info": { "name": "Cloudflare Delete a tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/tags/:name", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete a tag" }, { "info": { "name": "Cloudflare Get users", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/users", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Gets a list of users for an account." }, { "info": { "name": "Cloudflare Get active sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/users/:id/active_sessions", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Get active sessions for a single user." }, { "info": { "name": "Cloudflare Get single active session", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/users/:id/active_sessions/:nonce", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "nonce", "value": "", "type": "path" } ] }, "docs": "Get an active session for a single user." }, { "info": { "name": "Cloudflare Get failed logins", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/users/:id/failed_logins", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Get all failed login attempts for a single user." }, { "info": { "name": "Cloudflare Get last seen identity", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts/:identifier/access/users/:id/last_seen_identity", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Get last seen identity for a single user." }, { "info": { "name": "Cloudflare List Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/accounts", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List all accounts you have ownership or verified access to." } ] } ], "bundled": true }