{ "opencollection": "1.0.0", "info": { "name": "Cloudflare / Accounts User API", "version": "4.0.0" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Cloudflare User Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user" }, "docs": "Cloudflare User Details" }, { "info": { "name": "Cloudflare Edit User", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/user", "body": { "type": "json", "data": "{}" } }, "docs": "Edit part of your user details." }, { "info": { "name": "Cloudflare Get user audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/audit_logs", "params": [ { "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 a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change." }, { "info": { "name": "Cloudflare Billing History Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/billing/history", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "occured_at", "value": "", "type": "query" }, { "name": "occurred_at", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "action", "value": "", "type": "query" } ] }, "docs": "Accesses your billing history object." }, { "info": { "name": "Cloudflare Billing Profile Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/billing/profile" }, "docs": "Accesses your billing profile object." }, { "info": { "name": "Cloudflare List IP Access rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules", "params": [ { "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 the user. 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/user/firewall/access_rules/rules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IP Access rule for all zones owned by the current user.\n\nNote: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints." }, { "info": { "name": "Cloudflare Update an IP Access rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes." }, { "info": { "name": "Cloudflare Delete an IP Access rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an IP Access rule at the user level.\n\nNote: Deleting a user-level rule will affect all zones owned by the user." }, { "info": { "name": "Cloudflare List Invitations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/invites" }, "docs": "Lists all invitations associated with my user." }, { "info": { "name": "Cloudflare Invitation Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/invites/:invite_id", "params": [ { "name": "invite_id", "value": "", "type": "path" } ] }, "docs": "Gets the details of an invitation." }, { "info": { "name": "Cloudflare Respond to Invitation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/user/invites/:invite_id", "params": [ { "name": "invite_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Responds to an invitation." }, { "info": { "name": "Cloudflare List Monitors", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/load_balancers/monitors" }, "docs": "List configured monitors for a user." }, { "info": { "name": "Cloudflare Create Monitor", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/user/load_balancers/monitors", "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/user/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_id", "value": "", "type": "path" } ] }, "docs": "List a single configured monitor for a user." }, { "info": { "name": "Cloudflare Update Monitor", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_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/user/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_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/user/load_balancers/monitors/:monitor_id", "params": [ { "name": "monitor_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/user/load_balancers/monitors/:monitor_id/preview", "params": [ { "name": "monitor_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/user/load_balancers/monitors/:monitor_id/references", "params": [ { "name": "monitor_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/user/load_balancers/pools", "params": [ { "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/user/load_balancers/pools", "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/user/load_balancers/pools", "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/user/load_balancers/pools/:pool_id", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id/health", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id/preview", "params": [ { "name": "pool_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/user/load_balancers/pools/:pool_id/references", "params": [ { "name": "pool_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/user/load_balancers/preview/:preview_id", "params": [ { "name": "preview_id", "value": "", "type": "path" } ] }, "docs": "Get the result of a previous preview operation using the provided preview_id." }, { "info": { "name": "Cloudflare List Healthcheck Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/load_balancing_analytics/events", "params": [ { "name": "until", "value": "", "type": "query" }, { "name": "pool_name", "value": "", "type": "query" }, { "name": "origin_healthy", "value": "", "type": "query" }, { "name": "pool_id", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "origin_name", "value": "", "type": "query" }, { "name": "pool_healthy", "value": "", "type": "query" } ] }, "docs": "List origin health changes." }, { "info": { "name": "Cloudflare List Organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/organizations", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "Lists organizations the user is associated with." }, { "info": { "name": "Cloudflare Organization Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/organizations/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path" } ] }, "docs": "Gets a specific organization the user is associated with." }, { "info": { "name": "Cloudflare Leave Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/user/organizations/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes association to an organization." }, { "info": { "name": "Cloudflare Get User Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/subscriptions" }, "docs": "Lists all of a user's subscriptions." }, { "info": { "name": "Cloudflare Update User Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/user/subscriptions/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user's subscriptions." }, { "info": { "name": "Cloudflare Delete User Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/user/subscriptions/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a user's subscription." }, { "info": { "name": "Cloudflare List Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/tokens", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List all access tokens you created." }, { "info": { "name": "Cloudflare Create Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/user/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new access token." }, { "info": { "name": "Cloudflare Token Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Get information about a specific token." }, { "info": { "name": "Cloudflare Update Token", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/user/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing token." }, { "info": { "name": "Cloudflare Delete Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/user/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Destroy a token." }, { "info": { "name": "Cloudflare Roll Token", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/user/tokens/:token_id/value", "params": [ { "name": "token_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Roll the token secret." }, { "info": { "name": "Cloudflare List Permission Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/tokens/permission_groups" }, "docs": "Find all available permission groups." }, { "info": { "name": "Cloudflare Verify Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/user/tokens/verify" }, "docs": "Test whether a token works." } ] } ], "bundled": true }