Where to place the rule among your rules in the ruleset, given as exactly one of before or after (the ID of another rule in the ruleset) or index (1 is first). Rules are evaluated in order. Without a position, a new rule is added last and an existing rule keeps its place.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Laravel Cloud","colors":{"primary":"#0057FF","light":"#71A8FF","dark":"#0057FF"},"logo":{"light":"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-light.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=f508d8e9c4e3c842e83d055cc376daa1","dark":"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-dark.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=fcfe00a4914f5e3ad791b606c3e75795","href":"https://cloud.laravel.com/"},"favicon":"https://mintcdn.com/cloud/83RcCEaWR6PzmMFO/favicons/favicon-dark.png?fit=max\u0026auto=format\u0026n=83RcCEaWR6PzmMFO\u0026q=85\u0026s=edd5608e08efe6ae6a4ca1b44232d2af","navbar":{"links":[],"primary":{"type":"button","label":"Get Started","href":"https://cloud.laravel.com"}},"footer":{"socials":{"x":"https://x.com/laravel","github":"https://github.com/laravel","youtube":"https://www.youtube.com/laravelphp"}},"seo":{"metatags":{"robots":"noindex"}},"integrations":{"fathom":{"siteId":"KZRWMQWT"}},"banner":{"content":"Deploy Next and Nuxt frontends alongside your Laravel apps, all from one unified platform. \u003ca href='https://laravel.com/blog/deploy-nextjs-and-nuxt-apps-on-laravel-cloud'>Learn more →\u003c/a>","dismissible":true},"contextual":{"options":["copy","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloud","hasAudioNarration":false,"actualSubdomain":"cloud","customDomains":["cloud.laravel.com"],"gitSource":{"type":"github","owner":"laravel","repo":"cloud-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afeca9d22766113704cef3d","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API","count":148},{"language":"default","tag":"Endpoints","count":144},{"language":"default","tag":"Documentation","count":69},{"language":"default","tag":"Knowledge Base","count":21},{"language":"default","tag":"Environments","count":18},{"language":"default","tag":"Basics","count":17},{"language":"default","tag":"Instances","count":14},{"language":"default","tag":"Monitoring","count":11},{"language":"default","tag":"Private Cloud","count":10},{"language":"default","tag":"Metrics","count":9}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":false,"deflection":{"enabled":false,"showHelpButton":false}},"basePath":"/cloud/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"/* latin-ext */\n@font-face {\n font-family: 'Instrument Sans';\n font-style: normal;\n font-weight: 400 500;\n font-stretch: 100%;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/instrumentsans/v4/pxiTypc9vsFDm051Uf6KVwgkfoSxQ0GsQv8ToedPibnr0She1YmV.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Instrument Sans';\n font-style: normal;\n font-weight: 400 500;\n font-stretch: 100%;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/instrumentsans/v4/pxiTypc9vsFDm051Uf6KVwgkfoSxQ0GsQv8ToedPibnr0SZe1Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nbody{font-family:\"Instrument Sans\";font-weight:400}h1,h2,h3,h4{font-family:\"Instrument Sans\"!important;font-weight:500!important;letter-spacing:-0.025em!important}code,pre{font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace}b,strong,.font-semibold{font-weight:500!important}.prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)){font-weight:500!important;color:rgb(var(--primary))!important}.dark .prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)){color:rgb(var(--primary-light))!important}.table-auto{table-layout:auto}table.table-fixed{table-layout:fixed!important}table{table-layout:auto!important;display:table}th{text-align:left}td>p.icon{margin:0}.short{p {\n margin-top: 0;\n margin-bottom: 0;\n }}.pr-16{padding-right:4em}.max-w-none{max-width:none!important}.align-top{vertical-align:top}.italic{font-style:italic}.pr-20{padding-right:5rem}.max-h-50vh{max-height:50vh}.select-arrow{background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e\");background-size:1.5em 1.5em;background-position:right 0.5rem center;background-repeat:no-repeat}#banner a{color:rgb(var(--white))!important;white-space:nowrap}#banner>div>p{white-space:normal;padding-top:0.125rem;padding-bottom:0.125rem;overflow:hidden;display:-webkit-box;-webkit-box-orient:vertical;line-clamp:3;-webkit-line-clamp:3}#banner:has(>button){padding-right:2.5rem}@media screen and (min-width: 768px){#banner{height:auto}#banner:has(>button){padding-left:2.5rem}}#topbar-cta-button a>span:first-child{background-color:rgb(22 25 30)}.dark #topbar-cta-button a>span:first-child{background-color:rgb(255 255 255)}.dark #topbar-cta-button a,.dark #topbar-cta-button a *{color:rgb(22 25 30)!important}.callout [data-component-part=\"callout-icon\"]:empty{display:none}"}]}
{"page":{"pagePath":"api/edge-networks/create-a-rule","slug":"/api/edge-networks/create-a-rule","pageMetadata":{"title":"Create a rule","description":"Add a rule to a ruleset. The rule is added last unless a `position` is given.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/create-a-rule","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Add a rule to a ruleset. The rule is added last unless a \", _jsx(_components.code, {\n children: \"position\"\n }), \" is given.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Callout}=_components;if(!Callout)_missingMdxReference(`Callout`,true);return _jsx(Callout,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required permission:`}),` `,_jsx(_components.code,{children:`network_rule.create`})]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a rule","description":"Add a rule to a ruleset. The rule is added last unless a `position` is given.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/create-a-rule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/cloud/docs/_mintlify/custom/cloud/412bdbfbeb58e5da/gtag.js","/cloud/docs/_mintlify/custom/cloud/1a6e9e638535d772/plain.js","/cloud/docs/_mintlify/custom/cloud/f2ef70ddf7841ac3/rudderstack.js","/cloud/docs/_mintlify/custom/cloud/d55d837bfb92372f/scripts/fetch-ips.js"],"openApiReferenceData":{"operation":{"operationId":"public.edge-networks.rulesets.rules.store","description":"Add a rule to a ruleset. The rule is added last unless a `position` is given.","summary":"Create a rule","tags":["Edge Networks"],"parameters":["ea8aee93-1ec5-4140-9e3c-d42f320a6f2d","802f0082-ffe0-4c18-bbb4-73c61d3631fc"],"requestBody":"60b34b61-7fd9-465c-9f63-a3877d8ebc00","responses":{"201":"5af8023d-a1c7-44ed-a46f-22f88a05de8b","403":"747f889e-e0d1-4c9f-8da3-bb0db8d56cce","404":"d6dbe952-004b-4847-9d8d-7bb7ef8416f2","409":"deccceef-b9bf-4601-835a-9e2c1829e49d","422":"81ec5574-1b31-4756-aa46-71df40959069"},"x-mint":{"content":"\u003cCallout>\n**Required permission:** `network_rule.create`\n\u003c/Callout>"},"method":"post","type":"path","servers":["ab272a5d-11d2-46d9-8dc6-6bc8e813c6f1"],"security":["687d8bfb-68b4-409d-8c69-eabb0584a8b9"],"path":"/edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","baseUrlOptions":["https://cloud.laravel.com/api"],"title":"Create a rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ea8aee93-1ec5-4140-9e3c-d42f320a6f2d":{"name":"edgeNetwork","in":"path","required":true,"description":"The edge network identifier","schema":{"type":"string","isRequired":true,"description":"The edge network identifier","uniqueKey":"","typeLabel":"string"}},"802f0082-ffe0-4c18-bbb4-73c61d3631fc":{"name":"ruleset","in":"path","required":true,"description":"The ruleset, one per type on each dedicated edge network.","schema":{"type":"string","description":"The ruleset, one per type on each dedicated edge network.\nThe ruleset.\n\n- `rate-limit`: Rules that limit how many matching requests each visitor can make.\n- `cache`: Rules that control how matching responses are cached at the edge and in browsers.\n- `firewall`: Custom WAF rules that block, challenge, log or skip matching requests.","enum":["rate-limit","cache","firewall"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A name for the rule, unique within the ruleset.","examples":["Block admin outside the office"],"maxLength":100,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"settings":{"oneOf":[{"type":"object","title":"Rate limit","description":"The rule's action and conditions. Get the ruleset to list the accepted actions and the fields, operators and values each condition can use.","required":["requests_per_period","period","throttles","action","criteria_groups"],"example":{"requests_per_period":10,"period":60,"action":"managed_challenge","throttles":false,"action_duration":600,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/login"},{"criteria":"value","field":"request_method","operator":"equals","value":"POST"}]}]},"properties":{"requests_per_period":{"type":"integer","description":"How many matching requests can be made in each `period`. Requests are counted per `counting_key` value and per Cloudflare data center.","minimum":1,"isRequired":true,"uniqueKey":"settings.oneOf.0.requests_per_period","typeLabel":"integer"},"period":{"type":"integer","description":"The window, in seconds, in which requests are counted.\n\n- `10`: 10 seconds\n- `15`: 15 seconds\n- `20`: 20 seconds\n- `30`: 30 seconds\n- `40`: 40 seconds\n- `45`: 45 seconds\n- `60`: 1 minute\n- `90`: 90 seconds\n- `120`: 2 minutes\n- `180`: 3 minutes\n- `300`: 5 minutes\n- `480`: 8 minutes\n- `600`: 10 minutes\n- `900`: 15 minutes\n- `1200`: 20 minutes\n- `1800`: 30 minutes\n- `2400`: 40 minutes\n- `3600`: 1 hour","enum":[10,15,20,30,40,45,60,90,120,180,300,480,600,900,1200,1800,2400,3600],"isRequired":true,"uniqueKey":"settings.oneOf.0.period","typeLabel":"enum\u003cinteger>"},"action":{"type":"string","description":"What to do once a visitor exceeds the limit.\n\n- `block`: Block\n- `managed_challenge`: Managed challenge\n- `js_challenge`: JS challenge","enum":["block","managed_challenge","js_challenge"],"isRequired":true,"uniqueKey":"settings.oneOf.0.action","typeLabel":"enum\u003cstring>"},"throttles":{"type":"boolean","description":"When true, the action only applies to requests above the limit. When false, it applies to every matching request from the visitor for `action_duration`.","isRequired":true,"uniqueKey":"settings.oneOf.0.throttles","typeLabel":"boolean"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `as_num` | AS num | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `authentication_detected` | Authentication | `none` |\n| `body` | Body | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `body_size` | Body size | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `bot_detection_ids` | Bot detection IDs | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `bot_score` | Bot score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `client_certificate_verified` | Client certificate | `none` |\n| `continent` | Continent | `equals`, `not_equals`, `in`, `not_in` |\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `country` | Country | `equals`, `not_equals`, `in`, `not_in` |\n| `environment` | Cloud environment | `equals`, `not_equals`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `http_version` | HTTP version | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ip_source_address` | IP source address | `equals`, `not_equals`, `in`, `not_in` |\n| `ja4_fingerprint` | JA4 fingerprint | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `json_string` | JSON string | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `known_bots` | Bots | `none` |\n| `mime_type` | MIME type | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `password_leaked` | Password leak | `none` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `request_method` | Request method | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `serves_static_resource` | Static resource | `none` |\n| `similar_password_leaked` | Similar password leak | `none` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `username_and_password_leaked` | Username and password leak | `none` |\n| `username_leaked` | Username | `none` |\n| `verified_bot` | Bot verification | `none` |\n| `verified_bot_category` | Verified bot category | `in`, `not_in`, `equals`, `not_equals` |\n| `waf_attack_score` | WAF attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_rce_attack_score` | WAF RCE attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_sqli_attack_score` | WAF SQLi attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_xss_attack_score` | WAF XSS attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["as_num","authentication_detected","body","body_size","bot_detection_ids","bot_score","client_certificate_verified","continent","cookie","cookie_value","country","environment","header","hostname","http_version","ip_source_address","ja4_fingerprint","json_string","known_bots","mime_type","password_leaked","referer","request_method","serves_static_resource","similar_password_leaked","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","username_and_password_leaked","username_leaked","verified_bot","verified_bot_category","waf_attack_score","waf_rce_attack_score","waf_sqli_attack_score","waf_xss_attack_score","x_forwarded_for"],"isRequired":true,"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `equals`: equals\n- `not_equals`: not equals\n- `greater_than`: greater than\n- `less_than`: less than\n- `greater_than_or_equal`: greater than or equal\n- `less_than_or_equal`: less than or equal\n- `in`: in\n- `not_in`: not in\n- `none`: none\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `exists`: exists\n- `not_exists`: not exists","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal","in","not_in","none","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","wildcard","strict_wildcard","exists","not_exists"],"isRequired":true,"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"settings.oneOf.0.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.0.criteria_groups","typeLabel":"object[]"},"action_duration":{"type":"integer","description":"How long, in seconds, the action applies once a visitor exceeds the limit. Required when `throttles` is false, and must be at least `period`.\n\n- `10`: 10 seconds\n- `15`: 15 seconds\n- `20`: 20 seconds\n- `30`: 30 seconds\n- `40`: 40 seconds\n- `45`: 45 seconds\n- `60`: 1 minute\n- `90`: 90 seconds\n- `120`: 2 minutes\n- `180`: 3 minutes\n- `300`: 5 minutes\n- `480`: 8 minutes\n- `600`: 10 minutes\n- `900`: 15 minutes\n- `1200`: 20 minutes\n- `1800`: 30 minutes\n- `2400`: 40 minutes\n- `3600`: 1 hour\n- `86400`: 1 day","enum":[10,15,20,30,40,45,60,90,120,180,300,480,600,900,1200,1800,2400,3600,86400],"uniqueKey":"settings.oneOf.0.action_duration","typeLabel":"enum\u003cinteger>"},"counting_key":{"type":"string","description":"What requests are grouped by when counting them against the limit.\n\n- `visitor`: Each visitor gets their own limit.\n- `asn`: Every address in the same network shares one limit.\n- `user_agent`: Every request with the same user agent shares one limit.\n- `header`: Every request with the same header value shares one limit.","enum":["visitor","asn","user_agent","header"],"default":"visitor","uniqueKey":"settings.oneOf.0.counting_key","typeLabel":"enum\u003cstring>"},"counting_header":{"oneOf":[{"type":"string","description":"The lowercase name of the header whose value requests are grouped by. Required when `counting_key` is `header`. Requests without the header share one count.","maxLength":100,"uniqueKey":"settings.oneOf.0.counting_header.oneOf.0","typeLabel":"string"},{"type":"null","description":"The lowercase name of the header whose value requests are grouped by. Required when `counting_key` is `header`. Requests without the header share one count.","maxLength":100,"uniqueKey":"settings.oneOf.0.counting_header.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.oneOf.0.counting_header","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"settings.oneOf.0","typeLabel":"Rate limit · object"},{"type":"object","title":"Cache","description":"The rule's action and conditions. Get the ruleset to list the accepted actions and the fields, operators and values each condition can use.","required":["cache","edge_ttl_mode","browser_ttl_mode","respect_strong_etags","serve_stale","origin_error_page_passthru","action","criteria_groups"],"example":{"action":"set_cache_settings","cache":true,"edge_ttl_mode":"override_origin","edge_ttl":3600,"browser_ttl_mode":"respect_origin","respect_strong_etags":false,"serve_stale":true,"origin_error_page_passthru":false,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/pricing"}]}]},"properties":{"action":{"type":"string","description":"Cache rules always set cache settings.\n\n- `set_cache_settings`: Set cache settings","enum":["set_cache_settings"],"isRequired":true,"uniqueKey":"settings.oneOf.1.action","typeLabel":"enum\u003cstring>"},"cache":{"type":"boolean","description":"Whether matching responses are eligible for caching. False bypasses the cache.","isRequired":true,"uniqueKey":"settings.oneOf.1.cache","typeLabel":"boolean"},"edge_ttl_mode":{"type":"string","description":"How long responses stay cached at the edge.\n\n- `respect_origin`: Use cache-control header or respect origin TTL\n- `bypass_by_default`: Use cache-control header or bypass\n- `override_origin`: Ignore cache-control header and use custom TTL","enum":["respect_origin","bypass_by_default","override_origin"],"isRequired":true,"uniqueKey":"settings.oneOf.1.edge_ttl_mode","typeLabel":"enum\u003cstring>"},"browser_ttl_mode":{"type":"string","description":"How long browsers cache responses.\n\n- `respect_origin`: Respect origin TTL\n- `bypass`: Bypass cache\n- `override_origin`: Override origin and use custom TTL","enum":["respect_origin","bypass","override_origin"],"isRequired":true,"uniqueKey":"settings.oneOf.1.browser_ttl_mode","typeLabel":"enum\u003cstring>"},"respect_strong_etags":{"type":"boolean","description":"Keep strong ETags from the origin instead of converting them to weak ones.","isRequired":true,"uniqueKey":"settings.oneOf.1.respect_strong_etags","typeLabel":"boolean"},"serve_stale":{"type":"boolean","description":"Serve stale content while a cached response is being revalidated.","isRequired":true,"uniqueKey":"settings.oneOf.1.serve_stale","typeLabel":"boolean"},"origin_error_page_passthru":{"type":"boolean","description":"Pass 5xx error pages from the origin through instead of serving the edge error page.","isRequired":true,"uniqueKey":"settings.oneOf.1.origin_error_page_passthru","typeLabel":"boolean"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `file_extension` | File extension | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["cookie","cookie_value","file_extension","header","hostname","referer","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","x_forwarded_for"],"isRequired":true,"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `equals`: equals\n- `not_equals`: not equals\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `exists`: exists\n- `not_exists`: not exists\n- `in`: in\n- `not_in`: not in\n- `none`: none","enum":["wildcard","strict_wildcard","equals","not_equals","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","exists","not_exists","in","not_in","none"],"isRequired":true,"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"settings.oneOf.1.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.1.criteria_groups","typeLabel":"object[]"},"edge_ttl":{"oneOf":[{"type":"integer","description":"Seconds to cache responses at the edge. Required when `edge_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"settings.oneOf.1.edge_ttl.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to cache responses at the edge. Required when `edge_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"settings.oneOf.1.edge_ttl.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.oneOf.1.edge_ttl","typeLabel":"integer | null"},"browser_ttl":{"oneOf":[{"type":"integer","description":"Seconds browsers cache responses. Required when `browser_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"settings.oneOf.1.browser_ttl.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds browsers cache responses. Required when `browser_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"settings.oneOf.1.browser_ttl.oneOf.1","typeLabel":"null"}],"uniqueKey":"settings.oneOf.1.browser_ttl","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"settings.oneOf.1","typeLabel":"Cache · object"},{"type":"object","title":"Firewall","description":"The rule's action and conditions. Get the ruleset to list the accepted actions and the fields, operators and values each condition can use.","required":["action","criteria_groups"],"example":{"action":"block","criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/wp-login.php"}]},{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/xmlrpc.php"}]}]},"properties":{"action":{"type":"string","description":"What to do with matching requests.\n\n- `block`: Block\n- `managed_challenge`: Managed challenge\n- `challenge`: Challenge\n- `js_challenge`: JS challenge\n- `log`: Log\n- `skip`: Skip","enum":["block","managed_challenge","challenge","js_challenge","log","skip"],"isRequired":true,"uniqueKey":"settings.oneOf.2.action","typeLabel":"enum\u003cstring>"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `as_num` | AS num | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `authentication_detected` | Authentication | `none` |\n| `body` | Body | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `body_size` | Body size | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `bot_detection_ids` | Bot detection IDs | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `bot_score` | Bot score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `client_certificate_verified` | Client certificate | `none` |\n| `continent` | Continent | `equals`, `not_equals`, `in`, `not_in` |\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `country` | Country | `equals`, `not_equals`, `in`, `not_in` |\n| `environment` | Cloud environment | `equals`, `not_equals`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `http_version` | HTTP version | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ip_source_address` | IP source address | `equals`, `not_equals`, `in`, `not_in` |\n| `ja4_fingerprint` | JA4 fingerprint | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `json_string` | JSON string | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `known_bots` | Bots | `none` |\n| `mime_type` | MIME type | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `password_leaked` | Password leak | `none` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `request_method` | Request method | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `serves_static_resource` | Static resource | `none` |\n| `similar_password_leaked` | Similar password leak | `none` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `username_and_password_leaked` | Username and password leak | `none` |\n| `username_leaked` | Username | `none` |\n| `verified_bot` | Bot verification | `none` |\n| `verified_bot_category` | Verified bot category | `in`, `not_in`, `equals`, `not_equals` |\n| `waf_attack_score` | WAF attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_rce_attack_score` | WAF RCE attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_sqli_attack_score` | WAF SQLi attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_xss_attack_score` | WAF XSS attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["as_num","authentication_detected","body","body_size","bot_detection_ids","bot_score","client_certificate_verified","continent","cookie","cookie_value","country","environment","header","hostname","http_version","ip_source_address","ja4_fingerprint","json_string","known_bots","mime_type","password_leaked","referer","request_method","serves_static_resource","similar_password_leaked","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","username_and_password_leaked","username_leaked","verified_bot","verified_bot_category","waf_attack_score","waf_rce_attack_score","waf_sqli_attack_score","waf_xss_attack_score","x_forwarded_for"],"isRequired":true,"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `equals`: equals\n- `not_equals`: not equals\n- `greater_than`: greater than\n- `less_than`: less than\n- `greater_than_or_equal`: greater than or equal\n- `less_than_or_equal`: less than or equal\n- `in`: in\n- `not_in`: not in\n- `none`: none\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `exists`: exists\n- `not_exists`: not exists","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal","in","not_in","none","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","wildcard","strict_wildcard","exists","not_exists"],"isRequired":true,"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"settings.oneOf.2.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"settings.oneOf.2.criteria_groups","typeLabel":"object[]"},"skip_parameters":{"type":"object","description":"What a `skip` rule skips. Required when `action` is `skip`.","properties":{"skip_current_ruleset":{"type":"boolean","description":"Skip the remaining rules in this ruleset.","uniqueKey":"settings.oneOf.2.skip_parameters.skip_current_ruleset","typeLabel":"boolean"},"phases":{"type":"array","items":{"type":"string","description":"Rules to skip.\n\n- `http_ratelimit`: All rate limiting rules\n- `http_request_firewall_managed`: All managed rules\n- `http_request_sbfm`: All Super Bot Fight Mode rules","enum":["http_ratelimit","http_request_firewall_managed","http_request_sbfm"],"uniqueKey":"settings.oneOf.2.skip_parameters.phases.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"settings.oneOf.2.skip_parameters.phases","typeLabel":"enum\u003cstring>[]"},"products":{"type":"array","items":{"type":"string","description":"Security features to skip.\n\n- `zoneLockdown`: Zone Lockdown\n- `uaBlock`: User Agent Blocking\n- `bic`: Browser Integrity Check\n- `hot`: Hotlink Protection\n- `securityLevel`: Security Level\n- `rateLimit`: Rate limiting rules (previous version)\n- `waf`: Managed rules (previous version)","enum":["zoneLockdown","uaBlock","bic","hot","securityLevel","rateLimit","waf"],"uniqueKey":"settings.oneOf.2.skip_parameters.products.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"settings.oneOf.2.skip_parameters.products","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"settings.oneOf.2.skip_parameters","typeLabel":"object"},"block_parameters":{"type":"object","description":"The response sent to blocked requests. Only used when `action` is `block`. Without it, the default block page is sent.","properties":{"response_type":{"type":"string","description":"The response to send.\n\n- `default`: Default block page\n- `html`: Custom HTML\n- `text`: Custom text\n- `json`: Custom JSON\n- `xml`: Custom XML","enum":["default","html","text","json","xml"],"default":"default","uniqueKey":"settings.oneOf.2.block_parameters.response_type","typeLabel":"enum\u003cstring>"},"status_code":{"type":"integer","description":"The status code of a custom response.","default":403,"minimum":400,"maximum":499,"uniqueKey":"settings.oneOf.2.block_parameters.status_code","typeLabel":"integer"},"content":{"type":"string","description":"The body of a custom response. Required when `response_type` is not `default`.","maxLength":10240,"uniqueKey":"settings.oneOf.2.block_parameters.content","typeLabel":"string"}},"uniqueKey":"settings.oneOf.2.block_parameters","typeLabel":"object"}},"isRequired":true,"uniqueKey":"settings.oneOf.2","typeLabel":"Firewall · object"}],"isRequired":true,"uniqueKey":"settings","typeLabel":"Rate limit · object | Cache · object | Firewall · object"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"position":{"type":"object","description":"Where to place the rule among your rules in the ruleset, given as exactly one of `before` or `after` (the ID of another rule in the ruleset) or `index` (1 is first). Rules are evaluated in order. Without a position, a new rule is added last and an existing rule keeps its place.","examples":[{"before":"nru-9f3c1a2b-0c4d-4e5f-8a6b-7c8d9e0f1a2b"}],"properties":{"before":{"type":"string","uniqueKey":"position.before","typeLabel":"string"},"after":{"type":"string","uniqueKey":"position.after","typeLabel":"string"},"index":{"type":"integer","minimum":1,"uniqueKey":"position.index","typeLabel":"integer"}},"uniqueKey":"position","typeLabel":"object"}},"required":["name","settings"],"title":"StoreEdgeNetworkRuleRequest","uniqueKey":"","typeLabel":"StoreEdgeNetworkRuleRequest · object"},"examples":{"Example":{"title":"Example","value":{"name":"Block admin outside the office","settings":{"requests_per_period":10,"period":60,"action":"managed_challenge","throttles":false,"action_duration":600,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/login"},{"criteria":"value","field":"request_method","operator":"equals","value":"POST"}]}]},"description":"\u003cstring>","position":{"before":"nru-9f3c1a2b-0c4d-4e5f-8a6b-7c8d9e0f1a2b"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5af8023d-a1c7-44ed-a46f-22f88a05de8b":{"description":"`EdgeNetworkRuleResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"type":{"type":"string","enum":["edge_network_rules"],"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"type":{"type":"string","description":"The type of the ruleset the rule belongs to.","enum":["firewall","rate_limit","cache"],"isRequired":true,"uniqueKey":"data.attributes.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.attributes.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.description","typeLabel":"string | null"},"is_active":{"type":"boolean","description":"Whether the rule applies. An inactive rule keeps its position but matches no requests.","isRequired":true,"uniqueKey":"data.attributes.is_active","typeLabel":"boolean"},"settings":{"oneOf":[{"type":"object","title":"Rate limit","description":"The rule's action and conditions. The keys depend on the ruleset type and match the `settings` accepted when creating or updating a rule.","required":["requests_per_period","period","throttles","action","criteria_groups"],"example":{"requests_per_period":10,"period":60,"action":"managed_challenge","throttles":false,"action_duration":600,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/login"},{"criteria":"value","field":"request_method","operator":"equals","value":"POST"}]}]},"properties":{"requests_per_period":{"type":"integer","description":"How many matching requests can be made in each `period`. Requests are counted per `counting_key` value and per Cloudflare data center.","minimum":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.requests_per_period","typeLabel":"integer"},"period":{"type":"integer","description":"The window, in seconds, in which requests are counted.\n\n- `10`: 10 seconds\n- `15`: 15 seconds\n- `20`: 20 seconds\n- `30`: 30 seconds\n- `40`: 40 seconds\n- `45`: 45 seconds\n- `60`: 1 minute\n- `90`: 90 seconds\n- `120`: 2 minutes\n- `180`: 3 minutes\n- `300`: 5 minutes\n- `480`: 8 minutes\n- `600`: 10 minutes\n- `900`: 15 minutes\n- `1200`: 20 minutes\n- `1800`: 30 minutes\n- `2400`: 40 minutes\n- `3600`: 1 hour","enum":[10,15,20,30,40,45,60,90,120,180,300,480,600,900,1200,1800,2400,3600],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.period","typeLabel":"enum\u003cinteger>"},"action":{"type":"string","description":"What to do once a visitor exceeds the limit.\n\n- `block`: Block\n- `managed_challenge`: Managed challenge\n- `js_challenge`: JS challenge","enum":["block","managed_challenge","js_challenge"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.action","typeLabel":"enum\u003cstring>"},"throttles":{"type":"boolean","description":"When true, the action only applies to requests above the limit. When false, it applies to every matching request from the visitor for `action_duration`.","isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.throttles","typeLabel":"boolean"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `as_num` | AS num | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `authentication_detected` | Authentication | `none` |\n| `body` | Body | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `body_size` | Body size | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `bot_detection_ids` | Bot detection IDs | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `bot_score` | Bot score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `client_certificate_verified` | Client certificate | `none` |\n| `continent` | Continent | `equals`, `not_equals`, `in`, `not_in` |\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `country` | Country | `equals`, `not_equals`, `in`, `not_in` |\n| `environment` | Cloud environment | `equals`, `not_equals`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `http_version` | HTTP version | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ip_source_address` | IP source address | `equals`, `not_equals`, `in`, `not_in` |\n| `ja4_fingerprint` | JA4 fingerprint | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `json_string` | JSON string | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `known_bots` | Bots | `none` |\n| `mime_type` | MIME type | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `password_leaked` | Password leak | `none` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `request_method` | Request method | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `serves_static_resource` | Static resource | `none` |\n| `similar_password_leaked` | Similar password leak | `none` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `username_and_password_leaked` | Username and password leak | `none` |\n| `username_leaked` | Username | `none` |\n| `verified_bot` | Bot verification | `none` |\n| `verified_bot_category` | Verified bot category | `in`, `not_in`, `equals`, `not_equals` |\n| `waf_attack_score` | WAF attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_rce_attack_score` | WAF RCE attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_sqli_attack_score` | WAF SQLi attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_xss_attack_score` | WAF XSS attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["as_num","authentication_detected","body","body_size","bot_detection_ids","bot_score","client_certificate_verified","continent","cookie","cookie_value","country","environment","header","hostname","http_version","ip_source_address","ja4_fingerprint","json_string","known_bots","mime_type","password_leaked","referer","request_method","serves_static_resource","similar_password_leaked","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","username_and_password_leaked","username_leaked","verified_bot","verified_bot_category","waf_attack_score","waf_rce_attack_score","waf_sqli_attack_score","waf_xss_attack_score","x_forwarded_for"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `equals`: equals\n- `not_equals`: not equals\n- `greater_than`: greater than\n- `less_than`: less than\n- `greater_than_or_equal`: greater than or equal\n- `less_than_or_equal`: less than or equal\n- `in`: in\n- `not_in`: not in\n- `none`: none\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `exists`: exists\n- `not_exists`: not exists","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal","in","not_in","none","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","wildcard","strict_wildcard","exists","not_exists"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0.criteria_groups","typeLabel":"object[]"},"action_duration":{"type":"integer","description":"How long, in seconds, the action applies once a visitor exceeds the limit. Required when `throttles` is false, and must be at least `period`.\n\n- `10`: 10 seconds\n- `15`: 15 seconds\n- `20`: 20 seconds\n- `30`: 30 seconds\n- `40`: 40 seconds\n- `45`: 45 seconds\n- `60`: 1 minute\n- `90`: 90 seconds\n- `120`: 2 minutes\n- `180`: 3 minutes\n- `300`: 5 minutes\n- `480`: 8 minutes\n- `600`: 10 minutes\n- `900`: 15 minutes\n- `1200`: 20 minutes\n- `1800`: 30 minutes\n- `2400`: 40 minutes\n- `3600`: 1 hour\n- `86400`: 1 day","enum":[10,15,20,30,40,45,60,90,120,180,300,480,600,900,1200,1800,2400,3600,86400],"uniqueKey":"data.attributes.settings.oneOf.0.action_duration","typeLabel":"enum\u003cinteger>"},"counting_key":{"type":"string","description":"What requests are grouped by when counting them against the limit.\n\n- `visitor`: Each visitor gets their own limit.\n- `asn`: Every address in the same network shares one limit.\n- `user_agent`: Every request with the same user agent shares one limit.\n- `header`: Every request with the same header value shares one limit.","enum":["visitor","asn","user_agent","header"],"default":"visitor","uniqueKey":"data.attributes.settings.oneOf.0.counting_key","typeLabel":"enum\u003cstring>"},"counting_header":{"oneOf":[{"type":"string","description":"The lowercase name of the header whose value requests are grouped by. Required when `counting_key` is `header`. Requests without the header share one count.","maxLength":100,"uniqueKey":"data.attributes.settings.oneOf.0.counting_header.oneOf.0","typeLabel":"string"},{"type":"null","description":"The lowercase name of the header whose value requests are grouped by. Required when `counting_key` is `header`. Requests without the header share one count.","maxLength":100,"uniqueKey":"data.attributes.settings.oneOf.0.counting_header.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.settings.oneOf.0.counting_header","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.0","typeLabel":"Rate limit · object"},{"type":"object","title":"Cache","description":"The rule's action and conditions. The keys depend on the ruleset type and match the `settings` accepted when creating or updating a rule.","required":["cache","edge_ttl_mode","browser_ttl_mode","respect_strong_etags","serve_stale","origin_error_page_passthru","action","criteria_groups"],"example":{"action":"set_cache_settings","cache":true,"edge_ttl_mode":"override_origin","edge_ttl":3600,"browser_ttl_mode":"respect_origin","respect_strong_etags":false,"serve_stale":true,"origin_error_page_passthru":false,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/pricing"}]}]},"properties":{"action":{"type":"string","description":"Cache rules always set cache settings.\n\n- `set_cache_settings`: Set cache settings","enum":["set_cache_settings"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.action","typeLabel":"enum\u003cstring>"},"cache":{"type":"boolean","description":"Whether matching responses are eligible for caching. False bypasses the cache.","isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.cache","typeLabel":"boolean"},"edge_ttl_mode":{"type":"string","description":"How long responses stay cached at the edge.\n\n- `respect_origin`: Use cache-control header or respect origin TTL\n- `bypass_by_default`: Use cache-control header or bypass\n- `override_origin`: Ignore cache-control header and use custom TTL","enum":["respect_origin","bypass_by_default","override_origin"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.edge_ttl_mode","typeLabel":"enum\u003cstring>"},"browser_ttl_mode":{"type":"string","description":"How long browsers cache responses.\n\n- `respect_origin`: Respect origin TTL\n- `bypass`: Bypass cache\n- `override_origin`: Override origin and use custom TTL","enum":["respect_origin","bypass","override_origin"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.browser_ttl_mode","typeLabel":"enum\u003cstring>"},"respect_strong_etags":{"type":"boolean","description":"Keep strong ETags from the origin instead of converting them to weak ones.","isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.respect_strong_etags","typeLabel":"boolean"},"serve_stale":{"type":"boolean","description":"Serve stale content while a cached response is being revalidated.","isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.serve_stale","typeLabel":"boolean"},"origin_error_page_passthru":{"type":"boolean","description":"Pass 5xx error pages from the origin through instead of serving the edge error page.","isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.origin_error_page_passthru","typeLabel":"boolean"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `file_extension` | File extension | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["cookie","cookie_value","file_extension","header","hostname","referer","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","x_forwarded_for"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `equals`: equals\n- `not_equals`: not equals\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `exists`: exists\n- `not_exists`: not exists\n- `in`: in\n- `not_in`: not in\n- `none`: none","enum":["wildcard","strict_wildcard","equals","not_equals","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","exists","not_exists","in","not_in","none"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1.criteria_groups","typeLabel":"object[]"},"edge_ttl":{"oneOf":[{"type":"integer","description":"Seconds to cache responses at the edge. Required when `edge_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"data.attributes.settings.oneOf.1.edge_ttl.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds to cache responses at the edge. Required when `edge_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"data.attributes.settings.oneOf.1.edge_ttl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.settings.oneOf.1.edge_ttl","typeLabel":"integer | null"},"browser_ttl":{"oneOf":[{"type":"integer","description":"Seconds browsers cache responses. Required when `browser_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"data.attributes.settings.oneOf.1.browser_ttl.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds browsers cache responses. Required when `browser_ttl_mode` is `override_origin`.","minimum":1,"uniqueKey":"data.attributes.settings.oneOf.1.browser_ttl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.settings.oneOf.1.browser_ttl","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.1","typeLabel":"Cache · object"},{"type":"object","title":"Firewall","description":"The rule's action and conditions. The keys depend on the ruleset type and match the `settings` accepted when creating or updating a rule.","required":["action","criteria_groups"],"example":{"action":"block","criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/wp-login.php"}]},{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/xmlrpc.php"}]}]},"properties":{"action":{"type":"string","description":"What to do with matching requests.\n\n- `block`: Block\n- `managed_challenge`: Managed challenge\n- `challenge`: Challenge\n- `js_challenge`: JS challenge\n- `log`: Log\n- `skip`: Skip","enum":["block","managed_challenge","challenge","js_challenge","log","skip"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.action","typeLabel":"enum\u003cstring>"},"criteria_groups":{"type":"array","description":"The conditions a request must match. A request matches when every condition in at least one group matches, so groups `[A, B]` and `[C]` match when A and B match, or when C matches. A rule takes up to 20 conditions, and each group after the first counts as one more.","items":{"type":"object","properties":{"criterias":{"type":"array","description":"The conditions of the group, which must all match.","items":{"type":"object","properties":{"criteria":{"type":"string","description":"The kind of condition. Each field and operator pair accepts one kind, listed as `criteria_identifier` by the Get a ruleset endpoint.\n\n- `value`: Compares the field with one value.\n- `array`: Compares the field with a list of values.\n- `boolean`: Checks a field that is true or false.\n- `key_value`: Compares one entry of a field that takes a `key`, such as a header, with one value.\n- `key_array`: Compares one entry of a field that takes a `key`, such as a header, with a list of values.","enum":["value","array","boolean","key_value","key_array"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].criteria","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"The request field to match.\n\n| Field | Matches | Operators |\n|---|---|---|\n| `as_num` | AS num | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `authentication_detected` | Authentication | `none` |\n| `body` | Body | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `body_size` | Body size | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `bot_detection_ids` | Bot detection IDs | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `bot_score` | Bot score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `client_certificate_verified` | Client certificate | `none` |\n| `continent` | Continent | `equals`, `not_equals`, `in`, `not_in` |\n| `cookie` | Cookie | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `cookie_value` | Cookie value of | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `country` | Country | `equals`, `not_equals`, `in`, `not_in` |\n| `environment` | Cloud environment | `equals`, `not_equals`, `in`, `not_in` |\n| `header` | Header | `exists`, `not_exists`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `hostname` | Hostname | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `http_version` | HTTP version | `equals`, `not_equals`, `in`, `not_in`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `ip_source_address` | IP source address | `equals`, `not_equals`, `in`, `not_in` |\n| `ja4_fingerprint` | JA4 fingerprint | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `json_string` | JSON string | `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `known_bots` | Bots | `none` |\n| `mime_type` | MIME type | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `password_leaked` | Password leak | `none` |\n| `referer` | Referer | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `request_method` | Request method | `equals`, `not_equals`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `serves_static_resource` | Static resource | `none` |\n| `similar_password_leaked` | Similar password leak | `none` |\n| `ssl_https` | SSL/HTTPS | `none` |\n| `uri` | URI | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_full` | URI full | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `uri_path` | URI path | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with`, `in`, `not_in` |\n| `uri_query_string` | URI query string | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `user_agent` | User agent | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |\n| `username_and_password_leaked` | Username and password leak | `none` |\n| `username_leaked` | Username | `none` |\n| `verified_bot` | Bot verification | `none` |\n| `verified_bot_category` | Verified bot category | `in`, `not_in`, `equals`, `not_equals` |\n| `waf_attack_score` | WAF attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_rce_attack_score` | WAF RCE attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_sqli_attack_score` | WAF SQLi attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `waf_xss_attack_score` | WAF XSS attack score | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal`, `in`, `not_in` |\n| `x_forwarded_for` | X-Forwarded-For | `wildcard`, `strict_wildcard`, `equals`, `not_equals`, `contains`, `not_contains`, `matches`, `not_matches`, `start_with`, `not_start_with`, `end_with`, `not_end_with` |","enum":["as_num","authentication_detected","body","body_size","bot_detection_ids","bot_score","client_certificate_verified","continent","cookie","cookie_value","country","environment","header","hostname","http_version","ip_source_address","ja4_fingerprint","json_string","known_bots","mime_type","password_leaked","referer","request_method","serves_static_resource","similar_password_leaked","ssl_https","uri","uri_full","uri_path","uri_query_string","user_agent","username_and_password_leaked","username_leaked","verified_bot","verified_bot_category","waf_attack_score","waf_rce_attack_score","waf_sqli_attack_score","waf_xss_attack_score","x_forwarded_for"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","description":"How to compare the field.\n\n- `equals`: equals\n- `not_equals`: not equals\n- `greater_than`: greater than\n- `less_than`: less than\n- `greater_than_or_equal`: greater than or equal\n- `less_than_or_equal`: less than or equal\n- `in`: in\n- `not_in`: not in\n- `none`: none\n- `contains`: contains\n- `not_contains`: not contains\n- `matches`: matches\n- `not_matches`: not matches\n- `start_with`: start with\n- `not_start_with`: not start with\n- `end_with`: end with\n- `not_end_with`: not end with\n- `wildcard`: wildcard\n- `strict_wildcard`: strict wildcard\n- `exists`: exists\n- `not_exists`: not exists","enum":["equals","not_equals","greater_than","less_than","greater_than_or_equal","less_than_or_equal","in","not_in","none","contains","not_contains","matches","not_matches","start_with","not_start_with","end_with","not_end_with","wildcard","strict_wildcard","exists","not_exists"],"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"The entry to match for `key_value` and `key_array` conditions, such as a header name. Header names must be lowercase.","uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].key","typeLabel":"string"},"value":{"description":"The value to compare with: a string, number or boolean, or a list for `array` and `key_array` conditions. Fields with options, such as `environment`, only accept the values listed by the Get a ruleset endpoint.","uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX].value","typeLabel":"any"}},"required":["criteria","field","operator"],"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX].criterias","typeLabel":"object[]"}},"required":["criterias"],"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2.criteria_groups","typeLabel":"object[]"},"skip_parameters":{"type":"object","description":"What a `skip` rule skips. Required when `action` is `skip`.","properties":{"skip_current_ruleset":{"type":"boolean","description":"Skip the remaining rules in this ruleset.","uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters.skip_current_ruleset","typeLabel":"boolean"},"phases":{"type":"array","items":{"type":"string","description":"Rules to skip.\n\n- `http_ratelimit`: All rate limiting rules\n- `http_request_firewall_managed`: All managed rules\n- `http_request_sbfm`: All Super Bot Fight Mode rules","enum":["http_ratelimit","http_request_firewall_managed","http_request_sbfm"],"uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters.phases.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters.phases","typeLabel":"enum\u003cstring>[]"},"products":{"type":"array","items":{"type":"string","description":"Security features to skip.\n\n- `zoneLockdown`: Zone Lockdown\n- `uaBlock`: User Agent Blocking\n- `bic`: Browser Integrity Check\n- `hot`: Hotlink Protection\n- `securityLevel`: Security Level\n- `rateLimit`: Rate limiting rules (previous version)\n- `waf`: Managed rules (previous version)","enum":["zoneLockdown","uaBlock","bic","hot","securityLevel","rateLimit","waf"],"uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters.products.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters.products","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"data.attributes.settings.oneOf.2.skip_parameters","typeLabel":"object"},"block_parameters":{"type":"object","description":"The response sent to blocked requests. Only used when `action` is `block`. Without it, the default block page is sent.","properties":{"response_type":{"type":"string","description":"The response to send.\n\n- `default`: Default block page\n- `html`: Custom HTML\n- `text`: Custom text\n- `json`: Custom JSON\n- `xml`: Custom XML","enum":["default","html","text","json","xml"],"default":"default","uniqueKey":"data.attributes.settings.oneOf.2.block_parameters.response_type","typeLabel":"enum\u003cstring>"},"status_code":{"type":"integer","description":"The status code of a custom response.","default":403,"minimum":400,"maximum":499,"uniqueKey":"data.attributes.settings.oneOf.2.block_parameters.status_code","typeLabel":"integer"},"content":{"type":"string","description":"The body of a custom response. Required when `response_type` is not `default`.","maxLength":10240,"uniqueKey":"data.attributes.settings.oneOf.2.block_parameters.content","typeLabel":"string"}},"uniqueKey":"data.attributes.settings.oneOf.2.block_parameters","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.attributes.settings.oneOf.2","typeLabel":"Firewall · object"}],"isRequired":true,"uniqueKey":"data.attributes.settings","typeLabel":"Rate limit · object | Cache · object | Firewall · object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","name","description","is_active","settings","created_at","updated_at"],"uniqueKey":"data.attributes","typeLabel":"object"}},"required":["id","type"],"title":"EdgeNetworkRuleResource","isRequired":true,"uniqueKey":"data","typeLabel":"EdgeNetworkRuleResource · object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","type":"edge_network_rules","attributes":{"type":"firewall","name":"\u003cstring>","description":"\u003cstring>","is_active":true,"settings":{"requests_per_period":10,"period":60,"action":"managed_challenge","throttles":false,"action_duration":600,"criteria_groups":[{"criterias":[{"criteria":"value","field":"uri_path","operator":"equals","value":"/login"},{"criteria":"value","field":"request_method","operator":"equals","value":"POST"}]}]},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"747f889e-e0d1-4c9f-8da3-bb0db8d56cce":{"description":"Authorization error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d6dbe952-004b-4847-9d8d-7bb7ef8416f2":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"deccceef-b9bf-4601-835a-9e2c1829e49d":{"description":"Another change to the ruleset is in progress. Try again once it finishes.","content":{"application/json":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"81ec5574-1b31-4756-aa46-71df40959069":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"687d8bfb-68b4-409d-8c69-eabb0584a8b9":{"http":{"type":"http","description":"The Bearer Token generated on the Cloud UI.","scheme":"bearer","bearerFormat":"bearer","scopes":[],"schemeName":"http"}}},"servers":{"ab272a5d-11d2-46d9-8dc6-6bc8e813c6f1":{"url":"https://cloud.laravel.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"The Bearer Token generated on the Cloud UI.","scheme":"bearer","bearerFormat":"bearer","scopes":[],"schemeName":"http"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Bearer Token generated on the Cloud UI.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"http","name":"Authorization"}],"title":"http"}]},"originalFileLocation":"https://cloud.laravel.com/api-docs/api.json"},"subdomain":"cloud","siteName":"Laravel Cloud","title":"Create a rule - Laravel Cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T10:08:36.260Z","originalFileLocation":"api/edge-networks/create-a-rule.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add a rule to a ruleset. The rule is added last unless a position is given.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Laravel Cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a rule - Laravel Cloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add a rule to a ruleset. The rule is added last unless a position is given.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Laravel Cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"/cloud/docs/api/edge-networks/create-a-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloud.mintlify.site/docs/_mintlify/api/og/v2?division=Edge+Networks\u0026amp;title=Create+a+rule\u0026amp;description=Add+a+rule+to+a+ruleset.+The+rule+is+added+last+unless+a+%60position%60+is+given.\u0026amp;theme=546869994471480339332f3d\u0026amp;signature=16e6aaf9c1d3c07ab3d49736db8947968d957cd62afd1add14d0cb5ff1cd655b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a rule - Laravel Cloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add a rule to a ruleset. The rule is added last unless a position is given.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud.mintlify.site/docs/_mintlify/api/og/v2?division=Edge+Networks\u0026amp;title=Create+a+rule\u0026amp;description=Add+a+rule+to+a+ruleset.+The+rule+is+added+last+unless+a+%60position%60+is+given.\u0026amp;theme=546869994471480339332f3d\u0026amp;signature=16e6aaf9c1d3c07ab3d49736db8947968d957cd62afd1add14d0cb5ff1cd655b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Laravel Cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0057FF\">\u003clink data-mint-head rel=\"canonical\" href=\"/cloud/docs/api/edge-networks/create-a-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/cloud/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cloud/docs/api/edge-networks/create-a-rule.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://cloud.laravel.com/#organization\",\"name\":\"Laravel Cloud\",\"url\":\"https://cloud.laravel.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-light.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=f508d8e9c4e3c842e83d055cc376daa1\"}},{\"@type\":\"WebSite\",\"@id\":\"/cloud/docs#website\",\"name\":\"Laravel Cloud\",\"url\":\"/cloud/docs\",\"publisher\":{\"@id\":\"https://cloud.laravel.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"/cloud/docs/api/edge-networks/create-a-rule#webpage\",\"url\":\"/cloud/docs/api/edge-networks/create-a-rule\",\"name\":\"Create a rule\",\"description\":\"Add a rule to a ruleset. The rule is added last unless a position is given.\",\"dateModified\":\"2026-11-19T10:08:36.260Z\",\"isPartOf\":{\"@id\":\"/cloud/docs#website\"},\"breadcrumb\":{\"@id\":\"/cloud/docs/api/edge-networks/create-a-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"/cloud/docs/api/edge-networks/create-a-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"/cloud/docs/api/applications/list-applications\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Edge Networks\",\"item\":\"/cloud/docs/api/edge-networks/list-edge-networks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a rule\",\"item\":\"/cloud/docs/api/edge-networks/create-a-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"/cloud/docs/api/edge-networks/create-a-rule#apireference\",\"headline\":\"Create a rule\",\"name\":\"Create a rule\",\"description\":\"Add a rule to a ruleset. The rule is added last unless a position is given.\",\"url\":\"/cloud/docs/api/edge-networks/create-a-rule\",\"mainEntityOfPage\":{\"@id\":\"/cloud/docs/api/edge-networks/create-a-rule#webpage\"},\"dateModified\":\"2026-11-19T10:08:36.260Z\",\"publisher\":{\"@id\":\"https://cloud.laravel.com/#organization\"},\"isPartOf\":{\"@id\":\"/cloud/docs#website\"}}]}\u003c/script>","agentPointerHref":"/cloud/docs/api/edge-networks/create-a-rule.md","siteName":"Laravel Cloud","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/intro"}]},{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":"/knowledge-base/intro"}]},{"tab":"API","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"Laravel Cloud API","sidebarTitle":"Introduction","href":"/api/introduction"},{"title":"API authentication for Laravel Cloud","sidebarTitle":"Authentication","href":"/api/authentication"}]},{"group":"CLI","pages":[{"title":"Laravel Cloud CLI","sidebarTitle":"Laravel Cloud CLI","href":"/api/cli"},{"title":"Stripe Projects","sidebarTitle":"Stripe Projects CLI","href":"/api/stripe-projects"}]},{"group":"Endpoints","boost":0.5,"pages":[{"group":"Applications","pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications","href":"/api/applications/list-applications"},{"title":"Create application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications","href":"/api/applications/create-application"},{"title":"Get application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications/{application}","href":"/api/applications/get-application"},{"title":"Delete application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /applications/{application}","href":"/api/applications/delete-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /applications/{application}","href":"/api/applications/update-application"},{"title":"Upload application avatar","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications/{application}/avatar","href":"/api/applications/upload-application-avatar"},{"title":"Delete application avatar","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /applications/{application}/avatar","href":"/api/applications/delete-application-avatar"}]},{"group":"Background Processes","pages":[{"title":"List background processes","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/background-processes","href":"/api/background-processes/list-background-processes"},{"title":"Create background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/background-processes","href":"/api/background-processes/create-background-process"},{"title":"Get background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /background-processes/{backgroundProcess}","href":"/api/background-processes/get-background-process"},{"title":"Delete background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /background-processes/{backgroundProcess}","href":"/api/background-processes/delete-background-process"},{"title":"Update background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /background-processes/{backgroundProcess}","href":"/api/background-processes/update-background-process"}]},{"group":"Bucket Keys","pages":[{"title":"List object storage keys","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets/{filesystem}/keys","href":"/api/bucket-keys/list-object-storage-keys"},{"title":"Create object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /buckets/{filesystem}/keys","href":"/api/bucket-keys/create-object-storage-key"},{"title":"Get object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/get-object-storage-key"},{"title":"Delete object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/delete-object-storage-key"},{"title":"Update object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/update-object-storage-key"}]},{"group":"Caches","pages":[{"title":"List all available cache types with their configuration options","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/types","href":"/api/caches/list-all-available-cache-types-with-their-configuration-options"},{"title":"List caches","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches","href":"/api/caches/list-caches"},{"title":"Create cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /caches","href":"/api/caches/create-cache"},{"title":"Get cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/{cache}","href":"/api/caches/get-cache"},{"title":"Delete cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /caches/{cache}","href":"/api/caches/delete-cache"},{"title":"Update cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /caches/{cache}","href":"/api/caches/update-cache"},{"title":"Get cache metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/{cache}/metrics","href":"/api/caches/get-cache-metrics"}]},{"group":"Commands","pages":[{"title":"List commands","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/commands","href":"/api/commands/list-commands"},{"title":"Run command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/commands","href":"/api/commands/run-command"},{"title":"Get command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /commands/{command}","href":"/api/commands/get-command"}]},{"group":"Database Clusters","pages":[{"title":"List database types","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/types","href":"/api/database-clusters/list-database-types"},{"title":"List database presets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/presets","href":"/api/database-clusters/list-database-presets"},{"title":"List database clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters","href":"/api/database-clusters/list-database-clusters"},{"title":"Create database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters","href":"/api/database-clusters/create-database-cluster"},{"title":"Get database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}","href":"/api/database-clusters/get-database-cluster"},{"title":"Delete database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}","href":"/api/database-clusters/delete-database-cluster"},{"title":"Update database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/clusters/{database}","href":"/api/database-clusters/update-database-cluster"},{"title":"Get database cluster metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/metrics","href":"/api/database-clusters/get-database-cluster-metrics"}]},{"group":"Database Restores","pages":[{"title":"Create a database restore","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/restore","href":"/api/database-restores/create-a-database-restore"}]},{"group":"Database Snapshots","pages":[{"title":"List database snapshots","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/snapshots","href":"/api/database-snapshots/list-database-snapshots"},{"title":"Create a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/snapshots","href":"/api/database-snapshots/create-a-database-snapshot"},{"title":"Get a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /database-snapshots/{databaseSnapshot}","href":"/api/database-snapshots/get-a-database-snapshot"},{"title":"Delete a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /database-snapshots/{databaseSnapshot}","href":"/api/database-snapshots/delete-a-database-snapshot"}]},{"group":"Database Users","pages":[{"title":"List database users","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/users","href":"/api/database-users/list-database-users"},{"title":"Create a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/users","href":"/api/database-users/create-a-database-user"},{"title":"Get a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/get-a-database-user"},{"title":"Delete a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/delete-a-database-user"},{"title":"Update a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/update-a-database-user"}]},{"group":"Databases","pages":[{"title":"List databases","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/databases","href":"/api/databases/list-databases"},{"title":"Create a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/databases","href":"/api/databases/create-a-database"},{"title":"Get a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/databases/{schema}","href":"/api/databases/get-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}/databases/{schema}","href":"/api/databases/delete-a-database"}]},{"group":"Databases (Legacy)","pages":[{"title":"List databases","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases","href":"/api/databases-legacy/list-databases"},{"title":"Create database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases","href":"/api/databases-legacy/create-database"},{"title":"Get database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/{database}","href":"/api/databases-legacy/get-database"},{"title":"Delete database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/{database}","href":"/api/databases-legacy/delete-database"},{"title":"Update database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/{database}","href":"/api/databases-legacy/update-database"}]},{"group":"Dedicated Clusters","pages":[{"title":"List dedicated clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /dedicated-clusters","href":"/api/dedicated-clusters/list-dedicated-clusters"}]},{"group":"Deployments","pages":[{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/deployments","href":"/api/deployments/list-deployments"},{"title":"Initiate deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/deployments","href":"/api/deployments/initiate-deployment"},{"title":"List queued deployments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/queued-deployments","href":"/api/deployments/list-queued-deployments"},{"title":"Get deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /deployments/{deployment}","href":"/api/deployments/get-deployment"},{"title":"Get deployment logs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /deployments/{deployment}/logs","href":"/api/deployments/get-deployment-logs"},{"title":"Get queued deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /queued-deployments/{queuedDeployment}","href":"/api/deployments/get-queued-deployment"}]},{"group":"Domains","pages":[{"title":"List domains","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/domains","href":"/api/domains/list-domains"},{"title":"Create domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/domains","href":"/api/domains/create-domain"},{"title":"Get domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /domains/{domain}","href":"/api/domains/get-domain"},{"title":"Delete domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /domains/{domain}","href":"/api/domains/delete-domain"},{"title":"Update domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /domains/{domain}","href":"/api/domains/update-domain"},{"title":"Verify a domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /domains/{domain}/verify","href":"/api/domains/verify-a-domain"}]},{"group":"Edge Networks","pages":[{"title":"List edge networks","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks","href":"/api/edge-networks/list-edge-networks"},{"title":"List rulesets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets","href":"/api/edge-networks/list-rulesets"},{"title":"Get a ruleset","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}","href":"/api/edge-networks/get-a-ruleset"},{"title":"List rules","description":"Get the rules of a ruleset, in the order they are evaluated. To move a rule, update it with a `position`.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/list-rules"},{"title":"Create a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/create-a-rule"},{"title":"Get a rule","description":null,"deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/get-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/delete-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/update-a-rule"}]},{"group":"Email","pages":[{"title":"Attach Resend to environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/resend","href":"/api/email/attach-resend-to-environment"},{"title":"Detach Resend from environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/resend","href":"/api/email/detach-resend-from-environment"},{"title":"Update environment Resend sender","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}/resend","href":"/api/email/update-environment-resend-sender"},{"title":"List reusable sending keys","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/resend/keys","href":"/api/email/list-reusable-sending-keys"},{"title":"List sending domains","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /resend/domains","href":"/api/email/list-sending-domains"}]},{"group":"Environments","pages":[{"title":"List environments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications/{application}/environments","href":"/api/environments/list-environments"},{"title":"Create environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications/{application}/environments","href":"/api/environments/create-environment"},{"title":"List environment logs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/logs","href":"/api/environments/list-environment-logs"},{"title":"Get environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}","href":"/api/environments/get-environment"},{"title":"Delete environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}","href":"/api/environments/delete-environment"},{"title":"Update environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}","href":"/api/environments/update-environment"},{"title":"Start environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/start","href":"/api/environments/start-environment"},{"title":"Stop environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/stop","href":"/api/environments/stop-environment"},{"title":"Purge edge cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/purge-edge-cache","href":"/api/environments/purge-edge-cache"},{"title":"Update vanity domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json put /environments/{environment}/vanity-domain","href":"/api/environments/update-vanity-domain"},{"title":"Add environment variables","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/variables","href":"/api/environments/add-environment-variables"},{"title":"Delete environment variables","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/variables/delete","href":"/api/environments/delete-environment-variables"},{"title":"Get environment metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/metrics","href":"/api/environments/get-environment-metrics"},{"title":"Attach secrets to environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/secrets","href":"/api/environments/attach-secrets-to-environment"},{"title":"Detach secret from environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/secrets/{secret}","href":"/api/environments/detach-secret-from-environment"},{"title":"Enable environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/internal-networking","href":"/api/environments/enable-environment-internal-networking"},{"title":"Disable environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/internal-networking","href":"/api/environments/disable-environment-internal-networking"},{"title":"Update environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}/internal-networking","href":"/api/environments/update-environment-internal-networking"}]},{"group":"Instances","pages":[{"title":"List instances","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/instances","href":"/api/instances/list-instances"},{"title":"Create instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/instances","href":"/api/instances/create-instance"},{"title":"List instance sizes","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/sizes","href":"/api/instances/list-instance-sizes"},{"title":"Get instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}","href":"/api/instances/get-instance"},{"title":"Delete instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}","href":"/api/instances/delete-instance"},{"title":"Update instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /instances/{instance}","href":"/api/instances/update-instance"},{"title":"Pause a managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/pause","href":"/api/instances/pause-a-managed-queue"},{"title":"Resume a managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/resume","href":"/api/instances/resume-a-managed-queue"},{"title":"Purge a managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/purge","href":"/api/instances/purge-a-managed-queue"},{"title":"Set the default managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/default","href":"/api/instances/set-the-default-managed-queue"},{"title":"List managed queue failed jobs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/failed-jobs","href":"/api/instances/list-managed-queue-failed-jobs"},{"title":"Delete managed queue failed jobs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}/failed-jobs","href":"/api/instances/delete-managed-queue-failed-jobs"},{"title":"Retry a managed queue failed job","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/failed-jobs/{jobId}/retry","href":"/api/instances/retry-a-managed-queue-failed-job"},{"title":"Delete a managed queue failed job","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}/failed-jobs/{jobId}","href":"/api/instances/delete-a-managed-queue-failed-job"}]},{"group":"Meta","pages":[{"title":"Submit agent feedback","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /feedback","href":"/api/meta/submit-agent-feedback"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /meta/organization","href":"/api/meta/get-organization"},{"title":"List regions","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /meta/regions","href":"/api/meta/list-regions"}]},{"group":"Object Storage Buckets","pages":[{"title":"List object storage buckets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets","href":"/api/object-storage-buckets/list-object-storage-buckets"},{"title":"Create object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /buckets","href":"/api/object-storage-buckets/create-object-storage-bucket"},{"title":"Get object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets/{filesystem}","href":"/api/object-storage-buckets/get-object-storage-bucket"},{"title":"Delete object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /buckets/{filesystem}","href":"/api/object-storage-buckets/delete-object-storage-bucket"},{"title":"Update object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /buckets/{filesystem}","href":"/api/object-storage-buckets/update-object-storage-bucket"}]},{"group":"Scheduled Commands","pages":[{"title":"List scheduled commands","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/scheduled-commands","href":"/api/scheduled-commands/list-scheduled-commands"},{"title":"Create scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/scheduled-commands","href":"/api/scheduled-commands/create-scheduled-command"},{"title":"Get scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/get-scheduled-command"},{"title":"Delete scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/delete-scheduled-command"},{"title":"Update scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/update-scheduled-command"}]},{"group":"Secrets","pages":[{"title":"Get secrets public key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /secrets/public-key","href":"/api/secrets/get-secrets-public-key"},{"title":"List secrets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /secrets","href":"/api/secrets/list-secrets"},{"title":"Create secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /secrets","href":"/api/secrets/create-secret"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /secrets/{secret}","href":"/api/secrets/delete-secret"},{"title":"Update secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /secrets/{secret}","href":"/api/secrets/update-secret"}]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /usage","href":"/api/usage/get-usage"}]},{"group":"WebSocket Applications","pages":[{"title":"List WebSocket applications","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}/applications","href":"/api/websocket-applications/list-websocket-applications"},{"title":"Create WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /websocket-servers/{websocketServer}/applications","href":"/api/websocket-applications/create-websocket-application"},{"title":"Get WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/get-websocket-application"},{"title":"Delete WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/delete-websocket-application"},{"title":"Update WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/update-websocket-application"},{"title":"Get WebSocket application metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-applications/{websocketApplication}/metrics","href":"/api/websocket-applications/get-websocket-application-metrics"}]},{"group":"WebSocket Clusters","pages":[{"title":"List WebSocket cluster types","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/types","href":"/api/websocket-clusters/list-websocket-cluster-types"},{"title":"List WebSocket clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers","href":"/api/websocket-clusters/list-websocket-clusters"},{"title":"Create WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /websocket-servers","href":"/api/websocket-clusters/create-websocket-cluster"},{"title":"Get WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/get-websocket-cluster"},{"title":"Delete WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/delete-websocket-cluster"},{"title":"Update WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/update-websocket-cluster"},{"title":"Get WebSocket cluster metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}/metrics","href":"/api/websocket-clusters/get-websocket-cluster-metrics"}]}]}]}]},"basePath":"","title":"Create a rule - Laravel Cloud","deploymentId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","buildId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-c3oKHz6v.js","dist-CLdzWocy.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DyP0AOE1.js","snippetPresets-CuYPAUIG.js","utils-ez5j6NBT.js","style-to-object-BY3JEAdk.js","utils-DG4aeUOF.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DFhcMUrP.js","conditional-requirements-CFM0id0Q.js","cloneDeep-ByDTqllG.js","_Uint8Array-CJ2WjX_H.js","isObject-FP1Yky1u.js","ApiExamples-fyn9sMD9.js","usePlaygroundInputsStore-Bf0N_Y6L.js","shallow-CnU26VTn.js","isEqual-OWIKZzop.js","CodeSnippets-CZ9-M31v.js","CodeSnippet-CCk6UVRR.js","getApiPlaygroundDisplay-BUw5JwZB.js","Page-CInwEL5w.js","DynamicMarkdown-CU5QIokU.js","SectionHeading-BoT1NwPU.js","icon-MsvNhD56.js","MethodPill-CC7p0-fp.js","getPastedJson-BOWYR2ND.js","DuplicateIcon-DOWJyC1b.js","createIcon-BsNyCaLY.js","axios-CsQoIw0U.js","Markdown-L0uigQE0.js","AssistantPageLink-Cur5OU4v.js"]}